diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 24d047bb52..382dfa00dd 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -1,66 +1,66 @@ { - "docsets_to_publish": [ - { - "build_entry_point": "docs", - "build_output_subfolder": "windows-powershell", - "build_source_folder": "docset", - "customized_tasks": { - "docset_prebuild": [ - "_dependentPackages/MAML2Yaml/tools/Run.ps1" - ] - }, - "docset_name": "windows-powershell", - "locale": "en-us", - "monikerPath": [ - "mapping/monikerMapping.json" - ], - "cabgenConfigPath": [ - "mapping/cabgenConfig.json" - ], - "moniker_ranges": [], - "monikers": [], - "open_to_public_contributors": true, - "template_folder": "_themes", - "type_mapping": { - "PowershellModule": "Content", - "PowershellCmdlet": "Content", - "Conceptual": "Content" - }, - "xref_query_tags": [ - "/dotnet" - ], - "version": 0 - } - ], - "notification_subscribers": [], - "sync_notification_subscribers": [], - "branches_to_filter": [], - "git_repository_url_open_to_public_contributors": "https://github.com/MicrosoftDocs/windows-powershell-docs", - "git_repository_branch_open_to_public_contributors": "main", - "skip_source_output_uploading": false, - "need_preview_pull_request": true, - "contribution_branch_mappings": {}, - "dependent_repositories": [ - { - "path_to_root": "_themes", - "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "main", - "branch_mapping": {} - } - ], - "branch_target_mapping": {}, - "dependent_packages": [ - { - "id": "Microsoft.DocAsCode.MAML2Yaml", - "nuget_feed": "https://www.myget.org/F/op/api/v2", - "path_to_root": "_dependentPackages/MAML2Yaml", - "target_framework": "net45", - "version": "latest" - } - ], - "need_generate_pdf_url_template": false, - "targets": {}, - "docs_build_engine": { - "name": "docfx_v3" - } + "branch_target_mapping": {}, + "branches_to_filter": [], + "contribution_branch_mappings": {}, + "dependent_packages": [ + { + "id": "Microsoft.DocAsCode.MAML2Yaml", + "nuget_feed": "https://www.myget.org/F/op/api/v2", + "path_to_root": "_dependentPackages/MAML2Yaml", + "target_framework": "net45", + "version": "latest" + } + ], + "dependent_repositories": [ + { + "branch": "main", + "branch_mapping": {}, + "path_to_root": "_themes", + "url": "https://github.com/Microsoft/templates.docs.msft" + } + ], + "docs_build_engine": { + "name": "docfx_v3" + }, + "docsets_to_publish": [ + { + "build_entry_point": "docs", + "build_output_subfolder": "windows-powershell", + "build_source_folder": "docset", + "cabgenConfigPath": [ + "mapping/cabgenConfig.json" + ], + "customized_tasks": { + "docset_prebuild": [ + "_dependentPackages/MAML2Yaml/tools/Run.ps1" + ] + }, + "docset_name": "windows-powershell", + "locale": "en-us", + "monikerPath": [ + "mapping/monikerMapping.json" + ], + "moniker_ranges": [], + "monikers": [], + "open_to_public_contributors": true, + "template_folder": "_themes", + "type_mapping": { + "Conceptual": "Content", + "PowershellCmdlet": "Content", + "PowershellModule": "Content" + }, + "version": 0, + "xref_query_tags": [ + "/dotnet" + ] + } + ], + "git_repository_branch_open_to_public_contributors": "main", + "git_repository_url_open_to_public_contributors": "https://github.com/MicrosoftDocs/windows-powershell-docs", + "need_generate_pdf_url_template": false, + "need_preview_pull_request": true, + "notification_subscribers": [], + "skip_source_output_uploading": false, + "sync_notification_subscribers": [], + "targets": {} } \ No newline at end of file diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json index da6ef5036b..32936cd95d 100644 --- a/.openpublishing.redirection.json +++ b/.openpublishing.redirection.json @@ -1,5424 +1,3624 @@ { - "redirections": [ - { - "source_path": "winserver2012-ps/netconnectionprofile/Get-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnection/Get-NetConnectionProfile?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "winserver2012-ps/netconnectionprofile/NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnection/NetConnection?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "winserver2012-ps/netconnectionprofile/Set-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnection/Set-NetConnectionProfile?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "winserver2012r2-ps/netconnectionprofile/Get-NetConnectionProfile.md", - "redirect_url": "winserver2012r2-ps/netconnection/Get-NetConnectionProfile?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "winserver2012r2-ps/netconnectionprofile/NetConnectionProfile.md", - "redirect_url": "winserver2012r2-ps/netconnection/NetConnection?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "winserver2012r2-ps/netconnectionprofile/Set-NetConnectionProfile.md", - "redirect_url": "winserver2012r2-ps/netconnection/Set-NetConnectionProfile?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "winserver2016-ps/netconnectionprofile/Get-NetConnectionProfile.md", - "redirect_url": "winserver2016-ps/netconnection/Get-NetConnectionProfile?view=WindowsServer2016-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2016-ps/netconnectionprofile/NetConnectionProfile.md", - "redirect_url": "winserver2016-ps/netconnection/NetConnection?view=WindowsServer2016-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2016-ps/netconnectionprofile/Set-NetConnectionProfile.md", - "redirect_url": "winserver2016-ps/netconnection/Set-NetConnectionProfile?view=WindowsServer2016-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2019-ps/netconnectionprofile/Get-NetConnectionProfile.md", - "redirect_url": "winserver2019-ps/netconnection/Get-NetConnectionProfile?view=WindowsServer2019-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2019-ps/netconnectionprofile/NetConnectionProfile.md", - "redirect_url": "winserver2019-ps/netconnection/NetConnection?view=WindowsServer2019-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2019-ps/netconnectionprofile/Set-NetConnectionProfile.md", - "redirect_url": "winserver2019-ps/netconnection/Set-NetConnectionProfile?view=WindowsServer2019-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2022-ps/netconnectionprofile/Get-NetConnectionProfile.md", - "redirect_url": "winserver2022-ps/netconnection/Get-NetConnectionProfile?view=WindowsServer2022-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2022-ps/netconnectionprofile/NetConnectionProfile.md", - "redirect_url": "winserver2022-ps/netconnection/NetConnection?view=WindowsServer2022-ps", - "redirect_document_id": true - }, - { - "source_path": "winserver2022-ps/netconnectionprofile/Set-NetConnectionProfile.md", - "redirect_url": "winserver2022-ps/netconnection/Set-NetConnectionProfile?view=WindowsServer2022-ps", - "redirect_document_id": true - }, - { - "source_path": "docset/docs-conceptual/windows/index.md", - "redirect_url": "/powershell/windows/get-started", - "redirect_document_id": false - }, - { - "source_path": "docset/docs-conceptual/windows/overview.md", - "redirect_url": "/powershell/windows/get-started", - "redirect_document_id": false - }, - { - "source_path": "docset/docs-conceptual/mdop/index.md", - "redirect_url": "/powershell/mdop/get-started", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/adcsadministration/adcsadministration.md", - "redirect_url": "/powershell/module/adcsadministration", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/adcsdeployment/adcsdeployment.md", - "redirect_url": "/powershell/module/adcsdeployment", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/activedirectory/activedirectory.md", - "redirect_url": "/powershell/module/activedirectory", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/addsdeployment/addsdeployment.md", - "redirect_url": "/powershell/module/addsdeployment", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/adfs/adfs.md", - "redirect_url": "/powershell/module/adfs", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/adrmsadmin/adrmsadmin.md", - "redirect_url": "/powershell/module/adrmsadmin", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appbackgroundtask/appbackgroundtask.md", - "redirect_url": "/powershell/module/appbackgroundtask", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/applocker/applocker.md", - "redirect_url": "/powershell/module/applocker", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appvclient/appvclient.md", - "redirect_url": "/powershell/module/appvclient", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appvsequencer/appvsequencer.md", - "redirect_url": "/powershell/module/appvsequencer", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appx/appx.md", - "redirect_url": "/powershell/module/appx", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/assignedaccess/assignedaccess.md", - "redirect_url": "/powershell/module/assignedaccess", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/bestpractices/bestpractices.md", - "redirect_url": "/powershell/module/bestpractices", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/bitlocker/bitlocker.md", - "redirect_url": "/powershell/module/bitlocker", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/bitstransfer/bitstransfer.md", - "redirect_url": "/powershell/module/bitstransfer", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/booteventcollector/booteventcollector.md", - "redirect_url": "/powershell/module/booteventcollector", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/branchcache/branchcache.md", - "redirect_url": "/powershell/module/branchcache", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/cimcmdlets/cimcmdlets.md", - "redirect_url": "/powershell/module/cimcmdlets", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/clusterawareupdating/clusterawareupdating.md", - "redirect_url": "/powershell/module/clusterawareupdating", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/configci/configci.md", - "redirect_url": "/powershell/module/configci", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hostcomputeservice/hostcomputeservice.md", - "redirect_url": "/powershell/module/hostcomputeservice", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/dcbqos/dcbqos.md", - "redirect_url": "/powershell/module/dcbqos", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/deduplication/deduplication.md", - "redirect_url": "/powershell/module/deduplication", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/defender/defender.md", - "redirect_url": "/powershell/module/defender", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/dfsn/dfsn.md", - "redirect_url": "/powershell/module/dfsn", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/dfsr/dfsr.md", - "redirect_url": "/powershell/module/dfsr", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/devicehealthattestation/devicehealthattestation.md", - "redirect_url": "/powershell/module/devicehealthattestation", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/directaccessclientcomponent/directaccessclientcomponent.md", - "redirect_url": "/powershell/module/directaccessclientcomponent", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/dism/dism.md", - "redirect_url": "/powershell/module/dism", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/dnsclient/dnsclient/dns-client.md", - "redirect_url": "/powershell/module/dnsclient", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/dnsserver/dnsserver.md", - "redirect_url": "/powershell/module/dnsserver", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/eventtracmancmdlets/eventtracmancmdlets.md", - "redirect_url": "/powershell/module/eventtracmancmdlets", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/failoverclusters/failoverclusters.md", - "redirect_url": "/powershell/module/failoverclusters", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/fileserverresourcemanager/fileserverresourcemanager.md", - "redirect_url": "/powershell/module/fileserverresourcemanager", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/grouppolicy/grouppolicy.md", - "redirect_url": "/powershell/module/grouppolicy", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hardwarecertification/hardwarecertification.md", - "redirect_url": "/powershell/module/hardwarecertification", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hnvdiagnostics/hnvdiagnostics.md", - "redirect_url": "/powershell/module/hnvdiagnostics", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hgsattestation/hgsattestation.md", - "redirect_url": "/powershell/module/hnvdiagnostics", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hgsclient/hgsclient.md", - "redirect_url": "/powershell/module/hgsclient", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hgsdiagnostics/hgsdiagnostics.md", - "redirect_url": "/powershell/module/hgsdiagnostics", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hgskeyprotection/hgskeyprotection.md", - "redirect_url": "/powershell/module/hgskeyprotection", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/hgsserver/hgsserver.md", - "redirect_url": "/powershell/module/hgsserver", - "redirect_document_id": false - }, - { - "source_path": "dvirtual-directory-module/hyper-v/hyper-v.md", - "redirect_url": "/powershell/module/hyper-v", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/iisadministration/iisadministration.md", - "redirect_url": "/powershell/module/iisadministration", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/international/international.md", - "redirect_url": "/powershell/module/international", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/ipamserver/ipamserver.md", - "redirect_url": "/powershell/module/ipamserver", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/iscsi/iscsi.md", - "redirect_url": "/powershell/module/iscsi", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/iscsitarget/iscsitarget.md", - "redirect_url": "/powershell/module/iscsitarget", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/kds/kds.md", - "redirect_url": "/powershell/module/kds", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/mmagent/mmagent.md", - "redirect_url": "/powershell/module/mmagent", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/mpio/mpio.md", - "redirect_url": "/powershell/module/mpio", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/msdtc/msdtc.md", - "redirect_url": "/powershell/module/msdtc", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/msmq/msmq.md", - "redirect_url": "/powershell/module/msmq", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/multipointvdi/multipointvdi.md", - "redirect_url": "/powershell/module/multipointvdi", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/nanoserverimagegenerator/nanoserverimagegenerator.md", - "redirect_url": "/powershell/module/nanoserverimagegenerator", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netnat/netnat.md", - "redirect_url": "/powershell/module/netnat", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netadapter/netadapter.md", - "redirect_url": "/powershell/module/netadapter", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netldpagent/netldpagent.md", - "redirect_url": "/powershell/module/netldpagent", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netconnection/netconnection.md", - "redirect_url": "/powershell/module/netconnection", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/neteventpacketcapture/neteventpacketcapture.md", - "redirect_url": "/powershell/module/neteventpacketcapture", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netsecurity/netsecurity.md", - "redirect_url": "/powershell/module/netsecurity", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/networkswitchmanager/networkswitchmanager.md", - "redirect_url": "/powershell/module/networkswitchmanager", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/networkcontrollerdiagnostics/networkcontrollerdiagnostics.md", - "redirect_url": "/powershell/module/networkcontrollerdiagnostics", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/networktransition/networktransition.md", - "redirect_url": "/powershell/module/networktransition", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netswitchteam/netswitchteam.md", - "redirect_url": "/powershell/module/netswitchteam", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netwnv/netwnv.md", - "redirect_url": "/powershell/module/netwnv", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/nfs/nfs.md", - "redirect_url": "/powershell/module/nfs", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netlbfo/netlbfo.md", - "redirect_url": "/powershell/module/netlbfo", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/networkloadbalancingclusters/networkloadbalancingclusters.md", - "redirect_url": "/powershell/module/networkloadbalancingclusters", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/nps/nps.md", - "redirect_url": "/powershell/module/nps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/pcsvdevice/pcsvdevice.md", - "redirect_url": "/powershell/module/pcsvdevice", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/pki/index.yml", - "redirect_url": "/powershell/module/pki", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/pkiclient/index.yml", - "redirect_url": "/powershell/module/pki", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/pkiclient/pkiclient.md", - "redirect_url": "/powershell/module/pki/pki", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/platformidentifier/platformidentifier.md", - "redirect_url": "/powershell/module/platformidentifier", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/pnpdevice/pnpdevice.md", - "redirect_url": "/powershell/module/pnpdevice", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/printmanagement/printmanagement.md", - "redirect_url": "/powershell/module/printmanagement", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/processmitigations/processmitigations.md", - "redirect_url": "/powershell/module/processmitigations", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/netqos/netqos.md", - "redirect_url": "/powershell/module/netqos", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/remoteaccess/remoteaccess.md", - "redirect_url": "/powershell/module/remoteaccess", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/remotedesktop/remotedesktop.md", - "redirect_url": "/powershell/module/remotedesktop", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/remotedesktopservices/remotedesktopservices.md", - "redirect_url": "/powershell/module/remotedesktopservices", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/scheduledtasks/scheduledtasks.md", - "redirect_url": "/powershell/module/scheduledtasks", - "redirect_document_id": false - }, - { - "source_path": "dvirtual-directory-module/secureboot/secureboot.md", - "redirect_url": "/powershell/module/secureboot", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/servercore/servercore.md", - "redirect_url": "/powershell/module/servercore", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/servermanager/servermanager.md", - "redirect_url": "/powershell/module/servermanager", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/servermanagertasks/servermanagertasks.md", - "redirect_url": "/powershell/module/servermanagertasks", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/shieldedvmdatafile/shieldedvmdatafile.md", - "redirect_url": "/powershell/module/shieldedvmdatafile", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/shieldedvmprovisioning/shieldedvmprovisioning.md", - "redirect_url": "/powershell/module/shieldedvmprovisioning", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/shieldedvmtemplate/shieldedvmtemplate.md", - "redirect_url": "/powershell/module/shieldedvmtemplate", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/softwareinventorylogging/softwareinventorylogging.md", - "redirect_url": "/powershell/module/softwareinventorylogging", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/smbshare/smbshare.md", - "redirect_url": "/powershell/module/smbshare", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/smbwitness/smbwitness.md", - "redirect_url": "/powershell/module/smbwitness", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/smisconfig/smisconfig.md", - "redirect_url": "/powershell/module/smisconfig", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/startlayout/startlayout.md", - "redirect_url": "/powershell/module/startlayout", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/storage/storage.md", - "redirect_url": "/powershell/module/storage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/storageqos/storageqos.md", - "redirect_url": "/powershell/module/storageqos", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/storagereplica/storagereplica.md", - "redirect_url": "/powershell/module/storagereplica", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/syncshare/syncshare.md", - "redirect_url": "/powershell/module/syncshare", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/nettcpip/nettcpip.md", - "redirect_url": "/powershell/module/nettcpip", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/tls/tls.md", - "redirect_url": "/powershell/module/tls", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/trustedplatformmodule/trustedplatformmodule.md", - "redirect_url": "/powershell/module/trustedplatformmodule", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/useraccesslogging/useraccesslogging.md", - "redirect_url": "/powershell/module/useraccesslogging", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/vamt/vamt.md", - "redirect_url": "/powershell/module/vamt", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/uev/uev.md", - "redirect_url": "/powershell/module/uev", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/troubleshootingpack/troubleshootingpack.md", - "redirect_url": "/powershell/module/troubleshootingpack", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/vpnclient/vpnclient.md", - "redirect_url": "/powershell/module/vpnclient", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/webapplicationproxy/webapplicationproxy.md", - "redirect_url": "/powershell/module/webapplicationproxy", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/windowserrorreporting/windowserrorreporting.md", - "redirect_url": "/powershell/module/windowserrorreporting", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/windowsupdate/windowsupdate.md", - "redirect_url": "/powershell/module/windowsupdate", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/webadministration/webadministration.md", - "redirect_url": "/powershell/module/webadministration", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/whea/whea.md", - "redirect_url": "/powershell/module/whea", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/windowsdevlic/windowsdevlic.md", - "redirect_url": "/powershell/module/windowsdevlic", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/windowssearch/windowssearch.md", - "redirect_url": "/powershell/module/windowssearch", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/windowsserverbackup/windowsserverbackup.md", - "redirect_url": "/powershell/module/windowsserverbackup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/wsus.md", - "redirect_url": "/powershell/module/wsus", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/networkconnectivitystatus/networkconnectivitystatus.md", - "redirect_url": "/powershell/module/networkconnectivitystatus", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wdac/wdac.md", - "redirect_url": "/powershell/module/wdac", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wds/wds.md", - "redirect_url": "/powershell/module/wds", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/networkcontroller/networkcontroller.md", - "redirect_url": "/powershell/module/networkcontroller", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/provisioning/provisioning.md", - "redirect_url": "/powershell/module/provisioning", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/agpm/agpm.md", - "redirect_url": "/powershell/module/agpm", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/appvclient.md", - "redirect_url": "/powershell/module/appvclient", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/add-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/add-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/add-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/add-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/add-appvpublishingserver.md", - "redirect_url": "/powershell/module/appvclient/add-appvpublishingserver?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/disable-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/disable-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/enable-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/enable-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvclientapplication.md", - "redirect_url": "/powershell/module/appvclient/get-appvclientapplication?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvclientconfiguration.md", - "redirect_url": "/powershell/module/appvclient/get-appvclientconfiguration?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/get-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvclientmode.md", - "redirect_url": "/powershell/module/appvclient/get-appvclientmode?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/get-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvpublishingserver.md", - "redirect_url": "/powershell/module/appvclient/get-appvpublishingserver?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvvirtualprocess.md", - "redirect_url": "/powershell/module/appvclient/get-appvvirtualprocess?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/mount-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/mount-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/mount-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/mount-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/publish-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/publish-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/remove-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/remove-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/remove-appvpublishingserver.md", - "redirect_url": "/powershell/module/appvclient/remove-appvpublishingserver?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/repair-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/repair-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/repair-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/repair-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/send-appvclientreport.md", - "redirect_url": "/powershell/module/appvclient/send-appvclientreport?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvclientconfiguration.md", - "redirect_url": "/powershell/module/appvclient/set-appvclientconfiguration?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvclientmode.md", - "redirect_url": "/powershell/module/appvclient/set-appvclientmode?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/set-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvpublishingserver.md", - "redirect_url": "/powershell/module/appvclient/set-appvpublishingserver?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/start-appvvirtualprocess.md", - "redirect_url": "/powershell/module/appvclient/start-appvvirtualprocess?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/stop-appvclientconnectiongroup.md", - "redirect_url": "/powershell/module/appvclient/stop-appvclientconnectiongroup?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/sync-appvpublishingserver.md", - "redirect_url": "/powershell/module/appvclient/sync-appvpublishingserver?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/unpublish-appvclientpackage.md", - "redirect_url": "/powershell/module/appvclient/unpublish-appvclientpackage?view=win-mdop2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/appv-package-converter.md", - "redirect_url": "/powershell/module/appv/", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/appv-sequencer.md", - "redirect_url": "/powershell/module/appvsequencer", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/expand-appvsequencerpackage.md", - "redirect_url": "/powershell/module/appvsequencer/expand-appvsequencerpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/new-appvpackageaccelerator.md", - "redirect_url": "/powershell/module/appvsequencer/new-appvpackageaccelerator", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/new-appvsequencerpackage.md", - "redirect_url": "/powershell/module/appvsequencer/new-appvsequencerpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/update-appvsequencerpackage.md", - "redirect_url": "/powershell/module/appvsequencer/update-appvsequencerpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/appv-server.md", - "redirect_url": "/powershell/module/appvserver/", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/add-appvserverconnectiongrouppackage.md", - "redirect_url": "/powershell/module/appvserver/add-appvserverconnectiongrouppackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/get-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/get-appvserverpackagedeploymentconfiguration.md", - "redirect_url": "/powershell/module/appvserver/get-appvserverpackagedeploymentconfiguration", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/grant-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/grant-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/grant-appvserverpackage.md", - "redirect_url": "/powershell/module/appvserver/grant-appvserverpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/import-appvserverpackage.md", - "redirect_url": "/powershell/module/appvserver/import-appvserverpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/new-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/new-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/publish-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/publish-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/publish-appvserverpackage.md", - "redirect_url": "/powershell/module/appvserver/publish-appvserverpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/remove-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/remove-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/remove-appvserverconnectiongrouppackage.md", - "redirect_url": "/powershell/module/appvserver/remove-appvserverconnectiongrouppackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/remove-appvserverpackage.md", - "redirect_url": "/powershell/module/appvserver/remove-appvserverpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/set-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvserverconnectiongrouppackage.md", - "redirect_url": "/powershell/module/appvserver/set-appvserverconnectiongrouppackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/set-appvserverpackage.md", - "redirect_url": "/powershell/module/appvserver/set-appvserverpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/unpublish-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/unpublish-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/unpublish-appvserverpackage.md", - "redirect_url": "/powershell/module/appvserver/unpublish-appvserverpackage", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/appv/update-appvserverconnectiongroup.md", - "redirect_url": "/powershell/module/appvserver/update-appvserverconnectiongroup", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/medv/medv-cmdlets.md", - "redirect_url": "/powershell/module/medv", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/medv/medv-workspace-cmdlets.md", - "redirect_url": "/powershell/module/Microsoft.Medv.Administration.Commands.WorkspacePackager", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/medv/export-medvworkspace.md", - "redirect_url": "/powershell/module/Microsoft.Medv.Administration.Commands.WorkspacePackager/export-medvworkspace", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/medv/new-medvworkspace.md", - "redirect_url": "/powershell/module/Microsoft.Medv.Administration.Commands.WorkspacePackager/new-medvworkspace", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Add-WsusComputer.md", - "redirect_url": "/powershell/module/updateservices/Add-WsusComputer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Add-WsusDynamicCategory.md", - "redirect_url": "/powershell/module/updateservices/Add-WsusDynamicCategory?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Approve-WsusUpdate.md", - "redirect_url": "/powershell/module/updateservices/Approve-WsusUpdate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Deny-WsusUpdate.md", - "redirect_url": "/powershell/module/updateservices/Deny-WsusUpdate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Get-WsusClassification.md", - "redirect_url": "/powershell/module/updateservices/Get-WsusClassification?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Get-WsusComputer.md", - "redirect_url": "/powershell/module/updateservices/Get-WsusComputer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Get-WsusDynamicCategory.md", - "redirect_url": "/powershell/module/updateservices/Get-WsusDynamicCategory?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Get-WsusProduct.md", - "redirect_url": "/powershell/module/updateservices/Get-WsusProduct?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Get-WsusServer.md", - "redirect_url": "/powershell/module/updateservices/Get-WsusServer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Get-WsusUpdate.md", - "redirect_url": "/powershell/module/updateservices/Get-WsusUpdate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Invoke-WsusServerCleanup.md", - "redirect_url": "/powershell/module/updateservices/Invoke-WsusServerCleanup?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Remove-WsusDynamicCategory.md", - "redirect_url": "/powershell/module/updateservices/Remove-WsusDynamicCategory?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Set-WsusClassification.md", - "redirect_url": "/powershell/module/updateservices/Set-WsusClassification?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Set-WsusDynamicCategory.md", - "redirect_url": "/powershell/module/updateservices/Set-WsusDynamicCategory?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Set-WsusProduct.md", - "redirect_url": "/powershell/module/updateservices/Set-WsusProduct?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/virtual-directory-module/wsus/Set-WsusServerSynchronization.md", - "redirect_url": "/powershell/module/updateservices/Set-WsusServerSynchronization?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/windows/international/Copy-UserInternationalSettingsToSystem.md", - "redirect_url": "/powershell/windows/get-started", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/DirectAccessClientFIX.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/DirectAccessClientComponents?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Disable-DAManualEntryPointSelection.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Disable-DAManualEntryPointSelection?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Enable-DAManualEntryPointSelection.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Enable-DAManualEntryPointSelection?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Get-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAClientExperienceConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Get-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAEntryPointTableItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/New-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/New-DAEntryPointTableItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Remove-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Remove-DAEntryPointTableItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Rename-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Rename-DAEntryPointTableItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Reset-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAClientExperienceConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Reset-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAEntryPointTableItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Set-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAClientExperienceConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/directaccessclient/Set-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAEntryPointTableItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinAcceptLanguageFromLanguageListOptOut.md", - "redirect_url": "/powershell/module/international/Get-WinAcceptLanguageFromLanguageListOptOut?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinCultureFromLanguageListOptOut.md", - "redirect_url": "/powershell/module/international/Get-WinCultureFromLanguageListOptOut?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinDefaultInputMethodOverride.md", - "redirect_url": "/powershell/module/international/Get-WinDefaultInputMethodOverride?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinHomeLocation.md", - "redirect_url": "/powershell/module/international/Get-WinHomeLocation?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinLanguageBarOption.md", - "redirect_url": "/powershell/module/international/Get-WinLanguageBarOption?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinSystemLocale.md", - "redirect_url": "/powershell/module/international/Get-WinSystemLocale?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinUILanguageOverride.md", - "redirect_url": "/powershell/module/international/Get-WinUILanguageOverride?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Get-WinUserLanguageList.md", - "redirect_url": "/powershell/module/international/Get-WinUserLanguageList?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/International Cmdlets.md", - "redirect_url": "/powershell/module/international/International?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/New-WinUserLanguageList.md", - "redirect_url": "/powershell/module/international/New-WinUserLanguageList?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-Culture.md", - "redirect_url": "/powershell/module/international/Set-Culture?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinAcceptLanguageFromLanguageListOptOut.md", - "redirect_url": "/powershell/module/international/Set-WinAcceptLanguageFromLanguageListOptOut?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinCultureFromLanguageListOptOut.md", - "redirect_url": "/powershell/module/international/Set-WinCultureFromLanguageListOptOut?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinDefaultInputMethodOverride.md", - "redirect_url": "/powershell/module/international/Set-WinDefaultInputMethodOverride?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinHomeLocation.md", - "redirect_url": "/powershell/module/international/Set-WinHomeLocation?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinLanguageBarOption.md", - "redirect_url": "/powershell/module/international/Set-WinLanguageBarOption?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinSystemLocale.md", - "redirect_url": "/powershell/module/international/Set-WinSystemLocale?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinUILanguageOverride.md", - "redirect_url": "/powershell/module/international/Set-WinUILanguageOverride?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/internationalcmdlets/Set-WinUserLanguageList.md", - "redirect_url": "/powershell/module/international/Set-WinUserLanguageList?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/msmq/MSMQ_Cmdlets.md", - "redirect_url": "/powershell/module/msmq/MSMQ?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/netconnection/Get-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Get-NetConnectionProfile?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/netconnection/NetConnection.md", - "redirect_url": "/powershell/module/netconnectionprofile/NetConnectionProfile?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/netconnection/Set-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Set-NetConnectionProfile?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Add-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Add-CertificateEnrollmentPolicyServer?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Export-Certificate.md", - "redirect_url": "/powershell/module/pki/Export-Certificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Export-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Get-Certificate.md", - "redirect_url": "/powershell/module/pki/Get-Certificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Get-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Get-CertificateAutoEnrollmentPolicy?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Get-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Get-CertificateEnrollmentPolicyServer?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Get-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Get-CertificateNotificationTask?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Get-PfxData.md", - "redirect_url": "/powershell/module/pki/Get-PfxData?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Import-Certificate.md", - "redirect_url": "/powershell/module/pki/Import-Certificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Import-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Import-PfxCertificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/New-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/New-CertificateNotificationTask?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/New-SelfSignedCertificate.md", - "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/PKIClient.md", - "redirect_url": "/powershell/module/pki/pki.md?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Remove-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateEnrollmentPolicyServer?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Remove-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateNotificationTask?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Set-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Set-CertificateAutoEnrollmentPolicy?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Switch-Certificate.md", - "redirect_url": "/powershell/module/pki/Switch-Certificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/pkiclient/Test-Certificate.md", - "redirect_url": "/powershell/module/pki/Test-Certificate?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Add-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Add-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Add-WebConfigurationLock.md", - "redirect_url": "/powershell/module/webadministration/Add-WebConfigurationLock?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Add-WebConfigurationProperty.md", - "redirect_url": "/powershell/module/webadministration/Add-WebConfigurationProperty?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Backup-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Backup-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Clear-WebCentralCertProvider.md", - "redirect_url": "/powershell/module/webadministration/Clear-WebCentralCertProvider?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Clear-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Clear-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Clear-WebRequestTracingSetting.md", - "redirect_url": "/powershell/module/webadministration/Clear-WebRequestTracingSetting?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Clear-WebRequestTracingSettings.md", - "redirect_url": "/powershell/module/webadministration/Clear-WebRequestTracingSettings?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/ConvertTo-WebApplication.md", - "redirect_url": "/powershell/module/webadministration/ConvertTo-WebApplication?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Disable-WebCentralCertProvider.md", - "redirect_url": "/powershell/module/webadministration/Disable-WebCentralCertProvider?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Disable-WebGlobalModule.md", - "redirect_url": "/powershell/module/webadministration/Disable-WebGlobalModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Disable-WebRequestTracing.md", - "redirect_url": "/powershell/module/webadministration/Disable-WebRequestTracing?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Enable-WebCentralCertProvider.md", - "redirect_url": "/powershell/module/webadministration/Enable-WebCentralCertProvider?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Enable-WebGlobalModule.md", - "redirect_url": "/powershell/module/webadministration/Enable-WebGlobalModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Enable-WebRequestTracing.md", - "redirect_url": "/powershell/module/webadministration/Enable-WebRequestTracing?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebAppDomain.md", - "redirect_url": "/powershell/module/webadministration/Get-WebAppDomain?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebApplication.md", - "redirect_url": "/powershell/module/webadministration/Get-WebApplication?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebAppPoolState.md", - "redirect_url": "/powershell/module/webadministration/Get-WebAppPoolState?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebBinding.md", - "redirect_url": "/powershell/module/webadministration/Get-WebBinding?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebCentralCertProvider.md", - "redirect_url": "/powershell/module/webadministration/Get-WebCentralCertProvider?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebConfigFile.md", - "redirect_url": "/powershell/module/webadministration/Get-WebConfigFile?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Get-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebConfigurationBackup.md", - "redirect_url": "/powershell/module/webadministration/Get-WebConfigurationBackup?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebConfigurationLocation.md", - "redirect_url": "/powershell/module/webadministration/Get-WebConfigurationLocation?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebConfigurationLock.md", - "redirect_url": "/powershell/module/webadministration/Get-WebConfigurationLock?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebConfigurationProperty.md", - "redirect_url": "/powershell/module/webadministration/Get-WebConfigurationProperty?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebFilePath.md", - "redirect_url": "/powershell/module/webadministration/Get-WebFilePath?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebHandler.md", - "redirect_url": "/powershell/module/webadministration/Get-WebHandler?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebItemState.md", - "redirect_url": "/powershell/module/webadministration/Get-WebItemState?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebManagedModule.md", - "redirect_url": "/powershell/module/webadministration/Get-WebManagedModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebRequest.md", - "redirect_url": "/powershell/module/webadministration/Get-WebRequest?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-Website.md", - "redirect_url": "/powershell/module/webadministration/Get-Website?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebsiteState.md", - "redirect_url": "/powershell/module/webadministration/Get-WebsiteState?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebURL.md", - "redirect_url": "/powershell/module/webadministration/Get-WebURL?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Get-WebVirtualDirectory.md", - "redirect_url": "/powershell/module/webadministration/Get-WebVirtualDirectory?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebApplication.md", - "redirect_url": "/powershell/module/webadministration/New-WebApplication?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebAppPool.md", - "redirect_url": "/powershell/module/webadministration/New-WebAppPool?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebBinding.md", - "redirect_url": "/powershell/module/webadministration/New-WebBinding?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebFtpSite.md", - "redirect_url": "/powershell/module/webadministration/New-WebFtpSite?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebGlobalModule.md", - "redirect_url": "/powershell/module/webadministration/New-WebGlobalModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebHandler.md", - "redirect_url": "/powershell/module/webadministration/New-WebHandler?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebManagedModule.md", - "redirect_url": "/powershell/module/webadministration/New-WebManagedModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-Website.md", - "redirect_url": "/powershell/module/webadministration/New-Website?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/New-WebVirtualDirectory.md", - "redirect_url": "/powershell/module/webadministration/New-WebVirtualDirectory?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebApplication.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebApplication?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebAppPool.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebAppPool?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebBinding.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebBinding?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebConfigurationBackup.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebConfigurationBackup?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebConfigurationLocation.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebConfigurationLocation?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebConfigurationLock.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebConfigurationLock?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebConfigurationProperty.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebConfigurationProperty?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebGlobalModule.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebGlobalModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebHandler.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebHandler?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebManagedModule.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebManagedModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-Website.md", - "redirect_url": "/powershell/module/webadministration/Remove-Website?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Remove-WebVirtualDirectory.md", - "redirect_url": "/powershell/module/webadministration/Remove-WebVirtualDirectory?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Rename-WebConfigurationLocation.md", - "redirect_url": "/powershell/module/webadministration/Rename-WebConfigurationLocation?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Restart-WebAppPool.md", - "redirect_url": "/powershell/module/webadministration/Restart-WebAppPool?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Restart-WebItem.md", - "redirect_url": "/powershell/module/webadministration/Restart-WebItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Restore-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Restore-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Select-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Select-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebBinding.md", - "redirect_url": "/powershell/module/webadministration/Set-WebBinding?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebCentralCertProvider.md", - "redirect_url": "/powershell/module/webadministration/Set-WebCentralCertProvider?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebCentralCertProviderCredential.md", - "redirect_url": "/powershell/module/webadministration/Set-WebCentralCertProviderCredential?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebConfiguration.md", - "redirect_url": "/powershell/module/webadministration/Set-WebConfiguration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebConfigurationProperty.md", - "redirect_url": "/powershell/module/webadministration/Set-WebConfigurationProperty?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebGlobalModule.md", - "redirect_url": "/powershell/module/webadministration/Set-WebGlobalModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebHandler.md", - "redirect_url": "/powershell/module/webadministration/Set-WebHandler?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Set-WebManagedModule.md", - "redirect_url": "/powershell/module/webadministration/Set-WebManagedModule?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Start-WebAppPool.md", - "redirect_url": "/powershell/module/webadministration/Start-WebAppPool?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Start-WebCommitDelay.md", - "redirect_url": "/powershell/module/webadministration/Start-WebCommitDelay?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Start-WebItem.md", - "redirect_url": "/powershell/module/webadministration/Start-WebItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Start-Website.md", - "redirect_url": "/powershell/module/webadministration/Start-Website?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Stop-WebAppPool.md", - "redirect_url": "/powershell/module/webadministration/Stop-WebAppPool?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Stop-WebCommitDelay.md", - "redirect_url": "/powershell/module/webadministration/Stop-WebCommitDelay?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Stop-WebItem.md", - "redirect_url": "/powershell/module/webadministration/Stop-WebItem?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/Stop-Website.md", - "redirect_url": "/powershell/module/webadministration/Stop-Website?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012-ps/webadminstration/WebAdministration.md", - "redirect_url": "/powershell/module/webadministration/WebAdministration?view=winserver2012-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/ActiveDirectory.md", - "redirect_url": "/powershell/module/activedirectory/ActiveDirectory?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADCentralAccessPolicyMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADCentralAccessPolicyMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADComputerServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADFineGrainedPasswordPolicySubject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADGroupMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADPrincipalGroupMembership?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Add-ADResourcePropertyListMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADResourcePropertyListMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Clear-ADAccountExpiration.md", - "redirect_url": "/powershell/module/activedirectory/Clear-ADAccountExpiration?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Clear-ADClaimTransformLink.md", - "redirect_url": "/powershell/module/activedirectory/Clear-ADClaimTransformLink?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Disable-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Disable-ADAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Disable-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Disable-ADOptionalFeature?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Enable-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Enable-ADAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Enable-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Enable-ADOptionalFeature?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADAccountAuthorizationGroup.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAccountAuthorizationGroup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADAccountResultantPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicySilo?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessRule?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADClaimTransformPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADClaimType?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADComputer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADComputerServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADDCCloningExcludedApplicationList.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDCCloningExcludedApplicationList?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADDefaultDomainPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDefaultDomainPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADDomain.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomain?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADDomainController.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainController?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicyUsage.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicySubject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADForest.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADForest?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADGroup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADGroupMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADOptionalFeature?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADOrganizationalUnit?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADPrincipalGroupMembership?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationAttributeMetadata.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationAttributeMetadata?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationConnection.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationConnection?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationFailure.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationFailure?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationPartnerMetadata.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationPartnerMetadata?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationQueueOperation.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationQueueOperation?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSite?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLink?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLinkBridge?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSubnet?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADReplicationUpToDatenessVectorTable.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationUpToDatenessVectorTable?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourceProperty?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyList?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADResourcePropertyValueType.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyValueType?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADRootDSE.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADRootDSE?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADTrust.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADTrust?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADUser?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Get-ADUserResultantPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADUserResultantPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Grant-ADAuthenticationPolicySiloAccess.md", - "redirect_url": "/powershell/module/activedirectory/Grant-ADAuthenticationPolicySiloAccess?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Install-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Install-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Move-ADDirectoryServer.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Move-ADDirectoryServerOperationMasterRole.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServerOperationMasterRole?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Move-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicySilo?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessRule?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADClaimTransformPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/New-ADClaimType?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/New-ADComputer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADDCCloneConfigFile.md", - "redirect_url": "/powershell/module/activedirectory/New-ADDCCloneConfigFile?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADFineGrainedPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/New-ADGroup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/New-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/New-ADOrganizationalUnit?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSite?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLink?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLinkBridge?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSubnet?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/New-ADResourceProperty?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/New-ADResourcePropertyList?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/New-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/New-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/New-ADUser?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicySilo?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADCentralAccessPolicyMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicyMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessRule?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimTransformPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimType?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADComputer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADComputerServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicySubject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADGroup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADGroupMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADOrganizationalUnit?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADPrincipalGroupMembership?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSite?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLink?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLinkBridge?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSubnet?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourceProperty?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyList?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADResourcePropertyListMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyListMember?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Remove-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADUser?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Rename-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Rename-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Reset-ADServiceAccountPassword.md", - "redirect_url": "/powershell/module/activedirectory/Reset-ADServiceAccountPassword?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Restore-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Restore-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Revoke-ADAuthenticationPolicySiloAccess.md", - "redirect_url": "/powershell/module/activedirectory/Revoke-ADAuthenticationPolicySiloAccess?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Search-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Search-ADAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADAccountAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountAuthenticationPolicySilo?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADAccountControl.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountControl?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADAccountExpiration.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountExpiration?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADAccountPassword.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountPassword?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicySilo?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessRule?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADClaimTransformLink.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformLink?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimType?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADComputer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADDefaultDomainPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDefaultDomainPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADDomain.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDomain?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADDomainMode.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDomainMode?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADFineGrainedPasswordPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADForest.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADForest?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADForestMode.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADForestMode?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADGroup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADOrganizationalUnit?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADReplicationConnection.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationConnection?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSite?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLink?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLinkBridge?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSubnet?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADResourceProperty?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADResourcePropertyList?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Set-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADUser?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Show-ADAuthenticationPolicyExpression.md", - "redirect_url": "/powershell/module/activedirectory/Show-ADAuthenticationPolicyExpression?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Sync-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Sync-ADObject?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Test-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Test-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Uninstall-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Uninstall-ADServiceAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/addsadministration/Unlock-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Unlock-ADAccount?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/directaccessclientcomponents/DirectAccessClientFIX.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/DirectAccessClientComponents?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/netconnection/Get-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Get-NetConnectionProfile?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/netconnection/NetConnection.md", - "redirect_url": "/powershell/module/netconnectionprofile/NetConnectionProfile?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/netconnection/Set-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Set-NetConnectionProfile?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Add-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Add-CertificateEnrollmentPolicyServer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Export-Certificate.md", - "redirect_url": "/powershell/module/pki/Export-Certificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Export-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Get-Certificate.md", - "redirect_url": "/powershell/module/pki/Get-Certificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Get-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Get-CertificateAutoEnrollmentPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Get-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Get-CertificateEnrollmentPolicyServer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Get-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Get-CertificateNotificationTask?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Get-PfxData.md", - "redirect_url": "/powershell/module/pki/Get-PfxData?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Import-Certificate.md", - "redirect_url": "/powershell/module/pki/Import-Certificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Import-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Import-PfxCertificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/New-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/New-CertificateNotificationTask?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/New-SelfSignedCertificate.md", - "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/PKIClient.md", - "redirect_url": "/powershell/module/pki/pki.md?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Remove-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateEnrollmentPolicyServer?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Remove-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateNotificationTask?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Set-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Set-CertificateAutoEnrollmentPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Switch-Certificate.md", - "redirect_url": "/powershell/module/pki/Switch-Certificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/pkiclient/Test-Certificate.md", - "redirect_url": "/powershell/module/pki/Test-Certificate?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowsdevlic/Get-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowsdevlic/WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Add-WBBackupTarget.md", - "redirect_url": "/powershell/module/windowsserverbackup/Add-WBBackupTarget?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Add-WBBareMetalRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Add-WBBareMetalRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Add-WBFileSpec.md", - "redirect_url": "/powershell/module/windowsserverbackup/Add-WBFileSpec?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Add-WBSystemState.md", - "redirect_url": "/powershell/module/windowsserverbackup/Add-WBSystemState?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Add-WBVirtualMachine.md", - "redirect_url": "/powershell/module/windowsserverbackup/Add-WBVirtualMachine?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Add-WBVolume.md", - "redirect_url": "/powershell/module/windowsserverbackup/Add-WBVolume?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBBackupSet.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBBackupSet?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBBackupTarget.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBBackupTarget?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBBackupVolumeBrowsePath.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBBackupVolumeBrowsePath?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBBareMetalRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBBareMetalRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBDisk.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBDisk?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBFileSpec.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBFileSpec?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBJob.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBJob?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBPerformanceConfiguration.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBPerformanceConfiguration?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBPolicy.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBSchedule.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBSchedule?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBSummary.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBSummary?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBSystemState.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBSystemState?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBVirtualMachine.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBVirtualMachine?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBVolume.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBVolume?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Get-WBVssBackupOption.md", - "redirect_url": "/powershell/module/windowsserverbackup/Get-WBVssBackupOption?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/New-WBBackupTarget.md", - "redirect_url": "/powershell/module/windowsserverbackup/New-WBBackupTarget?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/New-WBFileSpec.md", - "redirect_url": "/powershell/module/windowsserverbackup/New-WBFileSpec?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/New-WBPolicy.md", - "redirect_url": "/powershell/module/windowsserverbackup/New-WBPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBBackupSet.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBBackupSet?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBBackupTarget.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBBackupTarget?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBBareMetalRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBBareMetalRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBCatalog.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBCatalog?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBFileSpec.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBFileSpec?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBPolicy.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBSystemState.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBSystemState?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBVirtualMachine.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBVirtualMachine?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Remove-WBVolume.md", - "redirect_url": "/powershell/module/windowsserverbackup/Remove-WBVolume?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Restore-WBCatalog.md", - "redirect_url": "/powershell/module/windowsserverbackup/Restore-WBCatalog?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Resume-WBBackup.md", - "redirect_url": "/powershell/module/windowsserverbackup/Resume-WBBackup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Resume-WBVolumeRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Resume-WBVolumeRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Set-WBPerformanceConfiguration.md", - "redirect_url": "/powershell/module/windowsserverbackup/Set-WBPerformanceConfiguration?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Set-WBPolicy.md", - "redirect_url": "/powershell/module/windowsserverbackup/Set-WBPolicy?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Set-WBSchedule.md", - "redirect_url": "/powershell/module/windowsserverbackup/Set-WBSchedule?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Set-WBVssBackupOption.md", - "redirect_url": "/powershell/module/windowsserverbackup/Set-WBVssBackupOption?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Start-WBApplicationRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Start-WBApplicationRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Start-WBBackup.md", - "redirect_url": "/powershell/module/windowsserverbackup/Start-WBBackup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Start-WBFileRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Start-WBFileRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Start-WBHyperVRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Start-WBHyperVRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Start-WBSystemStateRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Start-WBSystemStateRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Start-WBVolumeRecovery.md", - "redirect_url": "/powershell/module/windowsserverbackup/Start-WBVolumeRecovery?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/Stop-WBJob.md", - "redirect_url": "/powershell/module/windowsserverbackup/Stop-WBJob?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2012r2-ps/windowserverbackup/WindowsServerBackup.md", - "redirect_url": "/powershell/module/windowsserverbackup/WindowsServerBackup?view=winserver2012r2-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/ActiveDirectory.md", - "redirect_url": "/powershell/module/activedirectory/ActiveDirectory?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADCentralAccessPolicyMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADCentralAccessPolicyMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADComputerServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADFineGrainedPasswordPolicySubject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADGroupMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADPrincipalGroupMembership?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Add-ADResourcePropertyListMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADResourcePropertyListMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Clear-ADAccountExpiration.md", - "redirect_url": "/powershell/module/activedirectory/Clear-ADAccountExpiration?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Clear-ADClaimTransformLink.md", - "redirect_url": "/powershell/module/activedirectory/Clear-ADClaimTransformLink?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Disable-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Disable-ADAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Disable-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Disable-ADOptionalFeature?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Enable-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Enable-ADAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Enable-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Enable-ADOptionalFeature?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAccountAuthorizationGroup.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAccountAuthorizationGroup?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAccountResultantPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicySilo?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessRule?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADClaimTransformPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADClaimType?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADComputer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADComputerServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDCCloningExcludedApplicationList.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDCCloningExcludedApplicationList?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDefaultDomainPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDefaultDomainPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomain.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomain?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomainController.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainController?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicyUsage.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicySubject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADForest.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADForest?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADGroup?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADGroupMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADOptionalFeature?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADOrganizationalUnit?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADPrincipalGroupMembership?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationAttributeMetadata.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationAttributeMetadata?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationConnection.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationConnection?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationFailure.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationFailure?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationPartnerMetadata.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationPartnerMetadata?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationQueueOperation.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationQueueOperation?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSite?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLink?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSubnet?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationUpToDatenessVectorTable.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationUpToDatenessVectorTable?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourceProperty?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyList?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADResourcePropertyValueType.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyValueType?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADRootDSE.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADRootDSE?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADTrust.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADTrust?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADUser?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Get-ADUserResultantPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADUserResultantPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Grant-ADAuthenticationPolicySiloAccess.md", - "redirect_url": "/powershell/module/activedirectory/Grant-ADAuthenticationPolicySiloAccess?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Install-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Install-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Move-ADDirectoryServer.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Move-ADDirectoryServerOperationMasterRole.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServerOperationMasterRole?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Move-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicySilo?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessRule?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADClaimTransformPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/New-ADClaimType?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/New-ADComputer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADDCCloneConfigFile.md", - "redirect_url": "/powershell/module/activedirectory/New-ADDCCloneConfigFile?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/New-ADGroup?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/New-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/New-ADOrganizationalUnit?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSite?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLink?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSubnet?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/New-ADResourceProperty?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/New-ADResourcePropertyList?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/New-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/New-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/New-ADUser?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicySilo?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADCentralAccessPolicyMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicyMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessRule?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimTransformPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimType?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADComputer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADComputerServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicySubject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADGroup?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADGroupMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADOrganizationalUnit?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADPrincipalGroupMembership?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSite?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLink?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSubnet?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourceProperty?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyList?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADResourcePropertyListMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyListMember?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADUser?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Rename-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Rename-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Reset-ADServiceAccountPassword.md", - "redirect_url": "/powershell/module/activedirectory/Reset-ADServiceAccountPassword?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Restore-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Restore-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Revoke-ADAuthenticationPolicySiloAccess.md", - "redirect_url": "/powershell/module/activedirectory/Revoke-ADAuthenticationPolicySiloAccess?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Search-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Search-ADAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountAuthenticationPolicySilo?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountControl.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountControl?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountExpiration.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountExpiration?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountPassword.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountPassword?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicySilo?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessRule?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADClaimTransformLink.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformLink?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimType?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADComputer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADDefaultDomainPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDefaultDomainPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADDomain.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDomain?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADDomainMode.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDomainMode?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADForest.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADForest?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADForestMode.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADForestMode?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADGroup?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADOrganizationalUnit?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationConnection.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationConnection?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSite?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLink?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSubnet?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADResourceProperty?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADResourcePropertyList?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Set-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADUser?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Show-ADAuthenticationPolicyExpression.md", - "redirect_url": "/powershell/module/activedirectory/Show-ADAuthenticationPolicyExpression?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Sync-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Sync-ADObject?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Test-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Test-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Uninstall-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Uninstall-ADServiceAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/addsadministration/Unlock-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Unlock-ADAccount?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/DirectAccessClientComponent.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/DirectAccessClientComponents?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Disable-DAManualEntryPointSelection.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Disable-DAManualEntryPointSelection?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Enable-DAManualEntryPointSelection.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Enable-DAManualEntryPointSelection?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Get-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAClientExperienceConfiguration?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Get-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAEntryPointTableItem?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/New-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/New-DAEntryPointTableItem?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Remove-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Remove-DAEntryPointTableItem?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Rename-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Rename-DAEntryPointTableItem?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Reset-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAClientExperienceConfiguration?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Reset-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAEntryPointTableItem?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Set-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAClientExperienceConfiguration?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Set-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAEntryPointTableItem?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticsDataViewer.md", - "redirect_url": "/powershell/module/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticDataViewer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netconnection/Get-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Get-NetConnectionProfile?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netconnection/NetConnection.md", - "redirect_url": "/powershell/module/netconnectionprofile/NetConnectionProfile?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netconnection/Set-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Set-NetConnectionProfile?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netldpagent/Disable-NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/Disable-NetLldpAgent?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netldpagent/Enable-NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/Enable-NetLldpAgent?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netldpagent/Get-NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/Get-NetLldpAgent?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/netldpagent/NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/NetLldpAgent?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Add-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Add-CertificateEnrollmentPolicyServer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Export-Certificate.md", - "redirect_url": "/powershell/module/pki/Export-Certificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Export-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Get-Certificate.md", - "redirect_url": "/powershell/module/pki/Get-Certificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Get-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Get-CertificateAutoEnrollmentPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Get-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Get-CertificateEnrollmentPolicyServer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Get-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Get-CertificateNotificationTask?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Get-PfxData.md", - "redirect_url": "/powershell/module/pki/Get-PfxData?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Import-Certificate.md", - "redirect_url": "/powershell/module/pki/Import-Certificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Import-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Import-PfxCertificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/New-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/New-CertificateNotificationTask?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/New-SelfSignedCertificate.md", - "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/PKIClient.md", - "redirect_url": "/powershell/module/pki/pki.md?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Remove-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateEnrollmentPolicyServer?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Remove-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateNotificationTask?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Set-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Set-CertificateAutoEnrollmentPolicy?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Switch-Certificate.md", - "redirect_url": "/powershell/module/pki/Switch-Certificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/pkiclient/Test-Certificate.md", - "redirect_url": "/powershell/module/pki/Test-Certificate?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Get-KeyProtectorFromShieldingDataFile.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-KeyProtectorFromShieldingDataFile?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Get-ShieldedVMProvisioningStatus.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-ShieldedVMProvisioningStatus?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Initialize-ShieldedVM.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Initialize-ShieldedVM?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/New-ShieldedVMSpecializationDataFile.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/New-ShieldedVMSpecializationDataFile?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/ShieldedVMProvisioning.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/ShieldedVmCmdlets?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Test-ShieldingDataApplicability.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Test-ShieldingDataApplicability?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/windowsdevlic/Get-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/windowsdevlic/WindowsDevLic.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense?view=windowsserver2016-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/ActiveDirectory.md", - "redirect_url": "/powershell/module/activedirectory/ActiveDirectory?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADCentralAccessPolicyMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADCentralAccessPolicyMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADComputerServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADFineGrainedPasswordPolicySubject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADGroupMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADPrincipalGroupMembership?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Add-ADResourcePropertyListMember.md", - "redirect_url": "/powershell/module/activedirectory/Add-ADResourcePropertyListMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Clear-ADAccountExpiration.md", - "redirect_url": "/powershell/module/activedirectory/Clear-ADAccountExpiration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Clear-ADClaimTransformLink.md", - "redirect_url": "/powershell/module/activedirectory/Clear-ADClaimTransformLink?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Disable-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Disable-ADAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Disable-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Disable-ADOptionalFeature?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Enable-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Enable-ADAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Enable-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Enable-ADOptionalFeature?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAccountAuthorizationGroup.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAccountAuthorizationGroup?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAccountResultantPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicySilo?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessRule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADClaimTransformPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADClaimType?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADComputer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADComputerServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDCCloningExcludedApplicationList.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDCCloningExcludedApplicationList?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDefaultDomainPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDefaultDomainPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomain.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomain?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomainController.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainController?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicyUsage.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicySubject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADForest.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADForest?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADGroup?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADGroupMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADOptionalFeature.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADOptionalFeature?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADOrganizationalUnit?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADPrincipalGroupMembership?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationAttributeMetadata.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationAttributeMetadata?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationConnection.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationConnection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationFailure.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationFailure?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationPartnerMetadata.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationPartnerMetadata?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationQueueOperation.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationQueueOperation?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSite?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLink?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSubnet?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationUpToDatenessVectorTable.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationUpToDatenessVectorTable?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourceProperty?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyList?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADResourcePropertyValueType.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyValueType?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADRootDSE.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADRootDSE?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADTrust.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADTrust?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADUser?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Get-ADUserResultantPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Get-ADUserResultantPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Grant-ADAuthenticationPolicySiloAccess.md", - "redirect_url": "/powershell/module/activedirectory/Grant-ADAuthenticationPolicySiloAccess?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Install-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Install-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Move-ADDirectoryServer.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Move-ADDirectoryServerOperationMasterRole.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServerOperationMasterRole?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Move-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Move-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicySilo?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessRule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADClaimTransformPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/New-ADClaimType?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/New-ADComputer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADDCCloneConfigFile.md", - "redirect_url": "/powershell/module/activedirectory/New-ADDCCloneConfigFile?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/New-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/New-ADGroup?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/New-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/New-ADOrganizationalUnit?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSite?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLink?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSubnet?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/New-ADResourceProperty?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/New-ADResourcePropertyList?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/New-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/New-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/New-ADUser?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicySilo?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADCentralAccessPolicyMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicyMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessRule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimTransformPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimType?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADComputer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADComputerServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADComputerServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADDomainControllerPasswordReplicationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADFineGrainedPasswordPolicySubject.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicySubject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADGroup?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADGroupMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADGroupMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADOrganizationalUnit?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADPrincipalGroupMembership.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADPrincipalGroupMembership?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSite?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLink?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSubnet?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourceProperty?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyList?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADResourcePropertyListMember.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyListMember?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Remove-ADUser?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Rename-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Rename-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Reset-ADServiceAccountPassword.md", - "redirect_url": "/powershell/module/activedirectory/Reset-ADServiceAccountPassword?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Restore-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Restore-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Revoke-ADAuthenticationPolicySiloAccess.md", - "redirect_url": "/powershell/module/activedirectory/Revoke-ADAuthenticationPolicySiloAccess?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Search-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Search-ADAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountAuthenticationPolicySilo?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountControl.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountControl?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountExpiration.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountExpiration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountPassword.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAccountPassword?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAuthenticationPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAuthenticationPolicySilo.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicySilo?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADCentralAccessPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADCentralAccessRule.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessRule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADClaimTransformLink.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformLink?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADClaimTransformPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADClaimType.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADClaimType?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADComputer.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADComputer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADDefaultDomainPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDefaultDomainPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADDomain.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDomain?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADDomainMode.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADDomainMode?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADFineGrainedPasswordPolicy.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADForest.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADForest?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADForestMode.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADForestMode?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADGroup.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADGroup?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADOrganizationalUnit.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADOrganizationalUnit?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationConnection.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationConnection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSite.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSite?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSiteLink.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLink?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSiteLinkBridge.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSubnet.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSubnet?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADResourceProperty.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADResourceProperty?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADResourcePropertyList.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADResourcePropertyList?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Set-ADUser.md", - "redirect_url": "/powershell/module/activedirectory/Set-ADUser?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Show-ADAuthenticationPolicyExpression.md", - "redirect_url": "/powershell/module/activedirectory/Show-ADAuthenticationPolicyExpression?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Sync-ADObject.md", - "redirect_url": "/powershell/module/activedirectory/Sync-ADObject?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Test-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Test-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Uninstall-ADServiceAccount.md", - "redirect_url": "/powershell/module/activedirectory/Uninstall-ADServiceAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/addsadministration/Unlock-ADAccount.md", - "redirect_url": "/powershell/module/activedirectory/Unlock-ADAccount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/DirectAccessClientComponent.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/DirectAccessClientComponents?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Disable-DAManualEntryPointSelection.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Disable-DAManualEntryPointSelection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Enable-DAManualEntryPointSelection.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Enable-DAManualEntryPointSelection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Get-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAClientExperienceConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Get-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAEntryPointTableItem?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/New-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/New-DAEntryPointTableItem?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Remove-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Remove-DAEntryPointTableItem?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Rename-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Rename-DAEntryPointTableItem?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Reset-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAClientExperienceConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Reset-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAEntryPointTableItem?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Set-DAClientExperienceConfiguration.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAClientExperienceConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Set-DAEntryPointTableItem.md", - "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAEntryPointTableItem?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticsDataViewer.md", - "redirect_url": "/powershell/module/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticDataViewer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netconnection/Get-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Get-NetConnectionProfile?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netconnection/NetConnection.md", - "redirect_url": "/powershell/module/netconnectionprofile/NetConnectionProfile?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netconnection/Set-NetConnectionProfile.md", - "redirect_url": "/powershell/module/netconnectionprofile/Set-NetConnectionProfile?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netldpagent/Disable-NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/Disable-NetLldpAgent?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netldpagent/Enable-NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/Enable-NetLldpAgent?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netldpagent/Get-NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/Get-NetLldpAgent?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/netldpagent/NetLldpAgent.md", - "redirect_url": "/powershell/module/netlldpagent/NetLldpAgent?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Add-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Add-CertificateEnrollmentPolicyServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Export-Certificate.md", - "redirect_url": "/powershell/module/pki/Export-Certificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Export-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Get-Certificate.md", - "redirect_url": "/powershell/module/pki/Get-Certificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Get-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Get-CertificateAutoEnrollmentPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Get-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Get-CertificateEnrollmentPolicyServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Get-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Get-CertificateNotificationTask?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Get-PfxData.md", - "redirect_url": "/powershell/module/pki/Get-PfxData?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Import-Certificate.md", - "redirect_url": "/powershell/module/pki/Import-Certificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Import-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Import-PfxCertificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/New-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/New-CertificateNotificationTask?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/New-SelfSignedCertificate.md", - "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/PKIClient.md", - "redirect_url": "/powershell/module/pki/pki.md?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Remove-CertificateEnrollmentPolicyServer.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateEnrollmentPolicyServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Remove-CertificateNotificationTask.md", - "redirect_url": "/powershell/module/pki/Remove-CertificateNotificationTask?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Set-CertificateAutoEnrollmentPolicy.md", - "redirect_url": "/powershell/module/pki/Set-CertificateAutoEnrollmentPolicy?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Switch-Certificate.md", - "redirect_url": "/powershell/module/pki/Switch-Certificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/pkiclient/Test-Certificate.md", - "redirect_url": "/powershell/module/pki/Test-Certificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Add-RDServer.md", - "redirect_url": "/powershell/module/rdmgmt/Add-RDServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Add-RDSessionHost.md", - "redirect_url": "/powershell/module/rdmgmt/Add-RDSessionHost?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Add-RDVirtualDesktopToCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Add-RDVirtualDesktopToCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Disable-RDVirtualDesktopADMachineAccountReuse.md", - "redirect_url": "/powershell/module/rdmgmt/Disable-RDVirtualDesktopADMachineAccountReuse?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Disconnect-RDUser.md", - "redirect_url": "/powershell/module/rdmgmt/Disconnect-RDUser?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Enable-RDVirtualDesktopADMachineAccountReuse.md", - "redirect_url": "/powershell/module/rdmgmt/Enable-RDVirtualDesktopADMachineAccountReuse?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Export-RDPersonalSessionDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Export-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Export-RDPersonalVirtualDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Export-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDAvailableApp.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDAvailableApp?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDCertificate.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDCertificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDConnectionBrokerHighAvailability.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDConnectionBrokerHighAvailability?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDDeploymentGatewayConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDDeploymentGatewayConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDFileTypeAssociation.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDFileTypeAssociation?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDLicenseConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDLicenseConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDPersonalSessionDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDPersonalVirtualDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDPersonalVirtualDesktopPatchSchedule.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDRemoteApp.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDRemoteApp?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDRemoteDesktop.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDRemoteDesktop?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDServer.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDSessionCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDSessionCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDSessionCollectionConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDSessionCollectionConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDSessionHost.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDSessionHost?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDUserSession.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDUserSession?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktop.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktop?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopCollectionConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopCollectionConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopCollectionJobStatus.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopCollectionJobStatus?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopConcurrency.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopConcurrency?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopIdleCount.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopIdleCount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopTemplateExportPath.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopTemplateExportPath?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDWorkspace.md", - "redirect_url": "/powershell/module/rdmgmt/Get-RDWorkspace?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Grant-RDOUAccess.md", - "redirect_url": "/powershell/module/rdmgmt/Grant-RDOUAccess?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Import-RDPersonalSessionDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Import-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Import-RDPersonalVirtualDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Import-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Invoke-RDUserLogoff.md", - "redirect_url": "/powershell/module/rdmgmt/Invoke-RDUserLogoff?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Move-RDVirtualDesktop.md", - "redirect_url": "/powershell/module/rdmgmt/Move-RDVirtualDesktop?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDCertificate.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDCertificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDPersonalVirtualDesktopPatchSchedule.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDRemoteApp.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDRemoteApp?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDSessionCollection.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDSessionCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDSessionDeployment.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDSessionDeployment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDVirtualDesktopCollection.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDVirtualDesktopCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/New-RDVirtualDesktopDeployment.md", - "redirect_url": "/powershell/module/rdmgmt/New-RDVirtualDesktopDeployment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/RemoteDesktop.md", - "redirect_url": "/powershell/module/rdmgmt/RDMgmt?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDDatabaseConnectionString.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDDatabaseConnectionString?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDPersonalSessionDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDPersonalVirtualDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDPersonalVirtualDesktopPatchSchedule.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDRemoteApp.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDRemoteApp?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDServer.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDSessionCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDSessionCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDSessionHost.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDSessionHost?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDVirtualDesktopCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDVirtualDesktopCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDVirtualDesktopFromCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Remove-RDVirtualDesktopFromCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Send-RDUserMessage.md", - "redirect_url": "/powershell/module/rdmgmt/Send-RDUserMessage?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDActiveManagementServer.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDActiveManagementServer?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDCertificate.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDCertificate?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDClientAccessName.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDClientAccessName?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDConnectionBrokerHighAvailability.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDConnectionBrokerHighAvailability?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDDatabaseConnectionString.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDDatabaseConnectionString?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDDeploymentGatewayConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDDeploymentGatewayConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDFileTypeAssociation.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDFileTypeAssociation?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDLicenseConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDLicenseConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDPersonalSessionDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDPersonalVirtualDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDPersonalVirtualDesktopPatchSchedule.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDRemoteApp.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteApp?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDRemoteDesktop.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteDesktop?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDSessionCollectionConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionCollectionConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDSessionHost.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionHost?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopCollectionConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopCollectionConfiguration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopConcurrency.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopConcurrency?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopIdleCount.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopIdleCount?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopTemplateExportPath.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopTemplateExportPath?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDWorkspace.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDWorkspace?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Stop-RDVirtualDesktopCollectionJob.md", - "redirect_url": "/powershell/module/rdmgmt/Stop-RDVirtualDesktopCollectionJob?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Test-RDOUAccess.md", - "redirect_url": "/powershell/module/rdmgmt/Test-RDOUAccess?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Test-RDVirtualDesktopADMachineAccountReuse.md", - "redirect_url": "/powershell/module/rdmgmt/Test-RDVirtualDesktopADMachineAccountReuse?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/remotedesktop/Update-RDVirtualDesktopCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Update-RDVirtualDesktopCollection?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Get-KeyProtectorFromShieldingDataFile.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-KeyProtectorFromShieldingDataFile?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Get-ShieldedVMProvisioningStatus.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-ShieldedVMProvisioningStatus?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Initialize-ShieldedVM.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Initialize-ShieldedVM?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/New-ShieldedVMSpecializationDataFile.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/New-ShieldedVMSpecializationDataFile?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/ShieldedVMProvisioning.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/ShieldedVmCmdlets?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Test-ShieldingDataApplicability.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Test-ShieldingDataApplicability?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/windowsdevlic/Get-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2019-ps/windowsdevlic/WindowsDevLic.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense?view=windowsserver2019-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/pkiclient/Export-PfxCertificate.md", - "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/pkiclient/PKIClient.md", - "redirect_url": "/powershell/module/pki/pki.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/pkiclient/New-SelfSignedCertificate.md", - "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=winserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDDeploymentGatewayConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDDeploymentGatewayConfiguration.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDFileTypeAssociation.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDFileTypeAssociation.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDLicenseConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDLicenseConfiguration.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDPersonalSessionDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalSessionDesktopAssignment.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDPersonalVirtualDesktopAssignment.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopAssignment.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDPersonalVirtualDesktopPatchSchedule.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopPatchSchedule.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDRemoteApp.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteApp.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDRemoteDesktop.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteDesktop.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDSessionCollectionConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionCollectionConfiguration.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDSessionHost.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionHost.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopCollectionConfiguration.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopCollectionConfiguration.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopConcurrency.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopConcurrency.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopIdleCount.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopIdleCount.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopTemplateExportPath.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopTemplateExportPath.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDWorkspace.md", - "redirect_url": "/powershell/module/rdmgmt/Set-RDWorkspace.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Stop-RDVirtualDesktopCollectionJob.md", - "redirect_url": "/powershell/module/rdmgmt/Stop-RDVirtualDesktopCollectionJob.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Test-RDOUAccess.md", - "redirect_url": "/powershell/module/rdmgmt/Test-RDOUAccess.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Test-RDVirtualDesktopADMachineAccountReuse.md", - "redirect_url": "/powershell/module/rdmgmt/Test-RDVirtualDesktopADMachineAccountReuse.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/remotedesktop/Update-RDVirtualDesktopCollection.md", - "redirect_url": "/powershell/module/rdmgmt/Update-RDVirtualDesktopCollection.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Get-KeyProtectorFromShieldingDataFile.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-KeyProtectorFromShieldingDataFile.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Get-ShieldedVMProvisioningStatus.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-ShieldedVMProvisioningStatus.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Initialize-ShieldedVM.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Initialize-ShieldedVM.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/New-ShieldedVMSpecializationDataFile.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/New-ShieldedVMSpecializationDataFile.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/ShieldedVMProvisioning.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/ShieldedVmCmdlets.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Test-ShieldingDataApplicability.md", - "redirect_url": "/powershell/module/shieldedvmcmdlets/Test-ShieldingDataApplicability.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/windowsdevlic/Get-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/windowsdevlic/WindowsDevLic.md", - "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/WindowsUpdate/Get-WindowsUpdateLog.md", - "redirect_url": "/powershell/module/windowsupdate/Get-WindowsUpdateLog.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/WindowsUpdate/WindowsUpdate.md", - "redirect_url": "/powershell/module/windowsupdate/WindowsUpdate.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2022-ps/EventTracingManagement/Set-AutologgerConfig.md", - "redirect_url": "/powershell/module/eventtracingmanagement/Update-AutologgerConfig.md?view=windowsserver2022-ps", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Export-ProvisioningPackage.md", - "redirect_url": "/powershell/module/provisioning/Export-ProvisioningPackage.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Export-Trace.md", - "redirect_url": "/powershell/module/provisioning/Export-Trace.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Get-ProvisioningPackage.md", - "redirect_url": "/powershell/module/provisioning/Get-ProvisioningPackage.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Get-TrustedProvisioningCertificate.md", - "redirect_url": "/powershell/module/provisioning/Get-TrustedProvisioningCertificate.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Install-ProvisioningPackage.md", - "redirect_url": "/powershell/module/provisioning/Install-ProvisioningPackage.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Install-TrustedProvisioningCertificate.md", - "redirect_url": "/powershell/module/provisioning/Install-TrustedProvisioningCertificate.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Provisioning.md", - "redirect_url": "/powershell/module/provisioning/Provisioning.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Uninstall-ProvisioningPackage.md", - "redirect_url": "/powershell/module/provisioning/Uninstall-ProvisioningPackage.md", - "redirect_document_id": false - }, - { - "source_path": "docset/winserver2016-ps/provisioning/Uninstall-TrustedProvisioningCertificate.md", - "redirect_url": "/powershell/module/provisioning/Uninstall-TrustedProvisioningCertificate.md", - "redirect_document_id": false - } - ] -} + "redirections": [ + { + "redirect_document_id": true, + "redirect_url": "winserver2016-ps/netconnection/Get-NetConnectionProfile?view=WindowsServer2016-ps", + "source_path": "winserver2016-ps/netconnectionprofile/Get-NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2016-ps/netconnection/NetConnection?view=WindowsServer2016-ps", + "source_path": "winserver2016-ps/netconnectionprofile/NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2016-ps/netconnection/Set-NetConnectionProfile?view=WindowsServer2016-ps", + "source_path": "winserver2016-ps/netconnectionprofile/Set-NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2019-ps/netconnection/Get-NetConnectionProfile?view=WindowsServer2019-ps", + "source_path": "winserver2019-ps/netconnectionprofile/Get-NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2019-ps/netconnection/NetConnection?view=WindowsServer2019-ps", + "source_path": "winserver2019-ps/netconnectionprofile/NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2019-ps/netconnection/Set-NetConnectionProfile?view=WindowsServer2019-ps", + "source_path": "winserver2019-ps/netconnectionprofile/Set-NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2022-ps/netconnection/Get-NetConnectionProfile?view=WindowsServer2022-ps", + "source_path": "winserver2022-ps/netconnectionprofile/Get-NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2022-ps/netconnection/NetConnection?view=WindowsServer2022-ps", + "source_path": "winserver2022-ps/netconnectionprofile/NetConnectionProfile.md" + }, + { + "redirect_document_id": true, + "redirect_url": "winserver2022-ps/netconnection/Set-NetConnectionProfile?view=WindowsServer2022-ps", + "source_path": "winserver2022-ps/netconnectionprofile/Set-NetConnectionProfile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/windows/get-started", + "source_path": "docset/docs-conceptual/windows/index.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/windows/get-started", + "source_path": "docset/docs-conceptual/windows/overview.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/adcsadministration", + "source_path": "docset/virtual-directory-module/adcsadministration/adcsadministration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/adcsdeployment", + "source_path": "docset/virtual-directory-module/adcsdeployment/adcsdeployment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory", + "source_path": "docset/virtual-directory-module/activedirectory/activedirectory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/addsdeployment", + "source_path": "docset/virtual-directory-module/addsdeployment/addsdeployment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/adfs", + "source_path": "docset/virtual-directory-module/adfs/adfs.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/adrmsadmin", + "source_path": "docset/virtual-directory-module/adrmsadmin/adrmsadmin.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appbackgroundtask", + "source_path": "docset/virtual-directory-module/appbackgroundtask/appbackgroundtask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/applocker", + "source_path": "docset/virtual-directory-module/applocker/applocker.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient", + "source_path": "docset/virtual-directory-module/appvclient/appvclient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvsequencer", + "source_path": "docset/virtual-directory-module/appvsequencer/appvsequencer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appx", + "source_path": "docset/virtual-directory-module/appx/appx.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/assignedaccess", + "source_path": "docset/virtual-directory-module/assignedaccess/assignedaccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/bestpractices", + "source_path": "docset/virtual-directory-module/bestpractices/bestpractices.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/bitlocker", + "source_path": "docset/virtual-directory-module/bitlocker/bitlocker.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/bitstransfer", + "source_path": "docset/virtual-directory-module/bitstransfer/bitstransfer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/booteventcollector", + "source_path": "docset/virtual-directory-module/booteventcollector/booteventcollector.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/branchcache", + "source_path": "docset/virtual-directory-module/branchcache/branchcache.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/cimcmdlets", + "source_path": "docset/virtual-directory-module/cimcmdlets/cimcmdlets.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/clusterawareupdating", + "source_path": "docset/virtual-directory-module/clusterawareupdating/clusterawareupdating.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/configci", + "source_path": "docset/virtual-directory-module/configci/configci.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hostcomputeservice", + "source_path": "docset/virtual-directory-module/hostcomputeservice/hostcomputeservice.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/dcbqos", + "source_path": "docset/virtual-directory-module/dcbqos/dcbqos.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/deduplication", + "source_path": "docset/virtual-directory-module/deduplication/deduplication.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/defender", + "source_path": "docset/virtual-directory-module/defender/defender.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/dfsn", + "source_path": "docset/virtual-directory-module/dfsn/dfsn.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/dfsr", + "source_path": "docset/virtual-directory-module/dfsr/dfsr.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/devicehealthattestation", + "source_path": "docset/virtual-directory-module/devicehealthattestation/devicehealthattestation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponent", + "source_path": "docset/virtual-directory-module/directaccessclientcomponent/directaccessclientcomponent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/dism", + "source_path": "docset/virtual-directory-module/dism/dism.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/dnsclient", + "source_path": "docset/virtual-directory-module/dnsclient/dnsclient/dns-client.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/dnsserver", + "source_path": "docset/virtual-directory-module/dnsserver/dnsserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/eventtracmancmdlets", + "source_path": "docset/virtual-directory-module/eventtracmancmdlets/eventtracmancmdlets.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/failoverclusters", + "source_path": "docset/virtual-directory-module/failoverclusters/failoverclusters.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/fileserverresourcemanager", + "source_path": "docset/virtual-directory-module/fileserverresourcemanager/fileserverresourcemanager.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/grouppolicy", + "source_path": "docset/virtual-directory-module/grouppolicy/grouppolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hardwarecertification", + "source_path": "docset/virtual-directory-module/hardwarecertification/hardwarecertification.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hnvdiagnostics", + "source_path": "docset/virtual-directory-module/hnvdiagnostics/hnvdiagnostics.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hnvdiagnostics", + "source_path": "docset/virtual-directory-module/hgsattestation/hgsattestation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hgsclient", + "source_path": "docset/virtual-directory-module/hgsclient/hgsclient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hgsdiagnostics", + "source_path": "docset/virtual-directory-module/hgsdiagnostics/hgsdiagnostics.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hgskeyprotection", + "source_path": "docset/virtual-directory-module/hgskeyprotection/hgskeyprotection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hgsserver", + "source_path": "docset/virtual-directory-module/hgsserver/hgsserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/hyper-v", + "source_path": "dvirtual-directory-module/hyper-v/hyper-v.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/iisadministration", + "source_path": "docset/virtual-directory-module/iisadministration/iisadministration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/international", + "source_path": "docset/virtual-directory-module/international/international.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/ipamserver", + "source_path": "docset/virtual-directory-module/ipamserver/ipamserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/iscsi", + "source_path": "docset/virtual-directory-module/iscsi/iscsi.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/iscsitarget", + "source_path": "docset/virtual-directory-module/iscsitarget/iscsitarget.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/kds", + "source_path": "docset/virtual-directory-module/kds/kds.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/mmagent", + "source_path": "docset/virtual-directory-module/mmagent/mmagent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/mpio", + "source_path": "docset/virtual-directory-module/mpio/mpio.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/msdtc", + "source_path": "docset/virtual-directory-module/msdtc/msdtc.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/msmq", + "source_path": "docset/virtual-directory-module/msmq/msmq.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/multipointvdi", + "source_path": "docset/virtual-directory-module/multipointvdi/multipointvdi.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/nanoserverimagegenerator", + "source_path": "docset/virtual-directory-module/nanoserverimagegenerator/nanoserverimagegenerator.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netnat", + "source_path": "docset/virtual-directory-module/netnat/netnat.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netadapter", + "source_path": "docset/virtual-directory-module/netadapter/netadapter.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netldpagent", + "source_path": "docset/virtual-directory-module/netldpagent/netldpagent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnection", + "source_path": "docset/virtual-directory-module/netconnection/netconnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/neteventpacketcapture", + "source_path": "docset/virtual-directory-module/neteventpacketcapture/neteventpacketcapture.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netsecurity", + "source_path": "docset/virtual-directory-module/netsecurity/netsecurity.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/networkswitchmanager", + "source_path": "docset/virtual-directory-module/networkswitchmanager/networkswitchmanager.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/networkcontrollerdiagnostics", + "source_path": "docset/virtual-directory-module/networkcontrollerdiagnostics/networkcontrollerdiagnostics.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/networktransition", + "source_path": "docset/virtual-directory-module/networktransition/networktransition.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netswitchteam", + "source_path": "docset/virtual-directory-module/netswitchteam/netswitchteam.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netwnv", + "source_path": "docset/virtual-directory-module/netwnv/netwnv.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/nfs", + "source_path": "docset/virtual-directory-module/nfs/nfs.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlbfo", + "source_path": "docset/virtual-directory-module/netlbfo/netlbfo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/networkloadbalancingclusters", + "source_path": "docset/virtual-directory-module/networkloadbalancingclusters/networkloadbalancingclusters.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/nps", + "source_path": "docset/virtual-directory-module/nps/nps.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pcsvdevice", + "source_path": "docset/virtual-directory-module/pcsvdevice/pcsvdevice.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki", + "source_path": "docset/virtual-directory-module/pki/index.yml" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki", + "source_path": "docset/virtual-directory-module/pkiclient/index.yml" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/pki", + "source_path": "docset/virtual-directory-module/pkiclient/pkiclient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/platformidentifier", + "source_path": "docset/virtual-directory-module/platformidentifier/platformidentifier.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pnpdevice", + "source_path": "docset/virtual-directory-module/pnpdevice/pnpdevice.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/printmanagement", + "source_path": "docset/virtual-directory-module/printmanagement/printmanagement.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/processmitigations", + "source_path": "docset/virtual-directory-module/processmitigations/processmitigations.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netqos", + "source_path": "docset/virtual-directory-module/netqos/netqos.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/remoteaccess", + "source_path": "docset/virtual-directory-module/remoteaccess/remoteaccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/remotedesktop", + "source_path": "docset/virtual-directory-module/remotedesktop/remotedesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/remotedesktopservices", + "source_path": "docset/virtual-directory-module/remotedesktopservices/remotedesktopservices.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/scheduledtasks", + "source_path": "docset/virtual-directory-module/scheduledtasks/scheduledtasks.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/secureboot", + "source_path": "dvirtual-directory-module/secureboot/secureboot.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/servercore", + "source_path": "docset/virtual-directory-module/servercore/servercore.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/servermanager", + "source_path": "docset/virtual-directory-module/servermanager/servermanager.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/servermanagertasks", + "source_path": "docset/virtual-directory-module/servermanagertasks/servermanagertasks.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmdatafile", + "source_path": "docset/virtual-directory-module/shieldedvmdatafile/shieldedvmdatafile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmprovisioning", + "source_path": "docset/virtual-directory-module/shieldedvmprovisioning/shieldedvmprovisioning.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmtemplate", + "source_path": "docset/virtual-directory-module/shieldedvmtemplate/shieldedvmtemplate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/softwareinventorylogging", + "source_path": "docset/virtual-directory-module/softwareinventorylogging/softwareinventorylogging.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/smbshare", + "source_path": "docset/virtual-directory-module/smbshare/smbshare.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/smbwitness", + "source_path": "docset/virtual-directory-module/smbwitness/smbwitness.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/smisconfig", + "source_path": "docset/virtual-directory-module/smisconfig/smisconfig.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/startlayout", + "source_path": "docset/virtual-directory-module/startlayout/startlayout.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/storage", + "source_path": "docset/virtual-directory-module/storage/storage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/storageqos", + "source_path": "docset/virtual-directory-module/storageqos/storageqos.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/storagereplica", + "source_path": "docset/virtual-directory-module/storagereplica/storagereplica.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/syncshare", + "source_path": "docset/virtual-directory-module/syncshare/syncshare.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/nettcpip", + "source_path": "docset/virtual-directory-module/nettcpip/nettcpip.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/tls", + "source_path": "docset/virtual-directory-module/tls/tls.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/trustedplatformmodule", + "source_path": "docset/virtual-directory-module/trustedplatformmodule/trustedplatformmodule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/useraccesslogging", + "source_path": "docset/virtual-directory-module/useraccesslogging/useraccesslogging.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/vamt", + "source_path": "docset/virtual-directory-module/vamt/vamt.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/uev", + "source_path": "docset/virtual-directory-module/uev/uev.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/troubleshootingpack", + "source_path": "docset/virtual-directory-module/troubleshootingpack/troubleshootingpack.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/vpnclient", + "source_path": "docset/virtual-directory-module/vpnclient/vpnclient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/webapplicationproxy", + "source_path": "docset/virtual-directory-module/webapplicationproxy/webapplicationproxy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowserrorreporting", + "source_path": "docset/virtual-directory-module/windowserrorreporting/windowserrorreporting.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsupdate", + "source_path": "docset/virtual-directory-module/windowsupdate/windowsupdate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/webadministration", + "source_path": "docset/virtual-directory-module/webadministration/webadministration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/whea", + "source_path": "docset/virtual-directory-module/whea/whea.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdevlic", + "source_path": "docset/virtual-directory-module/windowsdevlic/windowsdevlic.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowssearch", + "source_path": "docset/virtual-directory-module/windowssearch/windowssearch.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsserverbackup", + "source_path": "docset/virtual-directory-module/windowsserverbackup/windowsserverbackup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/wsus", + "source_path": "docset/virtual-directory-module/wsus/wsus.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/networkconnectivitystatus", + "source_path": "docset/virtual-directory-module/networkconnectivitystatus/networkconnectivitystatus.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/wdac", + "source_path": "docset/virtual-directory-module/wdac/wdac.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/wds", + "source_path": "docset/virtual-directory-module/wds/wds.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/networkcontroller", + "source_path": "docset/virtual-directory-module/networkcontroller/networkcontroller.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning", + "source_path": "docset/virtual-directory-module/provisioning/provisioning.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/agpm", + "source_path": "docset/virtual-directory-module/agpm/agpm.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient", + "source_path": "docset/virtual-directory-module/appv/appvclient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/add-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/add-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/add-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/add-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/add-appvpublishingserver?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/add-appvpublishingserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/disable-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/disable-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/enable-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/enable-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvclientapplication?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvclientapplication.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvclientconfiguration?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvclientconfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvclientmode?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvclientmode.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvpublishingserver?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvpublishingserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/get-appvvirtualprocess?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/get-appvvirtualprocess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/mount-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/mount-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/mount-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/mount-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/publish-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/publish-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/remove-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/remove-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/remove-appvpublishingserver?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/remove-appvpublishingserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/repair-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/repair-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/repair-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/repair-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/send-appvclientreport?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/send-appvclientreport.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/set-appvclientconfiguration?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/set-appvclientconfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/set-appvclientmode?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/set-appvclientmode.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/set-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/set-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/set-appvpublishingserver?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/set-appvpublishingserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/start-appvvirtualprocess?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/start-appvvirtualprocess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/stop-appvclientconnectiongroup?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/stop-appvclientconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/sync-appvpublishingserver?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/sync-appvpublishingserver.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvclient/unpublish-appvclientpackage?view=win-mdop2-ps", + "source_path": "docset/virtual-directory-module/appv/unpublish-appvclientpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appv/", + "source_path": "docset/virtual-directory-module/appv/appv-package-converter.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvsequencer", + "source_path": "docset/virtual-directory-module/appv/appv-sequencer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvsequencer/expand-appvsequencerpackage", + "source_path": "docset/virtual-directory-module/appv/expand-appvsequencerpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvsequencer/new-appvpackageaccelerator", + "source_path": "docset/virtual-directory-module/appv/new-appvpackageaccelerator.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvsequencer/new-appvsequencerpackage", + "source_path": "docset/virtual-directory-module/appv/new-appvsequencerpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvsequencer/update-appvsequencerpackage", + "source_path": "docset/virtual-directory-module/appv/update-appvsequencerpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/", + "source_path": "docset/virtual-directory-module/appv/appv-server.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/add-appvserverconnectiongrouppackage", + "source_path": "docset/virtual-directory-module/appv/add-appvserverconnectiongrouppackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/get-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/get-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/get-appvserverpackagedeploymentconfiguration", + "source_path": "docset/virtual-directory-module/appv/get-appvserverpackagedeploymentconfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/grant-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/grant-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/grant-appvserverpackage", + "source_path": "docset/virtual-directory-module/appv/grant-appvserverpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/import-appvserverpackage", + "source_path": "docset/virtual-directory-module/appv/import-appvserverpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/new-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/new-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/publish-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/publish-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/publish-appvserverpackage", + "source_path": "docset/virtual-directory-module/appv/publish-appvserverpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/remove-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/remove-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/remove-appvserverconnectiongrouppackage", + "source_path": "docset/virtual-directory-module/appv/remove-appvserverconnectiongrouppackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/remove-appvserverpackage", + "source_path": "docset/virtual-directory-module/appv/remove-appvserverpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/set-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/set-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/set-appvserverconnectiongrouppackage", + "source_path": "docset/virtual-directory-module/appv/set-appvserverconnectiongrouppackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/set-appvserverpackage", + "source_path": "docset/virtual-directory-module/appv/set-appvserverpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/unpublish-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/unpublish-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/unpublish-appvserverpackage", + "source_path": "docset/virtual-directory-module/appv/unpublish-appvserverpackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/appvserver/update-appvserverconnectiongroup", + "source_path": "docset/virtual-directory-module/appv/update-appvserverconnectiongroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/medv", + "source_path": "docset/virtual-directory-module/medv/medv-cmdlets.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/Microsoft.Medv.Administration.Commands.WorkspacePackager", + "source_path": "docset/virtual-directory-module/medv/medv-workspace-cmdlets.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/Microsoft.Medv.Administration.Commands.WorkspacePackager/export-medvworkspace", + "source_path": "docset/virtual-directory-module/medv/export-medvworkspace.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/Microsoft.Medv.Administration.Commands.WorkspacePackager/new-medvworkspace", + "source_path": "docset/virtual-directory-module/medv/new-medvworkspace.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Add-WsusComputer?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Add-WsusComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Add-WsusDynamicCategory?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Add-WsusDynamicCategory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Approve-WsusUpdate?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Approve-WsusUpdate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Deny-WsusUpdate?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Deny-WsusUpdate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Get-WsusClassification?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Get-WsusClassification.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Get-WsusComputer?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Get-WsusComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Get-WsusDynamicCategory?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Get-WsusDynamicCategory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Get-WsusProduct?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Get-WsusProduct.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Get-WsusServer?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Get-WsusServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Get-WsusUpdate?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Get-WsusUpdate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Invoke-WsusServerCleanup?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Invoke-WsusServerCleanup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Remove-WsusDynamicCategory?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Remove-WsusDynamicCategory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Set-WsusClassification?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Set-WsusClassification.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Set-WsusDynamicCategory?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Set-WsusDynamicCategory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Set-WsusProduct?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Set-WsusProduct.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/updateservices/Set-WsusServerSynchronization?view=windowsserver2016-ps", + "source_path": "docset/virtual-directory-module/wsus/Set-WsusServerSynchronization.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/windows/get-started", + "source_path": "docset/windows/international/Copy-UserInternationalSettingsToSystem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/ActiveDirectory?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/ActiveDirectory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADCentralAccessPolicyMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADCentralAccessPolicyMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADComputerServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADComputerServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADDomainControllerPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADFineGrainedPasswordPolicySubject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADFineGrainedPasswordPolicySubject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADGroupMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADGroupMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADPrincipalGroupMembership?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADPrincipalGroupMembership.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADResourcePropertyListMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Add-ADResourcePropertyListMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Clear-ADAccountExpiration?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Clear-ADAccountExpiration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Clear-ADClaimTransformLink?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Clear-ADClaimTransformLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Disable-ADAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Disable-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Disable-ADOptionalFeature?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Disable-ADOptionalFeature.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Enable-ADAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Enable-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Enable-ADOptionalFeature?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Enable-ADOptionalFeature.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAccountAuthorizationGroup?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAccountAuthorizationGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAccountResultantPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicySilo?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessRule?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADClaimTransformPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADClaimType?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADComputer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADComputerServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADComputerServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDCCloningExcludedApplicationList?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDCCloningExcludedApplicationList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDefaultDomainPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDefaultDomainPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomain?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomain.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomainController?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomainController.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicyUsage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicySubject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADFineGrainedPasswordPolicySubject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADForest?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADForest.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADGroup?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADGroupMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADGroupMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADOptionalFeature?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADOptionalFeature.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADOrganizationalUnit?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADPrincipalGroupMembership?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADPrincipalGroupMembership.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationAttributeMetadata?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationAttributeMetadata.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationConnection?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationConnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationFailure?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationFailure.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationPartnerMetadata?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationPartnerMetadata.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationQueueOperation?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationQueueOperation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSite?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLink?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSubnet?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationUpToDatenessVectorTable?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADReplicationUpToDatenessVectorTable.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADResourceProperty?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyList?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyValueType?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADResourcePropertyValueType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADRootDSE?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADRootDSE.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADTrust?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADTrust.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADUser?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADUserResultantPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Get-ADUserResultantPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Grant-ADAuthenticationPolicySiloAccess?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Grant-ADAuthenticationPolicySiloAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Install-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Install-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Move-ADDirectoryServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServerOperationMasterRole?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Move-ADDirectoryServerOperationMasterRole.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Move-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Move-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicySilo?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessRule?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADClaimTransformPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADClaimType?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADComputer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADDCCloneConfigFile?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADDCCloneConfigFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADGroup?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADOrganizationalUnit?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSite?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLink?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSubnet?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADResourceProperty?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADResourcePropertyList?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADUser?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/New-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicySilo?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicyMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADCentralAccessPolicyMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessRule?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimTransformPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimType?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADComputer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADComputerServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADComputerServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADDomainControllerPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicySubject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADFineGrainedPasswordPolicySubject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADGroup?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADGroupMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADGroupMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADOrganizationalUnit?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADPrincipalGroupMembership?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADPrincipalGroupMembership.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSite?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLink?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSubnet?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADResourceProperty?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyList?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyListMember?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADResourcePropertyListMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADUser?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Remove-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Rename-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Rename-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Reset-ADServiceAccountPassword?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Reset-ADServiceAccountPassword.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Restore-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Restore-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Revoke-ADAuthenticationPolicySiloAccess?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Revoke-ADAuthenticationPolicySiloAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Search-ADAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Search-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountAuthenticationPolicySilo?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountControl?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountControl.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountExpiration?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountExpiration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountPassword?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAccountPassword.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicySilo?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessRule?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformLink?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADClaimTransformLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADClaimType?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADComputer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADDefaultDomainPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADDefaultDomainPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADDomain?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADDomain.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADDomainMode?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADDomainMode.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADFineGrainedPasswordPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADForest?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADForest.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADForestMode?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADForestMode.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADGroup?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADOrganizationalUnit?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationConnection?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationConnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSite?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLink?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLinkBridge?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSubnet?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADResourceProperty?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADResourcePropertyList?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADUser?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Set-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Show-ADAuthenticationPolicyExpression?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Show-ADAuthenticationPolicyExpression.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Sync-ADObject?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Sync-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Test-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Test-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Uninstall-ADServiceAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Uninstall-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Unlock-ADAccount?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/addsadministration/Unlock-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/DirectAccessClientComponents?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/DirectAccessClientComponent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Disable-DAManualEntryPointSelection?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Disable-DAManualEntryPointSelection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Enable-DAManualEntryPointSelection?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Enable-DAManualEntryPointSelection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAClientExperienceConfiguration?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Get-DAClientExperienceConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAEntryPointTableItem?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Get-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/New-DAEntryPointTableItem?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/New-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Remove-DAEntryPointTableItem?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Remove-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Rename-DAEntryPointTableItem?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Rename-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAClientExperienceConfiguration?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Reset-DAClientExperienceConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAEntryPointTableItem?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Reset-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAClientExperienceConfiguration?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Set-DAClientExperienceConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAEntryPointTableItem?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/directaccessclientcomponent/Set-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticDataViewer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticsDataViewer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnectionprofile/Get-NetConnectionProfile?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netconnection/Get-NetConnectionProfile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnectionprofile/NetConnectionProfile?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netconnection/NetConnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnectionprofile/Set-NetConnectionProfile?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netconnection/Set-NetConnectionProfile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/Disable-NetLldpAgent?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netldpagent/Disable-NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/Enable-NetLldpAgent?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netldpagent/Enable-NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/Get-NetLldpAgent?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netldpagent/Get-NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/NetLldpAgent?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/netldpagent/NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Add-CertificateEnrollmentPolicyServer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Add-CertificateEnrollmentPolicyServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Export-Certificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Export-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Export-PfxCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-Certificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Get-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-CertificateAutoEnrollmentPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Get-CertificateAutoEnrollmentPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-CertificateEnrollmentPolicyServer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Get-CertificateEnrollmentPolicyServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-CertificateNotificationTask?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Get-CertificateNotificationTask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-PfxData?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Get-PfxData.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Import-Certificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Import-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Import-PfxCertificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Import-PfxCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/New-CertificateNotificationTask?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/New-CertificateNotificationTask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/New-SelfSignedCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/pki.md?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/PKIClient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Remove-CertificateEnrollmentPolicyServer?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Remove-CertificateEnrollmentPolicyServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Remove-CertificateNotificationTask?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Remove-CertificateNotificationTask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Set-CertificateAutoEnrollmentPolicy?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Set-CertificateAutoEnrollmentPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Switch-Certificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Switch-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Test-Certificate?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/pkiclient/Test-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-KeyProtectorFromShieldingDataFile?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Get-KeyProtectorFromShieldingDataFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-ShieldedVMProvisioningStatus?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Get-ShieldedVMProvisioningStatus.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Initialize-ShieldedVM?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Initialize-ShieldedVM.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/New-ShieldedVMSpecializationDataFile?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/New-ShieldedVMSpecializationDataFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/ShieldedVmCmdlets?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/ShieldedVMProvisioning.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Test-ShieldingDataApplicability?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/shieldedvmprovisioning/Test-ShieldingDataApplicability.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/windowsdevlic/Get-WindowsDeveloperLicense.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense?view=windowsserver2016-ps", + "source_path": "docset/winserver2016-ps/windowsdevlic/WindowsDevLic.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/ActiveDirectory?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/ActiveDirectory.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADCentralAccessPolicyMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADCentralAccessPolicyMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADComputerServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADComputerServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADDomainControllerPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADFineGrainedPasswordPolicySubject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADFineGrainedPasswordPolicySubject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADGroupMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADGroupMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADPrincipalGroupMembership?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADPrincipalGroupMembership.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Add-ADResourcePropertyListMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Add-ADResourcePropertyListMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Clear-ADAccountExpiration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Clear-ADAccountExpiration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Clear-ADClaimTransformLink?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Clear-ADClaimTransformLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Disable-ADAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Disable-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Disable-ADOptionalFeature?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Disable-ADOptionalFeature.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Enable-ADAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Enable-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Enable-ADOptionalFeature?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Enable-ADOptionalFeature.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAccountAuthorizationGroup?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAccountAuthorizationGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAccountResultantPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADAuthenticationPolicySilo?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADCentralAccessRule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADClaimTransformPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADClaimType?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADComputer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADComputerServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADComputerServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDCCloningExcludedApplicationList?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDCCloningExcludedApplicationList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDefaultDomainPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDefaultDomainPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomain?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomain.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomainController?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomainController.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADDomainControllerPasswordReplicationPolicyUsage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADFineGrainedPasswordPolicySubject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADFineGrainedPasswordPolicySubject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADForest?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADForest.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADGroup?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADGroupMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADGroupMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADOptionalFeature?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADOptionalFeature.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADOrganizationalUnit?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADPrincipalGroupMembership?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADPrincipalGroupMembership.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationAttributeMetadata?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationAttributeMetadata.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationConnection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationConnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationFailure?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationFailure.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationPartnerMetadata?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationPartnerMetadata.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationQueueOperation?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationQueueOperation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSite?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLink?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationSubnet?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADReplicationUpToDatenessVectorTable?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADReplicationUpToDatenessVectorTable.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADResourceProperty?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyList?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADResourcePropertyValueType?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADResourcePropertyValueType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADRootDSE?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADRootDSE.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADTrust?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADTrust.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADUser?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Get-ADUserResultantPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Get-ADUserResultantPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Grant-ADAuthenticationPolicySiloAccess?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Grant-ADAuthenticationPolicySiloAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Install-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Install-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Move-ADDirectoryServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Move-ADDirectoryServerOperationMasterRole?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Move-ADDirectoryServerOperationMasterRole.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Move-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Move-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADAuthenticationPolicySilo?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADCentralAccessRule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADClaimTransformPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADClaimType?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADComputer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADDCCloneConfigFile?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADDCCloneConfigFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADGroup?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADOrganizationalUnit?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSite?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLink?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADReplicationSubnet?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADResourceProperty?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADResourcePropertyList?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/New-ADUser?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/New-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADAuthenticationPolicySilo?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessPolicyMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADCentralAccessPolicyMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADCentralAccessRule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimTransformPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADClaimType?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADComputer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADComputerServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADComputerServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADDomainControllerPasswordReplicationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADFineGrainedPasswordPolicySubject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADFineGrainedPasswordPolicySubject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADGroup?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADGroupMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADGroupMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADOrganizationalUnit?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADPrincipalGroupMembership?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADPrincipalGroupMembership.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSite?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLink?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADReplicationSubnet?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADResourceProperty?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyList?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADResourcePropertyListMember?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADResourcePropertyListMember.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Remove-ADUser?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Remove-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Rename-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Rename-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Reset-ADServiceAccountPassword?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Reset-ADServiceAccountPassword.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Restore-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Restore-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Revoke-ADAuthenticationPolicySiloAccess?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Revoke-ADAuthenticationPolicySiloAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Search-ADAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Search-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountAuthenticationPolicySilo?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountControl?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountControl.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountExpiration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountExpiration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAccountPassword?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAccountPassword.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAuthenticationPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADAuthenticationPolicySilo?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADAuthenticationPolicySilo.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADCentralAccessPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADCentralAccessRule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADCentralAccessRule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformLink?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADClaimTransformLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADClaimTransformPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADClaimTransformPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADClaimType?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADClaimType.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADComputer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADComputer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADDefaultDomainPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADDefaultDomainPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADDomain?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADDomain.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADDomainMode?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADDomainMode.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADFineGrainedPasswordPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADFineGrainedPasswordPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADForest?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADForest.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADForestMode?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADForestMode.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADGroup?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADGroup.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADOrganizationalUnit?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADOrganizationalUnit.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationConnection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationConnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSite?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSite.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLink?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSiteLink.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSiteLinkBridge?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSiteLinkBridge.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADReplicationSubnet?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADReplicationSubnet.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADResourceProperty?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADResourceProperty.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADResourcePropertyList?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADResourcePropertyList.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Set-ADUser?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Set-ADUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Show-ADAuthenticationPolicyExpression?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Show-ADAuthenticationPolicyExpression.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Sync-ADObject?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Sync-ADObject.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Test-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Test-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Uninstall-ADServiceAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Uninstall-ADServiceAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/activedirectory/Unlock-ADAccount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/addsadministration/Unlock-ADAccount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/DirectAccessClientComponents?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/DirectAccessClientComponent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Disable-DAManualEntryPointSelection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Disable-DAManualEntryPointSelection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Enable-DAManualEntryPointSelection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Enable-DAManualEntryPointSelection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAClientExperienceConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Get-DAClientExperienceConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Get-DAEntryPointTableItem?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Get-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/New-DAEntryPointTableItem?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/New-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Remove-DAEntryPointTableItem?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Remove-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Rename-DAEntryPointTableItem?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Rename-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAClientExperienceConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Reset-DAClientExperienceConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Reset-DAEntryPointTableItem?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Reset-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAClientExperienceConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Set-DAClientExperienceConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/directaccessclientcomponents/Set-DAEntryPointTableItem?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/directaccessclientcomponent/Set-DAEntryPointTableItem.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticDataViewer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/Microsoft.DiagnosticDataViewer/Microsoft.DiagnosticsDataViewer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnectionprofile/Get-NetConnectionProfile?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netconnection/Get-NetConnectionProfile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnectionprofile/NetConnectionProfile?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netconnection/NetConnection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netconnectionprofile/Set-NetConnectionProfile?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netconnection/Set-NetConnectionProfile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/Disable-NetLldpAgent?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netldpagent/Disable-NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/Enable-NetLldpAgent?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netldpagent/Enable-NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/Get-NetLldpAgent?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netldpagent/Get-NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/netlldpagent/NetLldpAgent?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/netldpagent/NetLldpAgent.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Add-CertificateEnrollmentPolicyServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Add-CertificateEnrollmentPolicyServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Export-Certificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Export-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Export-PfxCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-Certificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Get-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-CertificateAutoEnrollmentPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Get-CertificateAutoEnrollmentPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-CertificateEnrollmentPolicyServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Get-CertificateEnrollmentPolicyServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-CertificateNotificationTask?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Get-CertificateNotificationTask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Get-PfxData?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Get-PfxData.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Import-Certificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Import-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Import-PfxCertificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Import-PfxCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/New-CertificateNotificationTask?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/New-CertificateNotificationTask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/New-SelfSignedCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/pki.md?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/PKIClient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Remove-CertificateEnrollmentPolicyServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Remove-CertificateEnrollmentPolicyServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Remove-CertificateNotificationTask?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Remove-CertificateNotificationTask.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Set-CertificateAutoEnrollmentPolicy?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Set-CertificateAutoEnrollmentPolicy.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Switch-Certificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Switch-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Test-Certificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/pkiclient/Test-Certificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Add-RDServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Add-RDServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Add-RDSessionHost?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Add-RDSessionHost.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Add-RDVirtualDesktopToCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Add-RDVirtualDesktopToCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Disable-RDVirtualDesktopADMachineAccountReuse?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Disable-RDVirtualDesktopADMachineAccountReuse.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Disconnect-RDUser?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Disconnect-RDUser.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Enable-RDVirtualDesktopADMachineAccountReuse?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Enable-RDVirtualDesktopADMachineAccountReuse.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Export-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Export-RDPersonalSessionDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Export-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Export-RDPersonalVirtualDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDAvailableApp?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDAvailableApp.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDCertificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDConnectionBrokerHighAvailability?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDConnectionBrokerHighAvailability.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDDeploymentGatewayConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDDeploymentGatewayConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDFileTypeAssociation?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDFileTypeAssociation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDLicenseConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDLicenseConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDPersonalSessionDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDPersonalVirtualDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDPersonalVirtualDesktopPatchSchedule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDRemoteApp?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDRemoteApp.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDRemoteDesktop?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDRemoteDesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDSessionCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDSessionCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDSessionCollectionConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDSessionCollectionConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDSessionHost?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDSessionHost.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDUserSession?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDUserSession.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktop?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopCollectionConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopCollectionConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopCollectionJobStatus?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopCollectionJobStatus.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopConcurrency?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopConcurrency.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopIdleCount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopIdleCount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDVirtualDesktopTemplateExportPath?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDVirtualDesktopTemplateExportPath.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Get-RDWorkspace?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Get-RDWorkspace.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Grant-RDOUAccess?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Grant-RDOUAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Import-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Import-RDPersonalSessionDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Import-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Import-RDPersonalVirtualDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Invoke-RDUserLogoff?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Invoke-RDUserLogoff.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Move-RDVirtualDesktop?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Move-RDVirtualDesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDCertificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDPersonalVirtualDesktopPatchSchedule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDRemoteApp?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDRemoteApp.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDSessionCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDSessionCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDSessionDeployment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDSessionDeployment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDVirtualDesktopCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDVirtualDesktopCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/New-RDVirtualDesktopDeployment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/New-RDVirtualDesktopDeployment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/RDMgmt?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/RemoteDesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDDatabaseConnectionString?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDDatabaseConnectionString.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDPersonalSessionDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDPersonalVirtualDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDPersonalVirtualDesktopPatchSchedule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDRemoteApp?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDRemoteApp.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDSessionCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDSessionCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDSessionHost?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDSessionHost.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDVirtualDesktopCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDVirtualDesktopCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Remove-RDVirtualDesktopFromCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Remove-RDVirtualDesktopFromCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Send-RDUserMessage?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Send-RDUserMessage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDActiveManagementServer?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDActiveManagementServer.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDCertificate?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDClientAccessName?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDClientAccessName.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDConnectionBrokerHighAvailability?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDConnectionBrokerHighAvailability.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDDatabaseConnectionString?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDDatabaseConnectionString.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDDeploymentGatewayConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDDeploymentGatewayConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDFileTypeAssociation?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDFileTypeAssociation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDLicenseConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDLicenseConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalSessionDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDPersonalSessionDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopAssignment?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDPersonalVirtualDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopPatchSchedule?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDPersonalVirtualDesktopPatchSchedule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteApp?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDRemoteApp.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteDesktop?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDRemoteDesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionCollectionConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDSessionCollectionConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionHost?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDSessionHost.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopCollectionConfiguration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopCollectionConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopConcurrency?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopConcurrency.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopIdleCount?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopIdleCount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopTemplateExportPath?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDVirtualDesktopTemplateExportPath.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDWorkspace?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Set-RDWorkspace.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Stop-RDVirtualDesktopCollectionJob?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Stop-RDVirtualDesktopCollectionJob.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Test-RDOUAccess?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Test-RDOUAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Test-RDVirtualDesktopADMachineAccountReuse?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Test-RDVirtualDesktopADMachineAccountReuse.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Update-RDVirtualDesktopCollection?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/remotedesktop/Update-RDVirtualDesktopCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-KeyProtectorFromShieldingDataFile?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Get-KeyProtectorFromShieldingDataFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-ShieldedVMProvisioningStatus?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Get-ShieldedVMProvisioningStatus.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Initialize-ShieldedVM?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Initialize-ShieldedVM.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/New-ShieldedVMSpecializationDataFile?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/New-ShieldedVMSpecializationDataFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/ShieldedVmCmdlets?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/ShieldedVMProvisioning.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Test-ShieldingDataApplicability?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/shieldedvmprovisioning/Test-ShieldingDataApplicability.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/windowsdevlic/Get-WindowsDeveloperLicense.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense?view=windowsserver2019-ps", + "source_path": "docset/winserver2019-ps/windowsdevlic/WindowsDevLic.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/Export-PfxCertificate?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/pkiclient/Export-PfxCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/pki.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/pkiclient/PKIClient.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/pki/New-SelfSignedCertificate?view=winserver2022-ps", + "source_path": "docset/winserver2022-ps/pkiclient/New-SelfSignedCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDDeploymentGatewayConfiguration.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDDeploymentGatewayConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDFileTypeAssociation.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDFileTypeAssociation.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDLicenseConfiguration.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDLicenseConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalSessionDesktopAssignment.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDPersonalSessionDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopAssignment.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDPersonalVirtualDesktopAssignment.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDPersonalVirtualDesktopPatchSchedule.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDPersonalVirtualDesktopPatchSchedule.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteApp.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDRemoteApp.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDRemoteDesktop.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDRemoteDesktop.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionCollectionConfiguration.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDSessionCollectionConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDSessionHost.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDSessionHost.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopCollectionConfiguration.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopCollectionConfiguration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopConcurrency.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopConcurrency.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopIdleCount.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopIdleCount.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDVirtualDesktopTemplateExportPath.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDVirtualDesktopTemplateExportPath.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Set-RDWorkspace.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Set-RDWorkspace.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Stop-RDVirtualDesktopCollectionJob.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Stop-RDVirtualDesktopCollectionJob.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Test-RDOUAccess.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Test-RDOUAccess.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Test-RDVirtualDesktopADMachineAccountReuse.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Test-RDVirtualDesktopADMachineAccountReuse.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/rdmgmt/Update-RDVirtualDesktopCollection.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/remotedesktop/Update-RDVirtualDesktopCollection.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-KeyProtectorFromShieldingDataFile.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Get-KeyProtectorFromShieldingDataFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Get-ShieldedVMProvisioningStatus.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Get-ShieldedVMProvisioningStatus.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Initialize-ShieldedVM.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Initialize-ShieldedVM.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/New-ShieldedVMSpecializationDataFile.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/New-ShieldedVMSpecializationDataFile.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/ShieldedVmCmdlets.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/ShieldedVMProvisioning.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/shieldedvmcmdlets/Test-ShieldingDataApplicability.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/shieldedvmprovisioning/Test-ShieldingDataApplicability.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Get-WindowsDeveloperLicense.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/windowsdevlic/Get-WindowsDeveloperLicense.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Show-WindowsDeveloperLicenseRegistration.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/windowsdevlic/Show-WindowsDeveloperLicenseRegistration.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/Unregister-WindowsDeveloperLicense.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/windowsdevlic/Unregister-WindowsDeveloperLicense.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsdeveloperlicense/WindowsDeveloperLicense.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/windowsdevlic/WindowsDevLic.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsupdate/Get-WindowsUpdateLog.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/WindowsUpdate/Get-WindowsUpdateLog.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/windowsupdate/WindowsUpdate.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/WindowsUpdate/WindowsUpdate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/eventtracingmanagement/Update-AutologgerConfig.md?view=windowsserver2022-ps", + "source_path": "docset/winserver2022-ps/EventTracingManagement/Set-AutologgerConfig.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Export-ProvisioningPackage.md", + "source_path": "docset/winserver2016-ps/provisioning/Export-ProvisioningPackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Export-Trace.md", + "source_path": "docset/winserver2016-ps/provisioning/Export-Trace.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Get-ProvisioningPackage.md", + "source_path": "docset/winserver2016-ps/provisioning/Get-ProvisioningPackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Get-TrustedProvisioningCertificate.md", + "source_path": "docset/winserver2016-ps/provisioning/Get-TrustedProvisioningCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Install-ProvisioningPackage.md", + "source_path": "docset/winserver2016-ps/provisioning/Install-ProvisioningPackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Install-TrustedProvisioningCertificate.md", + "source_path": "docset/winserver2016-ps/provisioning/Install-TrustedProvisioningCertificate.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Provisioning.md", + "source_path": "docset/winserver2016-ps/provisioning/Provisioning.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Uninstall-ProvisioningPackage.md", + "source_path": "docset/winserver2016-ps/provisioning/Uninstall-ProvisioningPackage.md" + }, + { + "redirect_document_id": false, + "redirect_url": "/powershell/module/provisioning/Uninstall-TrustedProvisioningCertificate.md", + "source_path": "docset/winserver2016-ps/provisioning/Uninstall-TrustedProvisioningCertificate.md" + } + ] +} \ No newline at end of file diff --git a/docset/bread/toc.yml b/docset/bread/toc.yml index aae6fcabde..75abe4c288 100644 --- a/docset/bread/toc.yml +++ b/docset/bread/toc.yml @@ -10,10 +10,6 @@ tocHref: /powershell/windows/ topicHref: /powershell/windows/get-started items: - - name: MDOP PowerShell - tocHref: /powershell/mdop/ - topicHref: /powershell/mdop/get-started - name: PowerShell tocHref: /powershell/module/ topicHref: /powershell/module - \ No newline at end of file diff --git a/docset/docfx.json b/docset/docfx.json index 051beeffd1..25e8caa6a8 100644 --- a/docset/docfx.json +++ b/docset/docfx.json @@ -1,174 +1,119 @@ { "build": { "content": [ - { "dest": "windows/bread", "files": [ "toc.yml" ], "src": "bread" }, + { "dest": "windows/bread", "files": [ "toc.yml" ], "src": "bread" }, - { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps" }, - { "dest": "winserver2025-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps" }, - { "dest": "module/WindowsServer2025-ps", "files": [ "toc.yml" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps" }, + { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps" }, + { "dest": "winserver2025-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2025-ps", "version": "WindowsServer2025-ps" }, + { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps" }, + { "dest": "module/WindowsServer2025-ps", "files": [ "toc.yml" ], "src": "winserver2025-ps", "version": "WindowsServer2025-ps" }, - { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps" }, - { "dest": "winserver2022-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2022-ps", "version": "WindowsServer2022-ps" }, - { "dest": "module/WindowsServer2022-ps", "files": [ "toc.yml" ], "src": "winserver2022-ps", "version": "WindowsServer2022-ps" }, + { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps" }, + { "dest": "winserver2022-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2022-ps", "version": "WindowsServer2022-ps" }, + { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2022-ps", "version": "WindowsServer2022-ps" }, + { "dest": "module/WindowsServer2022-ps", "files": [ "toc.yml" ], "src": "winserver2022-ps", "version": "WindowsServer2022-ps" }, - { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2019-ps", "version": "WindowsServer2019-ps" }, - { "dest": "winserver2019-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2019-ps", "version": "WindowsServer2019-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2019-ps", "version": "WindowsServer2019-ps" }, - { "dest": "module/WindowsServer2019-ps", "files": [ "toc.yml" ], "src": "winserver2019-ps", "version": "WindowsServer2019-ps" }, + { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2019-ps", "version": "WindowsServer2019-ps" }, + { "dest": "winserver2019-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2019-ps", "version": "WindowsServer2019-ps" }, + { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2019-ps", "version": "WindowsServer2019-ps" }, + { "dest": "module/WindowsServer2019-ps", "files": [ "toc.yml" ], "src": "winserver2019-ps", "version": "WindowsServer2019-ps" }, - { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2016-ps", "version": "WindowsServer2016-ps" }, - { "dest": "windows", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2016-ps", "version": "WindowsServer2016-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2016-ps", "version": "WindowsServer2016-ps" }, - { "dest": "module/WindowsServer2016-ps", "files": [ "toc.yml" ], "src": "winserver2016-ps", "version": "WindowsServer2016-ps" }, + { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2016-ps", "version": "WindowsServer2016-ps" }, + { "dest": "windows", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2016-ps", "version": "WindowsServer2016-ps" }, + { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2016-ps", "version": "WindowsServer2016-ps" }, + { "dest": "module/WindowsServer2016-ps", "files": [ "toc.yml" ], "src": "winserver2016-ps", "version": "WindowsServer2016-ps" }, - { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2012-ps", "version": "winserver2012-ps" }, - { "dest": "winserver2012-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2012-ps", "version": "winserver2012-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2012-ps", "version": "winserver2012-ps" }, - { "dest": "module/winserver2012-ps", "files": [ "toc.yml" ], "src": "winserver2012-ps", "version": "winserver2012-ps" }, - - { "dest": "windows", "files": [ "**/*.md" ], "src": "docs-conceptual/winserver2012r2-ps", "version": "winserver2012r2-ps" }, - { "dest": "winserver2012r2-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/winserver2012r2-ps", "version": "winserver2012r2-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml", "**/About/*.md" ], "src": "winserver2012r2-ps", "version": "winserver2012r2-ps" }, - { "dest": "module/winserver2012r2-ps", "files": [ "toc.yml" ], "src": "winserver2012r2-ps", "version": "winserver2012r2-ps" }, - - { "dest": "mdop", "files": [ "**/*.md" ], "src": "docs-conceptual/mdop", "version": "win-mdop2-ps" }, - { "dest": "mdop/win-mdop2-ps", "files": [ "toc.yml" ], "src": "docs-conceptual/mdop", "version": "win-mdop2-ps" }, - { "dest": "module", "exclude": [ "toc.yml" ], "files": [ "**/*.yml" ], "src": "mdop", "version": "win-mdop2-ps" }, - { "dest": "module/win-mdop2-ps", "files": [ "toc.yml" ], "src": "mdop", "version": "win-mdop2-ps" }, - - { "dest": "module", "files": [ "**/*.md" ], "src": "virtual-directory-module" } + { "dest": "module", "files": [ "**/*.md" ], "src": "virtual-directory-module" } ], "resource": [ - { "files": [ "**/*.png", "**/*.jpg" ], "exclude": [ "**/obj/**", "**/includes/**" ] } + { "files": [ "**/*.png", "**/*.jpg" ], "exclude": [ "**/obj/**", "**/includes/**" ] } ], "versions": { - "WindowsServer2025-ps": { - "dest": "winserver2025-ps" - }, - "WindowsServer2022-ps": { - "dest": "winserver2022-ps" - }, - "WindowsServer2019-ps": { - "dest": "winserver2019-ps" - }, - "WindowsServer2016-ps": { - "dest": "winserver2016-ps" - }, - "winserver2012r2-ps": { - "dest": "winserver2012r2-ps" - }, - "winserver2012-ps": { - "dest": "winserver2012-ps" - }, - "win-mdop2-ps": { - "dest": "win-mdop2-ps" - } + "WindowsServer2025-ps": { "dest": "winserver2025-ps" }, + "WindowsServer2022-ps": { "dest": "winserver2022-ps" }, + "WindowsServer2019-ps": { "dest": "winserver2019-ps" }, + "WindowsServer2016-ps": { "dest": "winserver2016-ps" } }, "overwrite": [], "externalReference": [], "globalMetadata": { - "uhfHeaderId": "MSDocsHeader-M365-IT", - "ms.devlang": "powershell", - "apiPlatform": "powershell", - "ROBOTS": "INDEX, FOLLOW", - "breadcrumb_path": "/powershell/windows/bread/toc.json", - "ms.service": "windows-11", - "ms.topic": "reference", - "ms.author": "jgerend", - "author": "JasonGerend", - "manager": "femila", - "feedback_system": "Standard", - "feedback_product_url": "https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332", - "contributors_to_exclude": [ - "rjagiewich", - "traya1", - "rmca14", - "claydetels19", - "jborsecnik", - "tiburd", - "garycentric", - "AngelaMotherofDragons", - "dstrome", - "v-dihans", - "sdwheeler", - "v-stchambers", - "shdyas", - "Stacyrch140", - "v-stsavell", - "American-Dipper", - "Ruchika-mittal01", - "aditisrivastava07", - "padmagit77" - ], - "_op_documentIdPathDepotMapping": { - "./": { - "depot_name": "MSDN.powershell-windows" - } - } + "ROBOTS": "INDEX, FOLLOW", + "_op_documentIdPathDepotMapping": { + "./": { + "depot_name": "MSDN.powershell-windows" + } + }, + "apiPlatform": "powershell", + "archive_url": "https://learn.microsoft.com/previous-versions/powershell/windows", + "author": "robinharwood", + "breadcrumb_path": "/powershell/windows/bread/toc.json", + "contributors_to_exclude": [ + "aditisrivastava07", + "American-Dipper", + "AngelaMotherofDragons", + "claydetels19", + "dstrome", + "garycentric", + "jborsecnik", + "padmagit77", + "rjagiewich", + "rmca14", + "Ruchika-mittal01", + "sdwheeler", + "shdyas", + "Stacyrch140", + "tiburd", + "traya1", + "v-dihans", + "v-stchambers", + "v-stsavell" + ], + "feedback_product_url": "https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332", + "feedback_system": "Standard", + "manager": "femila", + "ms.author": "jgerend", + "ms.devlang": "powershell", + "ms.service": "windows-11", + "ms.topic": "reference", + "uhfHeaderId": "MSDocsHeader-M365-IT" }, "fileMetadata": { - "products": { - "mdop/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/211bc889-ad71-4c77-b1cd-8ea0d02263f9" - ], - "mdop/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/211bc889-ad71-4c77-b1cd-8ea0d02263f9" - ], - "winserver2025-ps/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" - ], - "winserver2025-ps/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" - ], - "winserver2022-ps/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" - ], - "winserver2022-ps/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" - ], - "winserver2019-ps/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/46091ca5-09b4-466c-9539-c4f93b01a036" - ], - "winserver2019-ps/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/46091ca5-09b4-466c-9539-c4f93b01a036" - ], - "winserver2016-ps/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/ba9cbf34-2075-4eb6-8fe8-8a65dc77b667", - "https://authoring-docs-microsoft.poolparty.biz/devrel/bcbcbad5-4208-4783-8035-8481272c98b8" - ], - "winserver2016-ps/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/ba9cbf34-2075-4eb6-8fe8-8a65dc77b667", - "https://authoring-docs-microsoft.poolparty.biz/devrel/bcbcbad5-4208-4783-8035-8481272c98b8" - ], - "winserver2012-ps/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/e27ad519-5489-476b-be3f-292774021345" - ], - "winserver2012-ps/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/e27ad519-5489-476b-be3f-292774021345" - ], - "winserver2012r2-ps/**/*.md": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/e27ad519-5489-476b-be3f-292774021345" - ], - "winserver2012r2-ps/**/*.yml": [ - "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", - "https://authoring-docs-microsoft.poolparty.biz/devrel/e27ad519-5489-476b-be3f-292774021345" - ] - } + "products": { + "winserver2025-ps/**/*.md": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" + ], + "winserver2025-ps/**/*.yml": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" + ], + "winserver2022-ps/**/*.md": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" + ], + "winserver2022-ps/**/*.yml": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/56754133-c3c3-4a9f-af19-71bdbe19fccf" + ], + "winserver2019-ps/**/*.md": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/46091ca5-09b4-466c-9539-c4f93b01a036" + ], + "winserver2019-ps/**/*.yml": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/46091ca5-09b4-466c-9539-c4f93b01a036" + ], + "winserver2016-ps/**/*.md": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/ba9cbf34-2075-4eb6-8fe8-8a65dc77b667", + "https://authoring-docs-microsoft.poolparty.biz/devrel/bcbcbad5-4208-4783-8035-8481272c98b8" + ], + "winserver2016-ps/**/*.yml": [ + "https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8", + "https://authoring-docs-microsoft.poolparty.biz/devrel/ba9cbf34-2075-4eb6-8fe8-8a65dc77b667", + "https://authoring-docs-microsoft.poolparty.biz/devrel/bcbcbad5-4208-4783-8035-8481272c98b8" + ] + } }, "template": [], "dest": "powershell-windows" diff --git a/docset/docs-conceptual/mdop/get-started.md b/docset/docs-conceptual/mdop/get-started.md deleted file mode 100644 index ec24f1292d..0000000000 --- a/docset/docs-conceptual/mdop/get-started.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -ms.date: 12/05/2016 -ms.devlang: powershell -title: Microsoft Desktop Optimization Pack Automation with Windows PowerShell ---- - -# Microsoft Desktop Optimization Pack - -This topic lists the Windows PowerShell modules included with Microsoft Desktop Optimization Pack -(MDOP). The modules in the list support automating features of those components and provide links to -the cmdlet references for each module. These modules enable you to use cmdlets to administer, -maintain, configure, and develop new features for MDOP. - -## MDOP Automation with Windows PowerShell - -The table below shows the latest published version of the Help for each module. The Help is -available through the links below, or as Updateable Help files. Updateable -Help was introduced with Windows PowerShell 3.0 and enables you to have the latest Help topics -available locally on your computer by using the Update-Help cmdlet. For more information, see -[about_Updatable_Help](/powershell/module/microsoft.powershell.core/about/about_updatable_help). - -| Product | Latest product version | -| - | - | -| [Advanced Group Policy Management](/powershell/module/agpm) | 4.0 SP3 | -| [Microsoft Application Virtualization](/powershell/module/appv) | 5.1 | -| [Microsoft Bitlocker Administration and Monitoring](/powershell/module/mbam) | 2.5 | -| [User Experience Virtualization](/powershell/module/uev) | 2.1 SP1 | diff --git a/docset/docs-conceptual/mdop/toc.yml b/docset/docs-conceptual/mdop/toc.yml deleted file mode 100644 index 486f6d50a7..0000000000 --- a/docset/docs-conceptual/mdop/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: MDOP PowerShell - href: get-started.md diff --git a/docset/docs-conceptual/winserver2012-ps/get-started.md b/docset/docs-conceptual/winserver2012-ps/get-started.md deleted file mode 100644 index 486694e4f1..0000000000 --- a/docset/docs-conceptual/winserver2012-ps/get-started.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -description: Use this topic to help manage Windows 8 and Windows Server 2012 technologies with Windows PowerShell. -ms.date: 03/29/2021 -title: Windows 8 and Windows Server 2012 ---- - -# Windows Server 2012 and Windows 8 - -This topic lists the Windows PowerShell modules included with Windows Server 2012 and Windows 8. The -Windows PowerShell modules in the list support automating the features of those operating systems -and provide links to the cmdlet references for each module. These modules enable you to use Windows -PowerShell to administer, maintain, configure, and develop new features for Windows Server 2012 and -Windows 8. - -For information about the core features common to all versions of Windows PowerShell, see -[Windows PowerShell Core](/powershell/scripting). - -The table below also shows the latest published version of the Help for each module. The Help is -available through the links below, or as Updatable Help files. Updatable Help was introduced with -Windows PowerShell 3.0 and enables you to have the latest Help topics available locally on your -computer. See -[about_Updatable_Help](/powershell/module/microsoft.powershell.core/about/about_updatable_help) for -more information. - -## Windows PowerShell features - -| Module Name (sorted by) | Title and link to Web version | -| - | - | -| ActiveDirectory | [AD DS Administration Cmdlets](/powershell/module/activedirectory) | -| ADCSAdministration | [AD CS Administration Cmdlets](/powershell/module/adcsadministration) | -| ADCSDeployment | [AD CS Deployment Cmdlets](/powershell/module/adcsdeployment) | -| ADDSDeployment | [AD DS Deployment Cmdlets](/powershell/module/addsdeployment) | -| ADFS | [AD FS Cmdlets](/powershell/module/adfs) | -| ADRMS |[AD RMS Deployment Cmdlets](/powershell/module/adrms) | -| ADRMSAdmin | [AD RMS Administration Cmdlets](/powershell/module/adrmsadmin) | -| Applocker | [AppLocker Cmdlets](/powershell/module/applocker) | -| AppX | [App Installation Cmdlets](/powershell/module/appx) | -| BestPractices | [Best Practices Analyzer Cmdlets](/powershell/module/bestpractices) | -| BitLocker | [BitLocker Cmdlets](/powershell/module/bitlocker) | -| BranchCache | [BranchCache Cmdlets](/powershell/module/branchcache) | -| ClusterAwareUpdating | [Cluster-Aware Updating Cmdlets](/powershell/module/clusterawareupdating) | -| DcbQoS | [Data Center Bridging (DCB) Quality of Service (QoS) Cmdlets](/powershell/module/dcbqos) | -| Deduplication | [Deduplication Cmdlets](/powershell/module/deduplication) | -| DFSN | [DFSN Cmdlets](/powershell/module/dfsn) | -| DhcpServer | [DHCP Cmdlets](/powershell/module/dfsr) | -| DirectAccessClientComponents | [DirectAccess Client Cmdlets](/powershell/module/directaccessclientcomponents) | -| Dism | [DISM Cmdlets](/powershell/module/dism) | -| DnsClient | [DNS Client Cmdlets](/powershell/module/dnsclient) | -| DnsServer | [DNS Server Cmdlets](/powershell/module/dnsserver) | -| FailoverClusters | [Failover Clusters Cmdlets](/powershell/module/failoverclusters) | -| FileServerResourceManager | [FSRM Cmdlets](/powershell/module/fileserverresourcemanager) | -| GroupPolicy | [Group Policy Cmdlets](/powershell/module/grouppolicy) | -| Hyper-V | [Hyper-V Cmdlets](/powershell/module/hyper-v) | -| International | [International Settings Cmdlets](/powershell/module/international) | -| IpamServer | [IPAM Cmdlets](/powershell/module/ipamserver) | -| iScsi | [iSCSI Cmdlets](/powershell/module/iscsi) | -| iScsiTarget | [iSCSI Target Cmdlets](/powershell/module/iscsitarget) | -| KDS | [KDS Cmdlets](/powershell/module/kds) | -| MMAgent | [Memory Management Agent (MMAgent) Cmdlets](/powershell/module/mmagent) | -| Mpio | [MultiPath I/O (MPIO) Cmdlets](/powershell/module/mpio) | -| MsDtc | [Distributed Transaction Coordinator (MSDTC) Cmdlets](/powershell/module/msdtc) | -| MSOnlineBackup | [Windows Azure Backup Cmdlets](/powershell/module/msonlinebackup) | -| MsMq | [MSMQ Cmdlets](/powershell/module/msmq) | -| NetAdapter | [Network Adapter Cmdlets](/powershell/module/netadapter) | -| NetConnection | [Network Connection Profile Cmdlets](/powershell/module/netconnection) | -| NetLBFO | [NIC Teaming (NetLBFO) Cmdlets](/powershell/module/netlbfo) | -| NetQoS | [Network Quality of Service (QoS) Cmdlets](/powershell/module/netqos) | -| NetSecurity | [Network Security Cmdlets](/powershell/module/netsecurity) | -| NetSwitchTeam | [Network Switch Team Cmdlets](/powershell/module/netswitchteam) | -| NetTcpip | [Net TCP/IP Cmdlets](/powershell/module/nettcpip) | -| NetWnv | [NetWNV Cmdlets](/powershell/module/netwnv) | -| NetworkConnectivity | [Network Connectivity Status Cmdlets](/powershell/module/networkconnectivity) | -| NetworkLoadBalancingClusters | [Network Load Balancing Cmdlets](/powershell/module/networkloadbalancingclusters) | -| NetworkTransition | [Network Transition Cmdlets](/powershell/module/networktransition) | -| NFS | [NFS Cmdlets](/powershell/module/nfs) | -| NPS | [NPS Cmdlets](/powershell/module/nps) | -| PKI | [PKI Client Cmdlets](/powershell/module/pki) | -| PrintManagement | [Print Management Cmdlets](/powershell/module/printmanagement) | -| RemoteAccess | [Remote Access Cmdlets](/powershell/module/remoteaccess) | -| RemoteDesktop | [Remote Desktop Cmdlets](/powershell/module/remotedesktop) | -| ScheduledTasks | [Scheduled Tasks Cmdlets](/powershell/module/scheduledtasks) | -| SecureBoot | [Secure Boot Cmdlets](/powershell/module/secureboot) | -| ServerCore | [Server Core Cmdlets](/powershell/module/servercore) | -| ServerManager | [Server Manager Cmdlets](/powershell/module/servermanager) | -| ServerManagerTasks | [Server Manager Tasks Cmdlets](/powershell/module/servermanagertasks) | -| ServerMig_Cmdlets | [Server Migration Cmdlets](/powershell/module/servermigrationcmdlets) | -| SMBShare | [SMB Share Cmdlets](/powershell/module/smbshare) | -| SMBWitness | [SMB Witness Cmdlets](/powershell/module/smbwitness) | -| SMISConfig | [SMI-S Cmdlets](/powershell/module/smisconfig) | -| Storage | [Storage Cmdlets](/powershell/module/storage) | -| TroubleshootingPack | [Troubleshooting Pack (TP) Cmdlets](/powershell/module/troubleshootingpack) | -| TrustedPlatformModule | [Trusted Platform Module (TPM) Cmdlets](/powershell/module/trustedplatformmodule) | -| UpdateServices | [Windows Server Update Services (WSUS) Cmdlets](/powershell/module/updateservices) | -| UserAccessLogging | [User Access Logging (UAL) Cmdlets](/powershell/module/useraccesslogging) | -| VAMT | [VAMT Cmdlets](/powershell/module/vamt) | -| VPNClient | [VPN Client Cmdlets](/powershell/module/vpnclient) | -| WDAC | [Windows Data Access Components (WDAC) Cmdlets](/powershell/module/wdac) | -| WebAdministration | [Web Server (IIS) Administration Cmdlets](/powershell/module/webadministration) | -| WHEA | [WHEA Cmdlets](/powershell/module/whea) | -| WasPSExt | [Windows Assessment Services Cmdlets](/powershell/module/waspsext) | -| WindowsDeveloperLicense | [Windows Developer License Cmdlets](/powershell/module/windowsdeveloperlicense) | -| WindowsErrorReporting | [Windows Error Reporting Cmdlets](/powershell/module/windowserrorreporting) | -| WindowsServerBackup | [Windows Server Backup Cmdlets](/powershell/module/windowsserverbackup) | -| WSSCmdlets | [Windows Server Backup Cmdlets](/powershell/module/wsscmdlets) | - -You can also find these modules by searching the [PowerShell Module Browser](/powershell/module/). diff --git a/docset/docs-conceptual/winserver2012-ps/toc.yml b/docset/docs-conceptual/winserver2012-ps/toc.yml deleted file mode 100644 index 15a4d18253..0000000000 --- a/docset/docs-conceptual/winserver2012-ps/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Windows PowerShell - href: get-started.md diff --git a/docset/docs-conceptual/winserver2012r2-ps/get-started.md b/docset/docs-conceptual/winserver2012r2-ps/get-started.md deleted file mode 100644 index 1e5fc3d177..0000000000 --- a/docset/docs-conceptual/winserver2012r2-ps/get-started.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -description: Use this topic to help manage Windows 8.1 and Windows Server 21012 R2 technologies with Windows PowerShell. -ms.date: 03/29/2021 -title: Windows 8.1 and Windows Server 2012 R2 ---- - -# Windows Server 2012 R2 and Windows 8.1 - -This topic lists the Windows PowerShell® modules included with Windows Server 2012 R2 and -Windows 8.1. The Windows PowerShell modules in the list support automating the features of those -operating systems and provide links to the cmdlet references for each module. These modules enable -you to use Windows PowerShell to administer, maintain, configure, and develop new features for and -Windows Server 2012 R2. - -The table below also shows the latest published version of the Help for each module. The Help is -available in the TechNet Library through the links below, or as Updatable Help files. Updatable Help -was introduced with Windows PowerShell 3.0 and enables you to have the latest Help topics available -locally on your computer. See -[about_Updatable_Help](/powershell/module/microsoft.powershell.core/about/about_updatable_help) -for more information. - -## Windows and Windows Server Automation with Windows PowerShell - -| Module Name (sorted by) | Title and link to Web version | -| - | - | -| ActiveDirectory | [AD DS Administration Cmdlets](/powershell/module/activedirectory) | -| ADCSAdministration | [AD CS Administration Cmdlets](/powershell/module/adcsadministration) | -| ADCSDeployment | [AD CS Deployment Cmdlets](/powershell/module/adcsdeployment) | -| ADDSDeployment | [AD DS Deployment Cmdlets](/powershell/module/addsdeployment) | -| ADFS | [AD FS Cmdlets](/powershell/module/adfs) | -| ADRMS |[AD RMS Deployment Cmdlets](/powershell/module/adrms) | -| ADRMSAdmin | [AD RMS Administration Cmdlets](/powershell/module/adrmsadmin) | -| Applocker | [AppLocker Cmdlets](/powershell/module/applocker) | -| AppX | [App Installation Cmdlets](/powershell/module/appx) | -| AssignedAccess | [Assigned Access Cmdlets](/powershell/module/assignedaccess) | -| BestPractices | [Best Practices Analyzer Cmdlets](/powershell/module/bestpractices) | -| BitLocker | [BitLocker Cmdlets](/powershell/module/bitlocker) | -| BitsTransfer | [Background Intelligent Transfer Service (BITS) Cmdlets](/powershell/module/bitstransfer) | -| BranchCache | [BranchCache Cmdlets](/powershell/module/branchcache) | -| ClusterAwareUpdating | [Cluster-Aware Updating Cmdlets](/powershell/module/clusterawareupdating) | -| DcbQoS | [Data Center Bridging (DCB) Quality of Service (QoS) Cmdlets](/powershell/module/dcbqos) | -| Deduplication | [Deduplication Cmdlets](/powershell/module/deduplication) | -| DFSN | [DFSN Cmdlets](/powershell/module/dfsn) | -| Dfsr | [Distributed File System (DFS) Replication Cmdlets](/powershell/module/dfsn) | -| DhcpServer | [DHCP Server Cmdlets](/powershell/module/dhcpserver) | -| DirectAccessClientComponents | [DirectAccess Client Cmdlets](/powershell/module/directaccessclientcomponents/) | -| Dism | [DISM Cmdlets](/powershell/module/dism) | -| DnsClient | [DNS Client Cmdlets](/powershell/module/dnsclient) | -| DnsServer | [DNS Server Cmdlets](/powershell/module/dnsserver) | -| FailoverClusters | [Failover Clusters Cmdlets](/powershell/module/failoverclusters) | -| FileServerResourceManager | [FSRM Cmdlets](/powershell/module/fileserverresourcemanager) | -| GroupPolicy | [Group Policy Cmdlets](/powershell/module/grouppolicy) | -| HCS | [High Performance Computing Pack](/powershell/module/hpc) | -| HPC | [StorSimple Hybrid Cloud Storage (HCS) Cmdlets](/powershell/module/hcs) | -| Hyper-V | [Hyper-V Cmdlets](/powershell/module/hyper-v) | -| International | [International Settings Cmdlets](/powershell/module/international) | -| IpamServer | [IPAM Cmdlets](/powershell/module/ipamserver) | -| iScsi | [iSCSI Cmdlets](/powershell/module/iscsi) | -| iScsiTarget | [iSCSI Target Cmdlets](/powershell/module/iscsitarget) | -| KDS | [KDS Cmdlets](/powershell/module/kds) | -| MMAgent | [Memory Management Agent (MMAgent) Cmdlets](/powershell/module/mmagent) | -| Mpio | [MultiPath I/O (MPIO) Cmdlets](/powershell/module/mpio) | -| MsDtc | [Distributed Transaction Coordinator (MSDTC) Cmdlets](/powershell/module/msdtc) | -| NetAdapter | [Network Adapter Cmdlets](/powershell/module/netadapter) | -| NetConnection | [Network Connection Profile Cmdlets](/powershell/module/netconnection) | -| NetEventPacketCapture | [Network Event Packet Capture Cmdlets](/powershell/module/neteventpacketcapture) | -| NetLBFO | [NIC Teaming (NetLBFO) Cmdlets](/powershell/module/netlbfo) | -| NetNat | [Network Address Translation (NAT) Cmdlets](/powershell/module/netnat) | -| NetQoS | [Network Quality of Service (QoS) Cmdlets](/powershell/module/netqos) | -| NetSecurity | [Network Security Cmdlets](/powershell/module/netsecurity) | -| NetSwitchTeam | [Network Switch Team Cmdlets](/powershell/module/netswitchteam) | -| NetTcpip | [Net TCP/IP Cmdlets](/powershell/module/nettcpip) | -| NetWnv | [NetWNV Cmdlets](/powershell/module/netwnv) | -| NetworkConnectivity | [Network Connectivity Status Cmdlets](/powershell/module/networkconnectivity) | -| NetworkLoadBalancingClusters | [Network Load Balancing Cmdlets](/powershell/module/networkloadbalancingclusters) | -| NetworkTransition | [Network Transition Cmdlets](/powershell/module/networktransition) | -| NFS | [NFS Cmdlets](/powershell/module/nfs) | -| NPS | [NPS Cmdlets](/powershell/module/nps) | -| PcsvDevice | [Physical Computer System View (PSCV) Cmdlets](/powershell/module/pcsvdevice) | -| PEF | [Message Analyzer Cmdlets](/powershell/module/pef) | -| PKI | [PKI Client Cmdlets](/powershell/module/pki) | -| PowerShellWebAccess | [Windows PowerShell Web Access Cmdlets](/powershell/module/powershellwebaccess) | -| PrintManagement | [Print Management Cmdlets](/powershell/module/printmanagement) | -| RemoteAccess | [Remote Access Cmdlets](/powershell/module/remoteaccess) | -| RemoteDesktop | [Remote Desktop Cmdlets](/powershell/module/remotedesktop) | -| RemoteDesktopServices | [Remote Desktop Services Cmdlets](/powershell/module/remotedesktopservices) | -| ScheduledTasks | [Scheduled Tasks Cmdlets](/powershell/module/scheduledtasks) | -| SecureBoot | [Secure Boot Cmdlets](/powershell/module/secureboot) | -| ServerCore | [Server Core Cmdlets](/powershell/module/servercore) | -| ServerManager | [Server Manager Cmdlets](/powershell/module/servermanager) | -| ServerManagerTasks | [Server Manager Tasks Cmdlets](/powershell/module/servermanagertasks) | -| ServerMigration | [Server Migration Cmdlets](/powershell/module/servermigration) | -| SMBShare | [SMB Share Cmdlets](/powershell/module/smbshare) | -| SMBWitness | [SMB Witness Cmdlets](/powershell/module/smbwitness) | -| SMISConfig | [SMI-S Cmdlets](/powershell/module/smisconfig) | -| SoftwareInventoryLogging | [Software Inventory Logging Cmdlets](/powershell/module/softwareinventorylogging) | -| StartScreen | [Start Screen Configuration Cmdlets](/powershell/module/startscreen) | -| Storage | [Storage Cmdlets](/powershell/module/storage) | -| StorageSpaces | [Storage Spaces Cmdlets](/powershell/module/storagespaces) | -| SyncShare | [Sync Share Cmdlets](/powershell/module/syncshare) | -| TLS | [Transport Layer Security (TLS) Authentication Cmdlets](/powershell/module/tls) | -| TroubleshootingPack | [Troubleshooting Pack (TP) Cmdlets](/powershell/module/troubleshootingpack) | -| TrustedPlatformModule | [Trusted Platform Module (TPM) Cmdlets](/powershell/module/trustedplatformmodule) | -| UpdateServices | [Windows Server Update Services (WSUS) Cmdlets](/powershell/module/updateservices) | -| UserAccessLogging | [User Access Logging (UAL) Cmdlets](/powershell/module/useraccesslogging) | -| VPNClient | [VPN Client Cmdlets](/powershell/module/vpnclient) | -| WDAC | [Windows Data Access Components (WDAC) Cmdlets](/powershell/module/wdac) | -| Wds | [Windows Deployment Services Cmdlets](/powershell/module/wds) | -| WebAdministration | [Web Server (IIS) Administration Cmdlets](/powershell/module/webadministration) | -| WebApplicationProxy | [Web Application Proxy Cmdlets](/powershell/module/webapplicationproxy) | -| WHEA | [WHEA Cmdlets](/powershell/module/whea) | -| WasPSExt | [Windows Assessment Services Cmdlets](/powershell/module/waspsext) | -| WindowsDeveloperLicense | [Windows Developer License Cmdlets](/powershell/module/windowsdeveloperlicense) | -| WindowsErrorReporting | [Windows Error Reporting Cmdlets](/powershell/module/windowserrorreporting) | -| WindowsSearch | [Windows Search Cmdlets](/powershell/module/windowssearch) | -| WindowsServerBackup | [Windows Server Backup Cmdlets](/powershell/module/windowsserverbackup) | -| WSSCmdlets | [Windows Server Backup Cmdlets](/powershell/module/wsscmdlets) | -| WSSSetup | [Windows Server Essentials Setup Cmdlets](/powershell/module/wsssetup) | - -You can also find these modules by searching the [PowerShell Module Browser](/powershell/module/). diff --git a/docset/docs-conceptual/winserver2012r2-ps/toc.yml b/docset/docs-conceptual/winserver2012r2-ps/toc.yml deleted file mode 100644 index 15a4d18253..0000000000 --- a/docset/docs-conceptual/winserver2012r2-ps/toc.yml +++ /dev/null @@ -1,2 +0,0 @@ -- name: Windows PowerShell - href: get-started.md diff --git a/docset/mapping/monikerMapping.json b/docset/mapping/monikerMapping.json index b0884ce0d9..a1e9a14bfd 100644 --- a/docset/mapping/monikerMapping.json +++ b/docset/mapping/monikerMapping.json @@ -22,23 +22,5 @@ "conceptualTocUrl": "/powershell/winserver2016-ps/toc.json", "referenceTocUrl": "/powershell/module/WindowsServer2016-ps/toc.json", "packageRoot": "winserver2016-ps" - }, - "winserver2012r2-ps": { - "conceptualToc": "docs-conceptual/winserver2012r2-ps/toc.yml", - "conceptualTocUrl": "/powershell/winserver2012r2-ps/toc.json", - "referenceTocUrl": "/powershell/module/winserver2012r2-ps/toc.json", - "packageRoot": "winserver2012r2-ps" - }, - "winserver2012-ps": { - "conceptualToc": "docs-conceptual/winserver2012-ps/toc.yml", - "conceptualTocUrl": "/powershell/winserver2012-ps/toc.json", - "referenceTocUrl": "/powershell/module/winserver2012-ps/toc.json", - "packageRoot": "winserver2012-ps" - }, - "win-mdop2-ps": { - "conceptualToc": "docs-conceptual/mdop/toc.yml", - "conceptualTocUrl": "/powershell/mdop/win-mdop2-ps/toc.json", - "referenceTocUrl": "/powershell/module/win-mdop2-ps/toc.json", - "packageRoot": "mdop" } } diff --git a/docset/mdop/agpm/add-controlledgpo.md b/docset/mdop/agpm/add-controlledgpo.md deleted file mode 100644 index 96f8d4bf91..0000000000 --- a/docset/mdop/agpm/add-controlledgpo.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Agpm.Client.Powershell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Add-ControlledGpo ---- - -# Add-ControlledGpo - -## SYNOPSIS -Adds GPOs to an AGPM archive. - -## SYNTAX - -``` -Add-ControlledGpo [-PassThru] [-Comment ] [[-Gpos] ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-ControlledGpo** cmdlet adds uncontrolled Group Policy Objects (GPOs) to an Advanced Group Policy Management (AGPM) archive. -That GPO becomes a controlled GPO. - -## EXAMPLES - -### Example 1: Add a GPO by using the pipeline operator -``` -PS C:\>Get-Gpo -Name "TSQA Group policies" | Add-ControlledGpo -PassThru -Name : TSQA Group policies -ID : {5507363B-6AEB-4EFF-89FD-1567CD1E14E5} -CheckoutID : -BackupID : {185339E4-54C1-441F-A53B-4510E93DA424} -State : CHECKED_IN -ComputerVersion : 2 -UserVersion : 2 -Deployed : -Changed : 11/25/2014 9:37:18 AM -ChangedBy : CONTOSO\Admin07 -WmiFilterName : -Comment : -``` - -This command uses the **Get-Gpo** cmdlet to get the uncontrolled GPO named TSQA Group policies. -For more information, type `Get-Help Get-Gpo`. -The command passes that GPO to the current cmdlet. -This cmdlet adds that GPO to the AGPM archive. - -### Example 2: Add a GPO by using a variable -``` -PS C:\>$GpoObject = Get-Gpo -Name "TSQA Group policies" -PS C:\> Add-ControlledGpo -Gpos $GpoObject -PassThru -Name : TSQA Group policies -ID : {5507363B-6AEB-4EFF-89FD-1567CD1E14E5} -CheckoutID : -BackupID : {70D90CA2-E396-4549-A2C9-18EED518F6F1} -State : CHECKED_IN -ComputerVersion : 2 -UserVersion : 2 -Deployed : -Changed : 11/25/2014 9:54:12 AM -ChangedBy : CONTOSO\Admin07 -WmiFilterName : -Comment : -``` - -The first command uses **Get-Gpo** to get the uncontrolled GPO named TSQA Group policies, and then stores that object in the $GpoObject variable. - -The second command adds the object stored in $GpoObject to the AGPM archive. - -## PARAMETERS - -### -Comment -Specifies a comment for the change that this cmdlet makes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Gpos -Specifies an array of GPOs to add to the AGPM archive. -To obtain GPOs, use the **Get-Gpo** cmdlet. -For more information, type `Get-Help Get-Gpo`. - -```yaml -Type: Gpo[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the controlled GPOs on which the cmdlet operates. -If you do not specify this parameter, this cmdlet returns no results. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -This cmdlet accepts GPO objects. - -## OUTPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet returns controlled GPO objects, if you specify the *PassThru* parameter. - -## NOTES - -## RELATED LINKS - -[Get-ControlledGpo](get-controlledgpo.md) - -[Lock-ControlledGpo](lock-controlledgpo.md) - -[Publish-ControlledGpo](publish-controlledgpo.md) - -[Remove-ControlledGpo](remove-controlledgpo.md) - -[Unlock-ControlledGpo](unlock-controlledgpo.md) - - diff --git a/docset/mdop/agpm/agpm.md b/docset/mdop/agpm/agpm.md deleted file mode 100644 index 8c495bccae..0000000000 --- a/docset/mdop/agpm/agpm.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=517622 -Help Version: 4.0.0.0 -Locale: en-US -Module Guid: CMDLETS -Module Name: AGPM -ms.date: 12/05/2016 -ms.devlang: powershell -title: AGPM ---- - -# AGPM Module -## Description -This reference provides cmdlet descriptions and syntax for the Advanced Group Policy Management (AGPM) cmdlets. - -## AGPM Cmdlets -### [Add-ControlledGpo](add-controlledgpo.md) -Adds GPOs to an AGPM archive. - -### [Get-ControlledGpo](get-controlledgpo.md) -Gets controlled GPOs for a domain. - -### [Lock-ControlledGpo](lock-controlledgpo.md) -Locks controlled GPOs. - -### [Publish-ControlledGpo](publish-controlledgpo.md) -Publishes controlled GPOs. - -### [Remove-ControlledGpo](remove-controlledgpo.md) -Removes controlled GPOs from the AGPM archive. - -### [Unlock-ControlledGpo](unlock-controlledgpo.md) -Unlocks controlled GPOs. - diff --git a/docset/mdop/agpm/get-controlledgpo.md b/docset/mdop/agpm/get-controlledgpo.md deleted file mode 100644 index 692cfe8bcf..0000000000 --- a/docset/mdop/agpm/get-controlledgpo.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Agpm.Client.Powershell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-ControlledGpo ---- - -# Get-ControlledGpo - -## SYNOPSIS -Gets controlled GPOs for a domain. - -## SYNTAX - -``` -Get-ControlledGpo [-Domain ] [] -``` - -## DESCRIPTION -The **Get-ControlledGpo** cmdlet gets the controlled Group Policy Objects (GPOs) from an Advanced Group Policy Management (AGPM) archive for a domain. -You can use this cmdlet to view state information for controlled GPOs. -Use the **Get-Gpo** cmdlet to view uncontrolled GPOs. -For more information, type `Get-Help Get-Gpo`. - -## EXAMPLES - -### Example 1: Get all GPOs and then filter results -``` -PS C:\>Get-ControlledGpo -Domain "TQSA.Contoso.com" | Where {$_.name -eq "TSQA Group policies"} -Name : TSQA Group policies -ID : {5507363B-6AEB-4EFF-89FD-1567CD1E14E5} -CheckoutID : -BackupID : {70D90CA2-E396-4549-A2C9-18EED518F6F1} -State : CHECKED_IN -ComputerVersion : 2 -UserVersion : 2 -Deployed : 11/25/2014 9:54:11 AM -Changed : 11/25/2014 9:54:12 AM -ChangedBy : CONTOSO\Admin07 -WmiFilterName : -Comment : -``` - -This command gets all controlled GPOs from the domain TQSA.Contoso.com, and then passes them to the **Where-Object** cmdlet. -That cmdlet returns the GPO from those results named TSQA Group policies. - -## PARAMETERS - -### -Domain -Specifies the fully qualified domain name (FQDN) of a domain. -This cmdlet gets GPOs in the domain that this parameter specifies. -If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer. - -If you do not specify a domain, this cmdlet uses the domain of the current user. - -If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet returns controlled GPO objects. - -## NOTES - -## RELATED LINKS - -[Add-ControlledGpo](./Add-ControlledGpo.md) - -[Lock-ControlledGpo](./Lock-ControlledGpo.md) - -[Publish-ControlledGpo](./Publish-ControlledGpo.md) - -[Remove-ControlledGpo](./Remove-ControlledGpo.md) - -[Unlock-ControlledGpo](./Unlock-ControlledGpo.md) - - diff --git a/docset/mdop/agpm/lock-controlledgpo.md b/docset/mdop/agpm/lock-controlledgpo.md deleted file mode 100644 index 4808197941..0000000000 --- a/docset/mdop/agpm/lock-controlledgpo.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Agpm.Client.Powershell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Lock-ControlledGpo ---- - -# Lock-ControlledGpo - -## SYNOPSIS -Locks controlled GPOs. - -## SYNTAX - -``` -Lock-ControlledGpo [[-ControlledGpos] ] [-Comment ] [-Domain ] - [-DiscardChanges] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Lock-ControlledGpo** cmdlet locks controlled Group Policy Objects (GPOs). -A locked GPO cannot be edited. -Locking is the equivalent of checking in a GPO to the Advanced Group Policy Management (AGPM) archive. -If you specify the *DiscardChanges* parameter, the cmdlet reverts any changes made to the GPO. -This operation is the same as undoing the checkout of a GPO. - -## EXAMPLES - -### Example 1: Lock all checked out GPOs -``` -PS C:\>Get-ControlledGpo | Where {$_.VaultState -eq "CHECKED_OUT"} | Lock-ControlledGpo -``` - -This command uses the **Get-ControlledGpo** cmdlet to get all controlled GPOs in the current domain. -The command passes those GPOs to the **Where-Object** cmdlet. -That cmdlet passes any GPOs that have a state of CHECKED_OUT to the current cmdlet. -This cmdlet locks all of those GPOs. - -### Example 2: Revert and lock all checked out GPOs -``` -PS C:\>Get-ControlledGpo | Where {$_.VaultState -eq "CHECKED_OUT"} | Lock-ControlledGpo -DiscardChanges -PassThru -Name : TSQA Group policies -ID : {5507363B-6AEB-4EFF-89FD-1567CD1E14E5} -CheckoutID : -BackupID : {70D90CA2-E396-4549-A2C9-18EED518F6F1} -State : CHECKED_IN -ComputerVersion : 2 -UserVersion : 2 -Deployed : 11/25/2014 9:54:11 AM -Changed : 11/25/2014 9:54:12 AM -ChangedBy : CONTOSO\Admin07 -WmiFilterName : -Comment : -``` - -This command discards changes and locks all GPOs that are currently checked out. -This example is the same as the previous example, except that it specifies the *DiscardChanges* parameter. -It also specifies the *PassThru* parameter to display the results. - -## PARAMETERS - -### -Comment -Specifies a comment for the change that this cmdlet makes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlledGpos -Specifies an array of GPOs to lock. -To obtain controlled GPOs, use the **Get-ControlledGpo** cmdlet. - -```yaml -Type: ControlledGpo[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -DiscardChanges -Indicates that this cmdlet discards any changes that have been made to the controlled GPO. -Discarding changes is the same as undoing a check out. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the fully qualified domain name (FQDN) of a domain. -This cmdlet operates on GPOs in the domain that this parameter specifies. -If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer. - -If you do not specify a domain, this cmdlet uses the domain of the current user. - -If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the controlled GPOs on which the cmdlet operates. -If you do not specify this parameter, this cmdlet returns no results. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet accepts controlled GPOs that are currently unlocked. - -## OUTPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet returns controlled GPO objects, if you specify the *PassThru* parameter. - -## NOTES - -## RELATED LINKS - -[Add-ControlledGpo](./Add-ControlledGpo.md) - -[Get-ControlledGpo](./Get-ControlledGpo.md) - -[Publish-ControlledGpo](./Publish-ControlledGpo.md) - -[Remove-ControlledGpo](./Remove-ControlledGpo.md) - -[Unlock-ControlledGpo](./Unlock-ControlledGpo.md) - - diff --git a/docset/mdop/agpm/publish-controlledgpo.md b/docset/mdop/agpm/publish-controlledgpo.md deleted file mode 100644 index 6ca2c978dd..0000000000 --- a/docset/mdop/agpm/publish-controlledgpo.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Agpm.Client.Powershell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Publish-ControlledGpo ---- - -# Publish-ControlledGpo - -## SYNOPSIS -Publishes controlled GPOs. - -## SYNTAX - -``` -Publish-ControlledGpo [[-ControlledGpos] ] [-Comment ] [-Domain ] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Publish-ControlledGpo** cmdlet publishes controlled Group Policy Objects (GPOs) that are checked in to the Advanced Group Policy Management (AGPM) archive into production. -This is the equivalent of deploying a controlled GPO to production. - -## EXAMPLES - -### Example 1: Publish checked in GPOs -``` -PS C:\>Get-ControlledGpo -Domain "TSQA.Contoso.com" | Where {$_.VaultState -eq "CHECKED_IN" } | Publish-ControlledGpo -PassThru -Name : TSQA Group policies -ID : {5507363B-6AEB-4EFF-89FD-1567CD1E14E5} -CheckoutID : -BackupID : {70D90CA2-E396-4549-A2C9-18EED518F6F1} -State : CHECKED_IN -ComputerVersion : 2 -UserVersion : 2 -Deployed : 11/25/2014 9:54:11 AM -Changed : 11/25/2014 9:54:12 AM -ChangedBy : CONTOSO\Admin07 -WmiFilterName : -Comment : -``` - -This command uses the **Get-ControlledGpo** cmdlet to get all controlled GPOs in the specified domain. -The command passes those GPOs to the **Where-Object** cmdlet. -That cmdlet passes any GPOs that have a state of CHECKED_IN to the current cmdlet. -This cmdlet publishes all of those GPOs. -If any of the GPOs changed, the changes become live at this time. - -## PARAMETERS - -### -Comment -Specifies a comment for the change that this cmdlet makes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlledGpos -Specifies an array of GPOs to publish. -To obtain controlled GPOs, use the **Get-ControlledGpo** cmdlet. - -```yaml -Type: ControlledGpo[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Domain -Specifies the fully qualified domain name (FQDN) of a domain. -This cmdlet operates on GPOs in the domain that this parameter specifies. -If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer. - -If you do not specify a domain, this cmdlet uses the domain of the current user. - -If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the controlled GPOs on which the cmdlet operates. -If you do not specify this parameter, this cmdlet returns no results. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Agpm.ControlledGpo - -## OUTPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet returns controlled GPO objects, if you specify the *PassThru* parameter. - -## NOTES - -## RELATED LINKS - -[Add-ControlledGpo](./Add-ControlledGpo.md) - -[Get-ControlledGpo](./Get-ControlledGpo.md) - -[Lock-ControlledGpo](./Lock-ControlledGpo.md) - -[Remove-ControlledGpo](./Remove-ControlledGpo.md) - -[Unlock-ControlledGpo](./Unlock-ControlledGpo.md) - - diff --git a/docset/mdop/agpm/remove-controlledgpo.md b/docset/mdop/agpm/remove-controlledgpo.md deleted file mode 100644 index c298c4b179..0000000000 --- a/docset/mdop/agpm/remove-controlledgpo.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Agpm.Client.Powershell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-ControlledGpo ---- - -# Remove-ControlledGpo - -## SYNOPSIS -Removes controlled GPOs from the AGPM archive. - -## SYNTAX - -``` -Remove-ControlledGpo [[-ControlledGpos] ] [-Comment ] [-Domain ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-ControlledGpo** cmdlet removes controlled Group Policy Objects (GPOs) from the Advanced Group Policy Management (AGPM) archive. -A removed GPO is no longer controlled. -This cmdlet does not delete the GPO. -To remove the GPO from the production environment, use the **Remove-Gpo** cmdlet. -For more information, type `Get-Help Remove-Gpo`. - -## EXAMPLES - -### Example 1: Remove a GPO -``` -PS C:\>Get-ControlledGpo -Domain "TSQA.Contoso.com" | Where {$_.Name -eq "test"} | Remove-ControlledGpo -``` - -This command uses the **Get-ControlledGpo** cmdlet to get all controlled GPOs in the specified domain. -The command passes those GPOs to the **Where-Object** cmdlet. -That cmdlet passes any GPOs named test to the current cmdlet. -This cmdlet removes that test GPO from the AGPM archive. - -## PARAMETERS - -### -Comment -Specifies a comment for the change that this cmdlet makes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlledGpos -Specifies an array of GPOs to remove. -To obtain controlled GPOs, use the **Get-ControlledGpo** cmdlet. - -```yaml -Type: ControlledGpo[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Domain -Specifies the fully qualified domain name (FQDN) of a domain. -This cmdlet operates on GPOs in the domain that this parameter specifies. -If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer. - -If you do not specify a domain, this cmdlet uses the domain of the current user. - -If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet accepts controlled GPOs. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-ControlledGpo](./Add-ControlledGpo.md) - -[Get-ControlledGpo](./Get-ControlledGpo.md) - -[Lock-ControlledGpo](./Lock-ControlledGpo.md) - -[Publish-ControlledGpo](./Publish-ControlledGpo.md) - -[Unlock-ControlledGpo](./Unlock-ControlledGpo.md) - - diff --git a/docset/mdop/agpm/unlock-controlledgpo.md b/docset/mdop/agpm/unlock-controlledgpo.md deleted file mode 100644 index 3ef1d40772..0000000000 --- a/docset/mdop/agpm/unlock-controlledgpo.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Agpm.Client.Powershell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Unlock-ControlledGpo ---- - -# Unlock-ControlledGpo - -## SYNOPSIS -Unlocks controlled GPOs. - -## SYNTAX - -``` -Unlock-ControlledGpo [[-ControlledGpos] ] [-Comment ] [-Domain ] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Unlock-ControlledGpo** cmdlet unlocks controlled Group Policy Objects (GPOs) in an Advanced Group Policy Management (AGPM) archive. -You can edit an unlocked GPO. -Unlocking a GPO is the equivalent of checking out a GPO. - -## EXAMPLES - -### Example 1: Unlock all locked GPOs -``` -PS C:\>Get-ControlledGpo | Where {$_.VaultState -eq "CHECKED_IN"} | Unlock-ControlledGpo -Comment "Unlock all GPOs" -``` - -This command uses the **Get-ControlledGpo** cmdlet to get all controlled GPOs in the current domain. -The command passes those GPOs to the **Where-Object** cmdlet. -That cmdlet passes any GPOs that have a state of CHECKED_IN to the current cmdlet. -This cmdlet unlocks all of those GPOs. -The cmdlet includes an explanatory comment. - -## PARAMETERS - -### -Comment -Specifies a comment for the change that this cmdlet makes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControlledGpos -Specifies an array of GPOs to unlock. -To obtain controlled GPOs, use the **Get-ControlledGpo** cmdlet. - -```yaml -Type: ControlledGpo[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Domain -Specifies the fully qualified domain name (FQDN) of a domain. -This cmdlet operates on GPOs in the domain that this parameter specifies. -If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer. - -If you do not specify a domain, this cmdlet uses the domain of the current user. - -If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Indicates that this cmdlet returns the controlled GPOs on which the cmdlet operates. -If you do not specify this parameter, this cmdlet returns no results. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet accepts controlled GPOs. - -## OUTPUTS - -### Microsoft.Agpm.ControlledGpo -This cmdlet returns controlled GPO objects, if you specify the *PassThru* parameter. - -## NOTES - -## RELATED LINKS - -[Add-ControlledGpo](./Add-ControlledGpo.md) - -[Get-ControlledGpo](./Get-ControlledGpo.md) - -[Lock-ControlledGpo](./Lock-ControlledGpo.md) - -[Publish-ControlledGpo](./Publish-ControlledGpo.md) - -[Remove-ControlledGpo](./Remove-ControlledGpo.md) - - diff --git a/docset/mdop/appv/Appv.md b/docset/mdop/appv/Appv.md deleted file mode 100644 index 34145a9ddb..0000000000 --- a/docset/mdop/appv/Appv.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=403113 -Help Version: 4.0.0.0 -Locale: en-US -Module Guid: 5 -Module Name: AppV -ms.date: 12/05/2016 -ms.devlang: powershell -title: AppV ---- - -# AppV Module -## Description -This reference provides cmdlet descriptions and syntax for all Application Virtualization (App-V) Package Converter cmdlets. - -## AppV Cmdlets -### [ConvertFrom-AppvLegacyPackage](./ConvertFrom-AppvLegacyPackage.md) -Converts App-V packages to the format for the current version of App-V. - -### [Test-AppvLegacyPackage](./Test-AppvLegacyPackage.md) -Validates App-V packages for conversion. - diff --git a/docset/mdop/appv/convertfrom-appvlegacypackage.md b/docset/mdop/appv/convertfrom-appvlegacypackage.md deleted file mode 100644 index 4fcaf254a3..0000000000 --- a/docset/mdop/appv/convertfrom-appvlegacypackage.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.LegacyPackages.Module.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: ConvertFrom-AppvLegacyPackage ---- - -# ConvertFrom-AppvLegacyPackage - -## SYNOPSIS -Converts App-V packages to the format for the current version of App-V. - -## SYNTAX - -``` -ConvertFrom-AppvLegacyPackage [-SourcePath] [-DestinationPath] - [-DownloadFullPackageOnFirstLaunch] [-OSDsToIncludeInPackage ] [] -``` - -## DESCRIPTION -The **ConvertFrom-AppvLegacyPackage** cmdlet converts Microsoft Application Virtualization (App-V) packages created by using an earlier version of App-V. -This cmdlet converts packages to the format that works with the current version of App-V. -The cmdlet returns all packages that it successfully converts, and it returns error or warning messages that it produces while it converts packages. - -## EXAMPLES - -### Example 1: Convert a package -``` -PS C:\>ConvertFrom-AppvLegacyPackage -SourcePath "C:\ContosoLegacyAppV" -DestinationPath "C:\ContosoAppV50" -``` - -This command converts a single App-V package in a previous format to the current App-V format. - -### Example 2: Convert all packages under a folder -``` -PS C:\>$Packages = ,$Null -PS C:\> Foreach($x in (Get-ChildItem -recurse)) { if($x.FullName.EndsWith("sprj")) { $Packages += $x.PSParentPath } } -PS C:\> ConvertFrom-AppvLegacyPackage -SourcePath $Packages -``` - -The first command creates an empty array named $Packages. - -The second command uses the **ForEach**Windows PowerShell® language command to check recursively for files that have an .sprj file name extension. -The command stores all the folders that contain .sprj files in the $Packages array. - -The final command converts each package stored in $Packages to the current App-V format. - -## PARAMETERS - -### -DestinationPath -Specifies the folder where this cmdlet stores the converted packages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: OutputPath - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DownloadFullPackageOnFirstLaunch -Indicates that you should fully download the converted package before you start it, instead of streaming it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: FullLoad - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OSDsToIncludeInPackage -Specifies an array of Open Software Descriptors (OSDs) that contain information that this cmdlet includes in the converted App-V package. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: OSDs - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourcePath -Specifies an array of folders for the App-V packages that this cmdlet converts. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path, PSPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Test-AppvLegacyPackage](./Test-AppvLegacyPackage.md) - - diff --git a/docset/mdop/appv/test-appvlegacypackage.md b/docset/mdop/appv/test-appvlegacypackage.md deleted file mode 100644 index 1e93c6e5c0..0000000000 --- a/docset/mdop/appv/test-appvlegacypackage.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.LegacyPackages.Module.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Test-AppvLegacyPackage ---- - -# Test-AppvLegacyPackage - -## SYNOPSIS -Validates App-V packages for conversion. - -## SYNTAX - -``` -Test-AppvLegacyPackage [-SourcePath] [] -``` - -## DESCRIPTION -The **Test-AppvLegacyPackage** cmdlet performs basic validation on Microsoft Application Virtualization (App-V) packages created by using an earlier version of App-V. -This cmdlet tests whether packages are compatible for conversion to the current App-V package format. - -This cmdlet performs only basic validation, such as making sure that all files are present, and that the **ConvertFrom-AppvLegacyPackage** cmdlet supports the package version. -This validation does not guarantee success of a package conversion. - -## EXAMPLES - -### Example 1: Validate a package for conversion -``` -PS C:\>Test-AppvLegacyPackage -SourcePath "C:\ContosoLegacyAppV" -``` - -This command validates whether an App-V package is compatible for conversion to the current App-V package format. - -## PARAMETERS - -### -SourcePath -Specifies an array of folders for the App-V packages that this cmdlet validates. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path, PSPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[ConvertFrom-AppvLegacyPackage](./ConvertFrom-AppvLegacyPackage.md) - - diff --git a/docset/mdop/appvclient/add-appvclientconnectiongroup.md b/docset/mdop/appvclient/add-appvclientconnectiongroup.md deleted file mode 100644 index d8dc22a9bb..0000000000 --- a/docset/mdop/appvclient/add-appvclientconnectiongroup.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Add-AppvClientConnectionGroup ---- - -# Add-AppvClientConnectionGroup - -## SYNOPSIS -Creates a composition of multiple packages on a computer running the App-V client. - -## SYNTAX - -``` -Add-AppvClientConnectionGroup [-Path] [] -``` - -## DESCRIPTION -The **Add-AppvClientConnectionGroup** cmdlet creates a Microsoft Application Virtualization (App-V) connection group. -In order for the group to be applied, all packages in the group must be added to the target computer, and must not be running. - -This cmdlet can also be used to update an already existing connection group definition. - -## EXAMPLES - -### Example 1: Add a connection group -``` -PS C:\> Add-AppvClientConnectionGroup -Path "C:\MyApps\MyGroup.xml" -``` - -This command adds the connection group file to the computer from the path provided. - -## PARAMETERS - -### -Path -Specifies the App-V connection group definition file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PSPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## NOTES - -## RELATED LINKS - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/add-appvclientpackage.md b/docset/mdop/appvclient/add-appvclientpackage.md deleted file mode 100644 index 554887213a..0000000000 --- a/docset/mdop/appvclient/add-appvclientpackage.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Add-AppvClientPackage ---- - -# Add-AppvClientPackage - -## SYNOPSIS -Adds a package to a computer running the App-V client. - -## SYNTAX - -``` -Add-AppvClientPackage [-Path] [[-DynamicDeploymentConfiguration] ] [] -``` - -## DESCRIPTION -The **Add-AppvClientPackage** cmdlet adds a new package to a computer running the Microsoft Application Virtualization (App-V) client. -You can also upgrade an existing package running on a computer running the App-V client. -The newly added package or package version is registered with the App-V client. - -If the package already exists on the computer, but the package to be added is a different version, the new version is added. -Existing versions will remain unchanged. - -## EXAMPLES - -### Example 1: Add a package to the client -``` -PS C:\> Add-AppvClientPackage -Path "http://MyServer/content/package.APPV" -``` - -This command adds a new package to the client computer. -If the package is a different version of an already existing package, the App-V agent adds this new version, but does not modify any existing versions. -Since no computer policy is provided, the package receives the default computer policy. - -### Example 2: Add a package with a configuration file -``` -PS C:\> Add-AppvClientPackage -Path "http://MyServer/content/package.appv" -DynamicDeploymentConfiguration "C:\MyConfigfiles\DynamicDeploymentConfig.xml" -``` - -This command adds a package with a Dynamic Deployment Configuration file. - -### Example 3: Add a package to the client and store the result -``` -PS C:\> $Package = Add-AppvClientPackage -Path "http://MyServer/content/package.APPV" -``` - -This command adds a new package to the client and assigns the resulting **AppvClientPackage** object to the variable $Package. - -## PARAMETERS - -### -DynamicDeploymentConfiguration -Specifies the path to a dynamic deployment configuration file for the specified App-V package to be added. -The cmdlet uses the dynamic deployment configuration file to override the default configuration provided in the package manifest. - -If you do not specify this parameter, the App-V client assigns the default computer policy to the App-V package to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the location of the .appv file containing the package to be added. -This parameter can point to a local directory, a network directory, or an HTTP or HTTPS URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PSPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvPackage - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## NOTES - -## RELATED LINKS - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/add-appvpublishingserver.md b/docset/mdop/appvclient/add-appvpublishingserver.md deleted file mode 100644 index 2e8bf981c1..0000000000 --- a/docset/mdop/appvclient/add-appvpublishingserver.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Add-AppvPublishingServer ---- - -# Add-AppvPublishingServer - -## SYNOPSIS -Adds a publishing server for the computer running the App-V client. - -## SYNTAX - -``` -Add-AppvPublishingServer [-Name] [-URL] [[-GlobalRefreshEnabled] ] - [[-GlobalRefreshOnLogon] ] [[-GlobalRefreshInterval] ] - [[-GlobalRefreshIntervalUnit] ] [[-UserRefreshEnabled] ] - [[-UserRefreshOnLogon] ] [[-UserRefreshInterval] ] - [[-UserRefreshIntervalUnit] ] [] -``` - -## DESCRIPTION -The **Add-AppvPublishingServer** cmdlet adds a new publishing server for the computer running the Microsoft Application Virtualization (App-V) client to connect to. -After the server has been added, the computer running the App-V client is able to use the server to obtain publishing refresh data, stream packages, and perform other operations. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -GlobalRefreshEnabled -Specifies whether to turn on the refreshing of the publishing server for all packages that are published globally. -You can set the refresh to be at the time of logon or on a defined time interval. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalRefreshInterval -Specifies the time interval for the refresh of globally published packages. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalRefreshIntervalUnit -Specifies the unit of time measurement. -Valid values are: day and hour. - -```yaml -Type: IntervalUnit -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Day - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalRefreshOnLogon -Specifies whether a refresh of all packages published to globally occurs every time a user logs into the target computer. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the publishing server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -URL -Specifies the URL path to the App-V publishing server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshEnabled -Specifies whether to turn on the refreshing of the publishing server for all packages that are published to the user. -The refresh can be set to be at the time of logon or on a defined time interval. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshInterval -Specifies the time interval for refreshes of user-published packages. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshIntervalUnit -Specifies the unit of time measurement. -Valid values are: day and hour. - -```yaml -Type: IntervalUnit -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Day - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshOnLogon -Specifies whether a refresh of all packages published to the user occurs every time a user logs into the target computer. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppvAgent.AppvPublishingServer - -## NOTES - -## RELATED LINKS - -[Get-AppvPublishingServer](./get-appvpublishingserver.md) - -[Remove-AppvPublishingServer](./remove-appvpublishingserver.md) - -[Set-AppvPublishingServer](./set-appvpublishingserver.md) - -[Sync-AppvPublishingServer](./sync-appvpublishingserver.md) diff --git a/docset/mdop/appvclient/appvclient.md b/docset/mdop/appvclient/appvclient.md deleted file mode 100644 index a6d470d7a9..0000000000 --- a/docset/mdop/appvclient/appvclient.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=403112 -Help Version: 4.0.1.0 -Locale: en-US -Module Guid: 596D7B43-928B-44D4-89E7-17D34740ECC2 -Module Name: AppVClient -ms.date: 12/05/2016 -ms.devlang: powershell -title: AppVClient ---- - -# AppVClient Module -## Description -The following list contains links to the help topics for the App-V Client cmdlets. - -## AppVClient Cmdlets -### [Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) -Creates a composition of multiple packages on a computer running the App-V client. - -### [Add-AppvClientPackage](./add-appvclientpackage.md) -Adds a package to a computer running the App-V client. - -### [Add-AppvPublishingServer](./add-appvpublishingserver.md) -Adds a publishing server for the computer running the App-V client. - -### [Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) -Disables a connection group on the computer running the App-V client. - -### [Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) -Enables a running connection group on the computer running the App-V client. - -### [Get-AppvClientApplication](./get-appvclientapplication.md) -Returns applications that are part of App-V Client Packages. - -### [Get-AppvClientConfiguration](./get-appvclientconfiguration.md) -Returns the configuration for the App-V client. - -### [Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) -Returns an App-V connection group object. - -### [Get-AppvClientMode](./get-appvclientmode.md) -Displays the mode for the App-V Client. - -### [Get-AppvClientPackage](./get-appvclientpackage.md) -Returns App-V Client Packages. - -### [Get-AppvPublishingServer](./get-appvpublishingserver.md) -Returns App-V Server objects. - -### [Get-AppvVirtualProcess](./get-appvvirtualprocess.md) -Displays the virtual processes running on a computer. - -### [Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) -Streams the contents of packages to the local disk. - -### [Mount-AppvClientPackage](./mount-appvclientpackage.md) -Loads a package into the App-V cache. - -### [Publish-AppvClientPackage](./publish-appvclientpackage.md) -Publishes the App-V package so that it is available to a user or a computer. - -### [Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) -Delete an App-V connection group on the client. - -### [Remove-AppvClientPackage](./remove-appvclientpackage.md) -Removes the package from a computer. - -### [Remove-AppvPublishingServer](./remove-appvpublishingserver.md) -Removes an App-V publishing server. - -### [Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) -Resets the user package settings for the connection group. - -### [Repair-AppvClientPackage](./repair-appvclientpackage.md) -Resets the user settings of a package. - -### [Send-AppvClientReport](./send-appvclientreport.md) -Sends reporting data from the client. - -### [Set-AppvClientConfiguration](./set-appvclientconfiguration.md) -Applies configuration settings to the App-V Client. - -### [Set-AppvClientMode](./set-appvclientmode.md) -Sets the mode the client is running in. - -### [Set-AppvClientPackage](./set-appvclientpackage.md) -Configures an App-V Client Package. - -### [Set-AppvPublishingServer](./set-appvpublishingserver.md) -Modifies properties of an App-V Publishing Server. - -### [Start-AppvVirtualProcess](./start-appvvirtualprocess.md) -Starts a virtual process. - -### [Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) -Shuts down the shared virtual environment of a connection group. - -### [Stop-AppvClientPackage](./stop-appvclientpackage.md) -Shuts down virtual environments for specified packages. - -### [Sync-AppvPublishingServer](./sync-appvpublishingserver.md) -Initiates the App-V Publishing Refresh operation. - -### [Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) -Removes the extension points for packages. diff --git a/docset/mdop/appvclient/disable-appvclientconnectiongroup.md b/docset/mdop/appvclient/disable-appvclientconnectiongroup.md deleted file mode 100644 index 72666903d1..0000000000 --- a/docset/mdop/appvclient/disable-appvclientconnectiongroup.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Disable-AppvClientConnectionGroup ---- - -# Disable-AppvClientConnectionGroup - -## SYNOPSIS -Disables a connection group on the computer running the App-V client. - -## SYNTAX - -### ByGuid (Default) -``` -Disable-AppvClientConnectionGroup [-Global] [-UserSID ] [-GroupId] [-VersionId] - [] -``` - -### ByName -``` -Disable-AppvClientConnectionGroup [-Global] [-UserSID ] [-Name] [] -``` - -### ByConnectionGroup -``` -Disable-AppvClientConnectionGroup [-Global] [-UserSID ] [-ConnectionGroup] - [] -``` - -## DESCRIPTION -The **Disable-AppvClientConnectionGroup** cmdlet disables an already existing connection group on the computer running the Microsoft Application Virtualization (App-V) client. - -## EXAMPLES - -### Example 1: Disable a connection group by using its name -``` -PS C:\> Disable-AppvClientConnectionGroup -Name "MyGroup" -``` - -This command disables the connection group named MyGroup. - -### Example 2: Disable a connection group by using its ID -``` -PS C:\> Disable-AppvClientConnectionGroup -GroupID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182 -``` - -This command disables the connection group that has the group ID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182. - -### Example 3: Disable all connection groups by names that match a string -``` -PS C:\> Get-AppvClientConnectionGroup -Name "MyGr*" | Disable-AppvClientConnectionGroup -``` - -This command gets all the connection groups that have the string MyGr in the name, and then disables them. - -## PARAMETERS - -### -ConnectionGroup -Not Specified. - -```yaml -Type: AppvClientConnectionGroup -Parameter Sets: ByConnectionGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Global -Specifies whether the provided connection group is disabled for all users that log into the target computer. -Otherwise, the connection group is disabled only for the currently running user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the GUID associated with a specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the App-V connection group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSID -Specifies the SID of the intended user, in the form of S-1-2-34-56789012-3456789012-345678901-2345. -This parameter requires elevated rights to run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates the connection group version from other versions. -If you do not specify this parameter, the cmdlet operates on all versions of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## OUTPUTS - -## NOTES -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns the following error: The action could not be performed due to current App-V permissions. Please modify the permissions and try the operation again. -* If the disable operation fails, the cmdlet returns the following error: The disable operation could not be completed. An error code is returned. -* If any package within the specified group is running, the connection group will not be disabled until all packages in the new group are shutdown. The cmdlet will still return success as long as the file is valid. -* If the cmdlet cannot find the connection group, the cmdlet returns the following error: The specified connection group could not be found on the target system. - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/enable-appvclientconnectiongroup.md b/docset/mdop/appvclient/enable-appvclientconnectiongroup.md deleted file mode 100644 index 83e42f34d3..0000000000 --- a/docset/mdop/appvclient/enable-appvclientconnectiongroup.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-AppvClientConnectionGroup ---- - -# Enable-AppvClientConnectionGroup - -## SYNOPSIS -Enables a running connection group on the computer running the App-V client. - -## SYNTAX - -### ByGuid (Default) -``` -Enable-AppvClientConnectionGroup [-Global] [-UserSID ] [-GroupId] [-VersionId] - [] -``` - -### ByName -``` -Enable-AppvClientConnectionGroup [-Global] [-UserSID ] [-Name] [] -``` - -### ByConnectionGroup -``` -Enable-AppvClientConnectionGroup [-Global] [-UserSID ] [-ConnectionGroup] - [] -``` - -## DESCRIPTION -The **Enable-AppvClientConnectionGroup** cmdlet enables a connection group to the computer running the Microsoft Application Virtualization (App-V) client. - -## EXAMPLES - -### Example 1: Enable a connection group by using its name -``` -PS C:\> Enable-AppvClientConnectionGroup -Name "MyGroup" -Global -``` - -This command enables the connection group named MyGroup to all users on the computer. - -### Example 2: Enable a connection group by using its ID -``` -PS C:\> Enable-AppvClientConnectionGroup -GroupID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182 -``` - -This command enables the connection group that has the group ID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182. - -### Example 3: Enable all connection groups by names that match a string -``` -PS C:\> Get-AppvClientConnectionGroup -Name "MyGr*" | Enable-AppvClientConnectionGroup -``` - -This command finds all connection groups that have the string MyGr in the name, and then enables them. - -## PARAMETERS - -### -ConnectionGroup -Not Specified. - -```yaml -Type: AppvClientConnectionGroup -Parameter Sets: ByConnectionGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Global -Specifies whether the provided connection group will be enabled to all users that log into the targeted computer. -Otherwise, the connection group will only be enabled to the currently running user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the ID associated with a specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the App-V connection group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSID -Specifies the SID of the intended user, in the form of S-1-2-34-56789012-3456789012-345678901-2345. -This parameter requires elevated rights to run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a connection group version from other versions. -If you do not specify this parameter, the cmdlet operates on all versions of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## OUTPUTS - -## NOTES -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns the following error: The action could not be performed due to current App-V permissions. Please modify the permissions and try the operation again. -* If the enable operation fails, the cmdlet returns the following error: The enable operation could not be completed. An error code is returned. -* If any package within the specified group is running, the connection group will not be enabled until all packages in the new group are shutdown. The cmdlet will still return success as long as the file is valid. -* If the cmdlet cannot find the connection group, the cmdlet returns an error stating The specified connection group could not be found on the target system. - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/get-appvclientapplication.md b/docset/mdop/appvclient/get-appvclientapplication.md deleted file mode 100644 index 1820405c0b..0000000000 --- a/docset/mdop/appvclient/get-appvclientapplication.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvClientApplication ---- - -# Get-AppvClientApplication - -## SYNOPSIS -Returns applications that are part of App-V Client Packages. - -## SYNTAX - -``` -Get-AppvClientApplication [[-Name] ] [[-Version] ] [-All] [] -``` - -## DESCRIPTION -The **Get-AppvClientApplication** cmdlet returns a set of applications that are part of Microsoft Application Virtualization (App-V) Client Packages, based on the criteria provided. - -## EXAMPLES - -### Example 1: Get a version of an application for the current user -``` -PS C:\> Get-AppvClientApplication -Name "AppName" -Version 1 -``` - -This command gets the application on the client that is published to the user and has the name AppName and is version 1. - -### Example 2: Get all applications -``` -PS C:\> Get-AppvClientApplication -All -``` - -This command gets all of the applications on the client. - -## PARAMETERS - -### -All -Indicates that the cmdlet returns all applications that have been added to the computer, not just those that are visible to the current user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the application. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the application. -If you do not specify this parameter, the cmdlet operates on all available versions of the applications on the target computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppV.AppvClientPowerShell.AppvClientApplication - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/appvclient/get-appvclientconfiguration.md b/docset/mdop/appvclient/get-appvclientconfiguration.md deleted file mode 100644 index 8b19feb3e1..0000000000 --- a/docset/mdop/appvclient/get-appvclientconfiguration.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvClientConfiguration ---- - -# Get-AppvClientConfiguration - -## SYNOPSIS -Returns the configuration for the App-V client. - -## SYNTAX - -``` -Get-AppvClientConfiguration [[-Name] ] [] -``` - -## DESCRIPTION -The **Get-AppvClientConfiguration** cmdlet returns an object containing all of the settings and permissions for the Microsoft Application Virtualization (App-V) client. -These settings include both App-V client settings and permissions. - -In the case where a particular setting is asked for, the cmdlet will return the value for that specific setting. - -## EXAMPLES - -### Example 1: Display all configuration settings -``` -PS C:\> Get-AppvClientConfiguration -``` - -This command displays all of the App-V Client Configuration settings. - -### Example 2: Display a single configuration setting -``` -PS C:\> Get-AppvClientConfiguration -Name "PackageSourceRoot" -``` - -This command displays the value of the **PackageSourceRoot** setting. - -## PARAMETERS - -### -Name -Not Specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppV.AppvClientPowerShell.AppvClientConfiguration -In you do not specify any parameters, the cmdlet returns an **AppvClientConfiguration** object. -The object is displayed as a two column table. -The first column contains the specific configuration and the second column contains the associated current value. - -If you specify the *Name* parameter, the cmdlet returns the same two column table, but only for the configuration requested. - -## NOTES - -## RELATED LINKS - -[Set-AppvClientConfiguration](./set-appvclientconfiguration.md) diff --git a/docset/mdop/appvclient/get-appvclientconnectiongroup.md b/docset/mdop/appvclient/get-appvclientconnectiongroup.md deleted file mode 100644 index b3c1798353..0000000000 --- a/docset/mdop/appvclient/get-appvclientconnectiongroup.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvClientConnectionGroup ---- - -# Get-AppvClientConnectionGroup - -## SYNOPSIS -Returns an App-V connection group object. - -## SYNTAX - -### ByName (Default) -``` -Get-AppvClientConnectionGroup [[-Name] ] [-All] [] -``` - -### ByGuid -``` -Get-AppvClientConnectionGroup [-GroupId] [[-VersionId] ] [-All] [] -``` - -## DESCRIPTION -The **Get-AppvClientConnectionGroup** cmdlet returns a specific Microsoft Application Virtualization (App-V) connection group object. - -## EXAMPLES - -### Example 1: Get all versions of a group by name -``` -PS C:\> Get-AppvClientConnectionGroup -Name "MyConnectionGroup" -``` - -This command gets all versions of the enabled connection groups named MyConnectionGroup. - -### Example 2: Get a connection group by using its ID -``` -PS C:\> Get-AppvClientConnectionGroup -GroupID 793afd37-bd68-4ea1-859a-669f6afd0aa8 -``` - -This command gets the enabled connection group that has the group ID of 793afd37-bd68-4ea1-859a-669f6afd0aa8. - -### Example 3: Get all connection groups -``` -PS C:\> Get-AppvClientConnectionGroup -All -``` - -This command gets all of the connection groups on the computer. - -## PARAMETERS - -### -All -Indicates that the cmdlet returns all connection groups that have been added to the computer, not just those that are enabled to the current user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the GUID of specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the App-V Connection Group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppV.AppvClientPowerShell.AppvClientConnectionGroup - -## NOTES -* The cmdlet returns an error if the name of the specified App-V connection group cannot be found on the target computer. - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/get-appvclientmode.md b/docset/mdop/appvclient/get-appvclientmode.md deleted file mode 100644 index 52f3e7d96f..0000000000 --- a/docset/mdop/appvclient/get-appvclientmode.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvClientMode ---- - -# Get-AppvClientMode - -## SYNOPSIS -Displays the mode for the App-V Client. - -## SYNTAX - -``` -Get-AppvClientMode [] -``` - -## DESCRIPTION -The **Get-AppvClientMode** cmdlet displays the mode that the Microsoft Application Virtualization (App-V) Client is currently set to. -Valid values are Normal and Uninstall. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppV.AppvClientPowerShell.AppvClientMode -This cmdlet generat **AppvClientMode** object that describes the current Appv Client mode, either Normal or Uninstall. - -## NOTES - -## RELATED LINKS - -[Set-AppvClientMode](./set-appvclientmode.md) diff --git a/docset/mdop/appvclient/get-appvclientpackage.md b/docset/mdop/appvclient/get-appvclientpackage.md deleted file mode 100644 index 6e14396fe4..0000000000 --- a/docset/mdop/appvclient/get-appvclientpackage.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvClientPackage ---- - -# Get-AppvClientPackage - -## SYNOPSIS -Returns App-V Client Packages. - -## SYNTAX - -### ByName (Default) -``` -Get-AppvClientPackage [[-Name] ] [[-Version] ] [-All] [] -``` - -### ByGuid -``` -Get-AppvClientPackage [-PackageId] [[-VersionId] ] [-All] [] -``` - -## DESCRIPTION -The **Get-AppvClientPackage** cmdlet returns a set of Microsoft Application Virtualization (App-V) Client Packages based on the criteria provided. - -## EXAMPLES - -### Example 1: Get packages that have names that match a string -``` -PS C:\> Get-AppvClientPackage -Name "MyApp*" -All -``` - -This command gets the set of packages that have names beginning with the string MyApp. - -### Example 2: Get a specific version of a package by name -``` -PS C:\> Get-AppvClientPackage -Name "MyApp" -Version 4 -``` - -This command gets the version 4 of the package named MyApp. - -### Example 3: Get a package by using its package ID -``` -PS C:\> Get-AppvClientPackage -PackageID 793afd37-bd68-4ea1-859a-669f6afd0aa8 -``` - -This command gets the package with the package ID of 793afd37-bd68-4ea1-859a-669f6afd0aa8. - -## PARAMETERS - -### -All -Indicates that the cmdlet uses the set of all packages added to the computers as the searchable set. -If not provided, the cmdlet only uses packages that are entitled to the current user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during Sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageId -Specifies the GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the App-V Sequencer. -The package ID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one specific lineage. -If you do not specify this parameter, the cmdlet operates on available versions of the package on the target computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies the GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do specify this parameter, the cmdlet operateson all versions of a package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppV.AppvClientPowerShell.AppvClientPackage - -## NOTES -* If you do not specify any parameters, the cmdlet returns a set of all packages on the computer. -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns the following error: The action could not be performed due to current App-V permissions. Please modify the permissions and try the operation again. -* If the cmdlet cannot find the package, the cmdlet returns the following error: The specified package(s) could not be found. An error code is returned. - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/get-appvpublishingserver.md b/docset/mdop/appvclient/get-appvpublishingserver.md deleted file mode 100644 index c3b1a53495..0000000000 --- a/docset/mdop/appvclient/get-appvpublishingserver.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvPublishingServer ---- - -# Get-AppvPublishingServer - -## SYNOPSIS -Returns App-V Server objects. - -## SYNTAX - -### ByServerId (Default) -``` -Get-AppvPublishingServer [[-ServerId] ] [] -``` - -### ByNameUrl -``` -Get-AppvPublishingServer [[-Name] ] [[-URL] ] [] -``` - -## DESCRIPTION -The **Get-AppvPublishingServer** cmdlet returns a Microsoft Application Virtualization (App-V) Server object or set of App-V Server objects based on the criteria provided. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-AppvPublishingServer -Name "Server*" -``` - -### Example 2 -``` -PS C:\> Get-AppvPublishingServer -ServerId 1 -``` - -## PARAMETERS - -### -Name -Specifies the name of the App-V publishing server. - -```yaml -Type: String -Parameter Sets: ByNameUrl -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerId -Specifies the unique identifier of the App-V Publishing Server. - -```yaml -Type: UInt32 -Parameter Sets: ByServerId -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -URL -Specifies the URL path to the App-V Publishing server - -```yaml -Type: String -Parameter Sets: ByNameUrl -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.AppV.AppvClientPowerShell.AppvPublishingServer - -## NOTES -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns the following error: The action could not be performed due to current App-V permissions. Please modify the permissions and try the operation again. -* If the get operation fails, the cmdlet returns the following error: The get operation could not be completed. An error code is returned. -* If the cmdlet cannot find the servers, the cmdlet returns the following error: The specified App-V publishing server(s) could not be found. An error code is returned. - -## RELATED LINKS - -[Add-AppvPublishingServer](./add-appvpublishingserver.md) - -[Remove-AppvPublishingServer](./remove-appvpublishingserver.md) - -[Set-AppvPublishingServer](./set-appvpublishingserver.md) - -[Sync-AppvPublishingServer](./sync-appvpublishingserver.md) diff --git a/docset/mdop/appvclient/get-appvvirtualprocess.md b/docset/mdop/appvclient/get-appvvirtualprocess.md deleted file mode 100644 index cb39d30618..0000000000 --- a/docset/mdop/appvclient/get-appvvirtualprocess.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVClientCmdlets-help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvVirtualProcess ---- - -# Get-AppvVirtualProcess - -## SYNOPSIS -Displays the virtual processes running on a computer. - -## SYNTAX - -### Name (Default) -``` -Get-AppvVirtualProcess [[-Name] ] [-ComputerName ] [-Module] [-FileVersionInfo] - [] -``` - -### Id -``` -Get-AppvVirtualProcess -Id [-ComputerName ] [-Module] [-FileVersionInfo] - [] -``` - -### InputObject -``` -Get-AppvVirtualProcess [-ComputerName ] [-Module] [-FileVersionInfo] -InputObject - [] -``` - -## DESCRIPTION -The **Get-AppvVirtualProcess** cmdlet displays each of the virtual processes running on a computer. - -## EXAMPLES - -### Example 1: Display all active virtual processes -``` -PS C:\>Get-AppvVirtualProcess -``` - -This command displays all active virtual processes. - -### Example 2: Display file information for a virtual process -``` -PS C:\>Get-AppvVirtualProcess -Name "myVirtualProcess" -FileVersionInfo -``` - -This command displays file information for the process named myVirtualProcess. - -### Example 3: Display file information for a virtual process by using the pipeline operator -``` -PS C:\>Get-Process -Name "myVirtualProcess" | Get-AppvVirtualProcess -FileVersionInfo -``` - -## PARAMETERS - -### -ComputerName -Specifies the computer name. -Used primarily for viewing processes on different computer. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Cn - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileVersionInfo -Indicates that this cmdlet returns the **ProductVersion**, **FileVersion** and un-virtualized **Filename** for each **ProcessName**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: FV, FVI - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the Virtual Process ID. - -```yaml -Type: Int32[] -Parameter Sets: Id -Aliases: PID - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: Process[] -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Module -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a process, which is also known as the **ProcessName**. - -```yaml -Type: String[] -Parameter Sets: Name -Aliases: ProcessName - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Diagnosis.Process - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Start-AppvVirtualProcess](./start-appvvirtualprocess.md) diff --git a/docset/mdop/appvclient/mount-appvclientconnectiongroup.md b/docset/mdop/appvclient/mount-appvclientconnectiongroup.md deleted file mode 100644 index 7dcb6eb852..0000000000 --- a/docset/mdop/appvclient/mount-appvclientconnectiongroup.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Mount-AppvClientConnectionGroup ---- - -# Mount-AppvClientConnectionGroup - -## SYNOPSIS -Streams the contents of packages to the local disk. - -## SYNTAX - -### ByGuid (Default) -``` -Mount-AppvClientConnectionGroup [-GroupId] [-VersionId] [] -``` - -### ByName -``` -Mount-AppvClientConnectionGroup [-Name] [] -``` - -### ByConnectionGroup -``` -Mount-AppvClientConnectionGroup [-ConnectionGroup] [] -``` - -## DESCRIPTION -The **Mount-AppvClientConnectionGroup** cmdlet streams the contents of all packages in a connection group to the local disk. - -## EXAMPLES - -### Example 1: Download packages for a named group -``` -PS C:\> Mount-AppvClientConnectionGroup -Name "MyGroup" -``` - -This command downloads all packages that are part of the enabled connection group named MyGroup. - -### Example 2: Download packages for a group by using group ID -``` -PS C:\> Mount-AppvClientConnectionGroup -GroupID 793afd37-bd68-4ea1-859a-669f6afd0aa8 -``` - -This cmdlet downloads all the packages that are part of the enabled connection group that has the group ID 793afd37-bd68-4ea1-859a-669f6afd0aa8. - -### Example 3: Download packages for groups that match a string -``` -PS C:\> Get-AppvClientConnectionGroup -Name "MyGr*" | Mount-AppvClientConnectionGroup -``` - -This command gets all enabled connection groups that have the string MyGr in the name, and then downloads all of the packages in those connection group. - -## PARAMETERS - -### -ConnectionGroup -Specifies the Microsoft Application Virtualization (App-V) Connection Group object. - -```yaml -Type: AppvClientConnectionGroup -Parameter Sets: ByConnectionGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID of specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the App-V Connection Group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies the GUID that differentiates a Connection Group version from other versions. -If you do not specify this parameter, the cmdlet operates on all versions of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## OUTPUTS - -## NOTES -* If a previous load has been cancelled, the cmdlet resumes that load when run again. The package will be added to the system before loading, otherwise the cmdlet fails. If you do not specify any parameters, the cmdlet loads all packages on the system. -* The cmdlet is synchronous. It return once the load option has completed. To make the cmdlet asynchronous, use the **Start-Job** cmdlet. -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns an error. - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) diff --git a/docset/mdop/appvclient/mount-appvclientpackage.md b/docset/mdop/appvclient/mount-appvclientpackage.md deleted file mode 100644 index 0fe0ba964a..0000000000 --- a/docset/mdop/appvclient/mount-appvclientpackage.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Mount-AppvClientPackage ---- - -# Mount-AppvClientPackage - -## SYNOPSIS -Loads a package into the App-V cache. - -## SYNTAX - -### ByGuid (Default) -``` -Mount-AppvClientPackage [-Cancel] [-PackageId] [-VersionId] [] -``` - -### ByPackage -``` -Mount-AppvClientPackage [-Cancel] [-Package] [] -``` - -### ByName -``` -Mount-AppvClientPackage [-Name] [[-Version] ] [] -``` - -## DESCRIPTION -The **Mount-AppvClientPackage** cmdlet initiates or resumes the loading of a Microsoft Application Virtualization (App-V) package into the cache. - -## EXAMPLES - -### Example 1: Get a specific version of a package -``` -PS C:\> Mount-AppvClientPackage -Name "MyApp" -Version 2 -``` - -This command downloads the version 2 of the package named MyApp. - -### Example 2: Get all versions of a package -``` -PS C:\> Mount-AppvClientPackage -Name "MyApp" -``` - -This command downloads the all versions of the package named MyApp. - -### Example 3: Download all packages that match a string -``` -PS C:\> Get-AppvClientPackage -Name "My*" | Mount-AppvClientPackage -``` - -This command gets all packages that have the string My in the name, and then download them. - -### Example 4: Download and publish a new package -``` -PS C:\> Add-AppvClientPackage -Path "http://MyServer/content/package.Appv" | Mount-AppvClientPackage | Publish-AppvClientPackage -Global -``` - -This command adds the package from the path specified, then downloads it, and then publishes it to all users on the computer. - -### Example 5: Cancel a download -``` -PS C:\> Mount-AppvClientPackage -Name "MyApp" -Cancel -``` - -This command cancels the download of the package name MyApp. - -## PARAMETERS - -### -Cancel -Indicates that the cmdlet stops the loading of a package. - -```yaml -Type: SwitchParameter -Parameter Sets: ByGuid, ByPackage -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified. - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies a GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the App-V Sequencer. -The package IDs are shared by all versions of a specific package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one specific lineage. -If you do not specify this parameter, the cmdlet operates on all versions on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## NOTES -* If a previous mount has been cancelled, the cmdlet resumes that mount when run again. The package must be added to the system before mounting, otherwise the cmdlet fails. If you do not specify any parameters, the cmdlet mounts all packages on the system. -* This cmdlet is synchronous. It will return once the mount option has completed. To make the cmdlet asynchronous, use the **Start-Job** cmdlet. - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/publish-appvclientpackage.md b/docset/mdop/appvclient/publish-appvclientpackage.md deleted file mode 100644 index 0a81b0b455..0000000000 --- a/docset/mdop/appvclient/publish-appvclientpackage.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Publish-AppvClientPackage ---- - -# Publish-AppvClientPackage - -## SYNOPSIS -Publishes the App-V package so that it is available to a user or a computer. - -## SYNTAX - -### ByGuid (Default) -``` -Publish-AppvClientPackage [-Global] [-UserSID ] [[-DynamicUserConfigurationPath] ] - [-DynamicUserConfigurationType ] [-PackageId] [-VersionId] - [] -``` - -### ByPackage -``` -Publish-AppvClientPackage [-Global] [-UserSID ] [[-DynamicUserConfigurationPath] ] - [-DynamicUserConfigurationType ] [-Package] [] -``` - -### ByName -``` -Publish-AppvClientPackage [-Global] [-UserSID ] [[-DynamicUserConfigurationPath] ] - [-DynamicUserConfigurationType ] [-Name] [[-Version] ] - [] -``` - -## DESCRIPTION -The **Publish-AppvClientPackage** cmdlet publishes the appropriate extension points of a set of Microsoft Application Virtualization (App-V) packages. -Examples of common extension points include shortcuts and FTAs. -You can publish the package to the current user or to all users that log into the targeted computer. -You can also provide a Dynamic User Configuration file for the package. - -## EXAMPLES - -### Example 1: Publish a version of a package to all users -``` -PS C:\> Publish-AppvClientPackage -Name "MyApp" -Version 1 -Global -DynamicUserConfiguration "C:\content\policies\MyApp.policy" -``` - -This command publishes version 1 of the package named MyApp to all users on the computer and applies the Dynamic User Configuration policy file. - -### Example 2: Publish a version of a package to a user -``` -PS C:\> Publish-AppvClientPackage -Name "MyApp" -Version 1 -UserPolicy "C:\content\policies\MyAppConfiguration.xml" -``` - -This command publishes version 1 of the package named "MyApp" to the user and applies the Dynamic User Configuration policy file. - -### Example 3: Publish the latest version of a package to all users -``` -PS C:\> Publish-AppvClientPackage -Name "MyApp" -Global -``` - -This command publishes the package named MyApp to all users on the computer. - -## PARAMETERS - -### -DynamicUserConfigurationPath -Specifies the path to a Dynamic User configuration file for the specified App-V package to be added. -The cmdlet uses the Dynamic User Configuration file to override the default behavior provided in the user section of the package manifest or the Dynamic Deployment Configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicUserConfigurationType -Specifies what should be done in the absence of a defined dynamic user configuration file. -Valid values are: - -- UseDeploymentConfiguration. -The package uses the user configuration portion of deployment configuration. -- UseNoConfiguration. -Clear any previous configuration and use settings from the manifest. -- UseExistingConfiguration. -Make no changes to the configuration and use the last published configuration. - -If you do not specify this parameter, this cmdlet uses UseExistingConfiguration if the package is already published or UseDeploymentConfiguration if it is not. - -Use this parameter only during user publishing. -It is not valid for global publish. - -```yaml -Type: DynamicUserConfiguration -Parameter Sets: (All) -Aliases: -Accepted values: UseDeploymentConfiguration, UseNoConfiguration, UseExistingConfiguration - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Indicates that the provided package is published to all users that log into the targeted computer. -Otherwise, the packages are only published to the currently running user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package given when it was sequenced. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies a GUID that identifies the package. -The information can be found in the package manifest or by opening the package in the App-V sequencer. -The package ID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSID -Specifies the SID of the intended user, in the form of S-1-2-34-56789012-3456789012-345678901-2345. -This parameter requires elevated rights to run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in a lineage. -If you do not specify this parameter, the cmdlet operates on the latest of the package on the computer running the App-V client. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions. -If you do not specify this parameter, the cmdlet operateson the latest version of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/remove-appvclientconnectiongroup.md b/docset/mdop/appvclient/remove-appvclientconnectiongroup.md deleted file mode 100644 index 096ed832dc..0000000000 --- a/docset/mdop/appvclient/remove-appvclientconnectiongroup.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-AppvClientConnectionGroup ---- - -# Remove-AppvClientConnectionGroup - -## SYNOPSIS -Delete an App-V connection group on the client. - -## SYNTAX - -### ByGuid (Default) -``` -Remove-AppvClientConnectionGroup [-GroupId] [-VersionId] [] -``` - -### ByName -``` -Remove-AppvClientConnectionGroup [-Name] [] -``` - -### ByConnectionGroup -``` -Remove-AppvClientConnectionGroup [-ConnectionGroup] [] -``` - -## DESCRIPTION -The **Remove-AppvClientConnectionGroup** cmdlet deletes an existing Microsoft Application Virtualization (App-V) connection group on the client. -All packages that were in the group are separated. - -## EXAMPLES - -### Example 1: Remove a named connection group -``` -PS C:\> Remove-AppvClientConnectionGroup -Name "MyGroup" -``` - -This command removes the connection group named MyGroup from the computer. - -### Example 2: Remove a connection group by using its ID -``` -PS C:\> Remove-AppvClientConnectionGroup -GroupID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182 -``` - -This command removes the connection group that has the group ID 35ec9e5f-ab21-463f-8fe6-b90d4b66d182. - -### Example 3: Remove all connection groups that have names that match a string -``` -PS C:\> Get-AppvClientConnectionGroup -Name MyGr* | Remove-AppvClientConnectionGroup -``` - -This command finds any connection group that has the string MyGr in the name, and then removes them from the computer. - -## PARAMETERS - -### -ConnectionGroup -Specifies an App-V Connection Group object. - -```yaml -Type: AppvClientConnectionGroup -Parameter Sets: ByConnectionGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupId -Specifies the GUID of specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the App-V Connection Group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies the GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## OUTPUTS - -## NOTES -* If any packages in the group are still running, the cmdlet returns an error. -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns an error. -* If the remove operation fails, the cmdlet returns the following error: The remove operation could not be completed. An error code is returned. -* If any package within the specified group is running, the connection group is not removed until all packages in the new group are shutdown. The cmdlet still returns success as long as the file is valid. - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/remove-appvclientpackage.md b/docset/mdop/appvclient/remove-appvclientpackage.md deleted file mode 100644 index 536b35ff94..0000000000 --- a/docset/mdop/appvclient/remove-appvclientpackage.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-AppvClientPackage ---- - -# Remove-AppvClientPackage - -## SYNOPSIS -Removes the package from a computer. - -## SYNTAX - -### ByGuid (Default) -``` -Remove-AppvClientPackage [-PackageId] [-VersionId] [] -``` - -### ByPackage -``` -Remove-AppvClientPackage [-Package] [] -``` - -### ByName -``` -Remove-AppvClientPackage [-Name] [[-Version] ] [] -``` - -## DESCRIPTION -The **Remove-AppvClientPackage** cmdlet removes the package from computer running the Microsoft Application Virtualization (App-V) client. -The cmdlet deletes the **AppvClientPackage** object. - -## EXAMPLES - -### Example 1: Remove a version of a package by using the pipeline operator -``` -PS C:\> Get-AppvPackage -Name "MyPackage" -Version 1 | Remove-Package -``` - -This command gets version 1 of the package named MyPackage, and then removes it from the computer. - -### Example 2: Remove a version of a package -``` -PS C:\> Remove-Package -Name "MyPackage" -Version 1 -``` - -This command removes version 1 of the package named MyPackage from the computer. - -## PARAMETERS - -### -Name -Specifies the friendly name of the package given during sequencing. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified. - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies the package ID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the sequencer. -The package ID is shared by all versions of a specific package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in a lineage. -If you do not specify this parameter, the cmdlet operates on all versions on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/remove-appvpublishingserver.md b/docset/mdop/appvclient/remove-appvpublishingserver.md deleted file mode 100644 index d7359aec89..0000000000 --- a/docset/mdop/appvclient/remove-appvpublishingserver.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-AppvPublishingServer ---- - -# Remove-AppvPublishingServer - -## SYNOPSIS -Removes an App-V publishing server. - -## SYNTAX - -### ByServerId (Default) -``` -Remove-AppvPublishingServer [-ServerId] [] -``` - -### ByObject -``` -Remove-AppvPublishingServer [-Server] [] -``` - -### ByNameUrl -``` -Remove-AppvPublishingServer [[-Name] ] [[-URL] ] [] -``` - -## DESCRIPTION -The **Remove-AppvPublishingServer** cmdlet removes the Microsoft Application Virtualization (App-V) publishing server from the App-V client list. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-AppvPublishingServer -Name "Server01" -``` - -### Example 2 -``` -PS C:\>Remove-AppvPublishingServer -Name "Server*" -``` - -## PARAMETERS - -### -Name -Specifies the name of the composition. - -```yaml -Type: String -Parameter Sets: ByNameUrl -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies an **AppvPublishingServer** object. -To obtain an **AppvPublishingServer** object, use the **Get-AppvPublishingServer** cmdlet. - -```yaml -Type: AppvPublishingServer -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerId -Specifies the ID for the publishing server. - -```yaml -Type: UInt32 -Parameter Sets: ByServerId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -URL -Specifies the URL path to the publishing server. - -```yaml -Type: String -Parameter Sets: ByNameUrl -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvMgmtServer - -## OUTPUTS - -## NOTES -* If an operation is being done between the server and targeted App-V agent, the cmdlet deletes the App-V server object, but any operation that had already been initiated completes. Subsequent actions that may have been queued up fail. -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns the following error: The action could not be performed due to current App-V permissions. Please modify the permissions and try the operation again. - -## RELATED LINKS - -[Add-AppvPublishingServer](./add-appvpublishingserver.md) - -[Get-AppvPublishingServer](./get-appvpublishingserver.md) - -[Set-AppvPublishingServer](./set-appvpublishingserver.md) - -[Sync-AppvPublishingServer](./sync-appvpublishingserver.md) diff --git a/docset/mdop/appvclient/repair-appvclientconnectiongroup.md b/docset/mdop/appvclient/repair-appvclientconnectiongroup.md deleted file mode 100644 index b11c77befa..0000000000 --- a/docset/mdop/appvclient/repair-appvclientconnectiongroup.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Repair-AppvClientConnectionGroup ---- - -# Repair-AppvClientConnectionGroup - -## SYNOPSIS -Resets the user package settings for the connection group. - -## SYNTAX - -### ByGuid (Default) -``` -Repair-AppvClientConnectionGroup [-Global] [-UserState] [-Extensions] [-GroupId] [-VersionId] - [] -``` - -### ByName -``` -Repair-AppvClientConnectionGroup [-Global] [-UserState] [-Extensions] [-Name] [] -``` - -### ByConnectionGroup -``` -Repair-AppvClientConnectionGroup [-Global] [-UserState] [-Extensions] - [-ConnectionGroup] [] -``` - -## DESCRIPTION -The **Repair-AppvClientConnectionGroup** cmdlet resets the user settings of the connection group. -Resetting the settings results in permanent loss of any user-specific application settings within the package. -The settings are reset to their original state when the connection group was originally added to the system. - -## EXAMPLES - -### Example 1: Repair a named connection group -``` -PS C:\> Repair-AppvClientConnectionGroup -Name MyGroup -``` - -This command repairs the connection group named MyGroup. - -### Example 2: Repair a connection group by using its ID -``` -PS C:\> Repair-AppvClientConnectionGroup -GroupID 793afd37-bd68-4ea1-859a-669f6afd0aa8 -``` - -This command repairs the connection group that has the group ID 793afd37-bd68-4ea1-859a-669f6afd0aa8. - -### Example 3: Repair all connection groups that have names that match a string -``` -PS C:\> Get-AppvClientConnectionGroup -Name MyGr* | Repair-AppvClientConnectionGroup -``` - -This command finds all of the connection groups that have the string MyGr in the name, and then repairs them. - -## PARAMETERS - -### -ConnectionGroup -Not Specified - -```yaml -Type: AppvClientConnectionGroup -Parameter Sets: ByConnectionGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Extensions -Indicates that the cmdlet repairs the extension points of a connection group only, and does not delete the user state of the connection group. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Not Specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID of specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Microsoft Application Virtualization (App-V) Connection Group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserState -Indicates that the cmdlet deletes the user state of the connection group only, and does not perform a repair on the extension points. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a connection group version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Stop-AppvClientConnectionGroup](./stop-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/repair-appvclientpackage.md b/docset/mdop/appvclient/repair-appvclientpackage.md deleted file mode 100644 index f9ecabc02a..0000000000 --- a/docset/mdop/appvclient/repair-appvclientpackage.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Repair-AppvClientPackage ---- - -# Repair-AppvClientPackage - -## SYNOPSIS -Resets the user settings of a package. - -## SYNTAX - -### ByGuid (Default) -``` -Repair-AppvClientPackage [-Global] [-UserState] [-Extensions] [-PackageId] [-VersionId] - [] -``` - -### ByPackage -``` -Repair-AppvClientPackage [-Global] [-UserState] [-Extensions] [-Package] - [] -``` - -### ByName -``` -Repair-AppvClientPackage [-Global] [-UserState] [-Extensions] [-Name] [[-Version] ] - [] -``` - -## DESCRIPTION -The **Repair-AppvClientPackage** cmdlet deletes the user settings and reset the extension points of the package. -Resetting the settings results in permanent loss of any user-specific application settings within the package. -The settings are reset to their original state when the package was originally added to the system. - -## EXAMPLES - -### Example 1: Delete user state for a version of a package -``` -PS C:\> Repair-AppvClientPackage -Name "MyApp" -Version 3 -``` - -This command deletes the user state of version 3 of the package named MyApp. - -### Example 2: Delete user state for packages that have a name that matches a string -``` -PS C:\> Get-AppvClientPackage -Name "MyA*" | Repair-AppvClientPackage -``` - -This command gets all packages that have the string MyA in the name, and then delete the user state for those packages. - -## PARAMETERS - -### -Extensions -Indicates that the cmdlet repairs the extension points of a package only, and does not delete the user state of the package. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Indicates that the extension points for the provided packages are repaired for all users that log into the targeted computer. -Otherwise, the extension points of the packages are only repaired for the currently running user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during Sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified. - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies a GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) Sequencer. -The Package ID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserState -Indicates that the cmdlet deletes the user state of the package only, and does not perform a repair on the extension points. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in a lineage. -If you do not specify this parameter, the cmdlet operates on all versions on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies the GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## NOTES - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/send-appvclientreport.md b/docset/mdop/appvclient/send-appvclientreport.md deleted file mode 100644 index 01fadc5d19..0000000000 --- a/docset/mdop/appvclient/send-appvclientreport.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Send-AppvClientReport ---- - -# Send-AppvClientReport - -## SYNOPSIS -Sends reporting data from the client. - -## SYNTAX - -``` -Send-AppvClientReport [-NetworkCostAware] [-DeleteOnSuccess] [[-URL] ] [] -``` - -## DESCRIPTION -The **Send-AppVClientReport** cmdlet sends all the available reporting data to the specified location in XML format. -You can delete the data from the client. -Reporting must be enabled. -By default, the data will be sent to the location that is listed in the **ReportingServer** registry value. -This value can be either an UNC Share or the name of the Microsoft Application Virtualization (App-V) Reporting Server. -To override this location, you can specify a location by using the *URL* parameter. -The location can be either an UNC share or the App-V Reporting Server location. - -By default, once the data is sent, the data is not deleted from the client and will be sent to the reporting server as part of the next scheduled sync, if applicable. -You can specify to delete the data from the client. -If the *DeleteOnSuccess* parameter is specified, the reporting data is deleted from the client. - -If the data is successfully sent, a success message is displayed. - -The cmdlet fails if reporting is not enabled. - -The cmdlet fails if there is no valid location specified. - -## EXAMPLES - -### Example 1: Send data to previously configured location -``` -PS C:\> Send-AppVClientReport -The Application Virtualization Client Report was sent successfully -``` - -This command sends the data to the location that is configured in the client and does not delete the data after sending. - -### Example 2: Send data to previously configured location and delete data -``` -PS C:\> Send-AppVClientReport -DeleteOnSuccess -Tee Application Virtualization Client Report was sent successfully -``` - -This command sends the data to the location that is configured in the client and deletes the data after sending. - -### Example 3: Send data to specified location and delete data -``` -PS C:\> Send-AppVClientReport -URL "http://myreportingserver:port" -DeleteOnSuccess -The Application Virtualization Client Report was sent successfully -``` - -This command sends the data to the location specified by the URL parameter and deletes the data after sending. - -### Example 4: Send data to incorrect location -``` -PS C:\> Send-AppVClientReport -URL "http://incorrectservername:port" -DeleteOnSuccess -The reporting server or share location has not been specified. You must specify the reporting server or share location using the following format: -Url -``` - -This command tries to send the data to the location specified by the URL parameter but since the server name is incorrect, the sending action fails and an error is returned. -The data is not deleted. - -## PARAMETERS - -### -DeleteOnSuccess -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkCostAware -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -URL -Specifies the location on the reporting server where client information is saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AppvClientConfiguration](./get-appvclientconfiguration.md) - -[Set-AppvClientConfiguration](./set-appvclientconfiguration.md) diff --git a/docset/mdop/appvclient/set-appvclientconfiguration.md b/docset/mdop/appvclient/set-appvclientconfiguration.md deleted file mode 100644 index e604301d25..0000000000 --- a/docset/mdop/appvclient/set-appvclientconfiguration.md +++ /dev/null @@ -1,550 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvClientConfiguration ---- - -# Set-AppvClientConfiguration - -## SYNOPSIS -Applies configuration settings to the App-V Client. - -## SYNTAX - -``` -Set-AppvClientConfiguration [-AllowHighCostLaunch ] [-AutoLoad ] - [-CertFilterForClientSsl ] [-EnablePackageScripts ] [-EnablePublishingRefreshUI ] - [-IntegrationRootGlobal ] [-IntegrationRootUser ] [-LocationProvider ] - [-MigrationMode ] [-PackageInstallationRoot ] [-PackageSourceRoot ] - [-RequirePublishAsAdmin ] [-ReestablishmentInterval ] [-ReestablishmentRetries ] - [-ReportingDataBlockSize ] [-ReportingDataCacheLimit ] [-ReportingEnabled ] - [-ReportingInterval ] [-ReportingRandomDelay ] [-ReportingServerURL ] - [-ReportingStartTime ] [-RoamingFileExclusions ] [-RoamingRegistryExclusions ] - [-SharedContentStoreMode ] [-VerifyCertificateRevocationList ] - [-ExperienceImprovementOptIn ] [-ProcessesUsingVirtualComponents ] - [-EnableDynamicVirtualization ] [-IgnoreLocationProvider ] [-SupportBranchCache ] - [] -``` - -## DESCRIPTION -The **Set-AppvClientConfiguration** cmdlet applies configuration settings to the Microsoft Application Virtualization (App-V) client. -Each parameter represents a setting that can be changed. - -## EXAMPLES - -### Example 1: Set a client configuration parameter -``` -PS C:\> Set-AppvClientConfiguration -parameter1 "parameterVal1" -``` - -This schematic example sets a particular client configuration parameter. - -## PARAMETERS - -### -AllowHighCostLaunch -Specifies whether virtualized applications are launched on Windows 8 computers connected via a metered network connection (e.g. -4G). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoLoad -Specifies how new packages should be loaded automatically by App-V on a specific computer. -Valid values are: - -- 0 for None -- 1 for Previously used -- 2 for All - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertFilterForClientSsl -Specifies the path to a valid certificate in the certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableDynamicVirtualization -Specifies whether to enable dynamic virtualization. -Dynamic virtualization allows supported Shell Extensions, Browser Helper Objects, and Active X controls to be virtualized and work with virtual applications. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnablePackageScripts -Specifies whether to enable the ability for scripts defined in the package manifest of configuration files to run. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnablePublishingRefreshUI -Specifies whether to enable the publishing refresh progress bar for the Client. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExperienceImprovementOptIn -Specifies whether to opt in ($True) or opt out ($False) of the Customer Experience Improvement Program. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocationProvider -Specifies whether to force the client to ignore the Location Provider path and instead use the Package Source Root. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntegrationRootGlobal -Specifies the location to create symbolic links associated with the current version of a globally published package. -All virtual application extensions, for example shortcuts and file type associations, will point to this path. -If you do not specify a path, symbolic links will not be used when you publish the package. -For example: %allusersprofile%\Microsoft\AppV\Client\Integration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntegrationRootUser -Specifies the location to create symbolic links associated with the current version of a per-user published package. -All virtual application extensions, for example shortcuts and file type associations, will point to this path. -If you do not specify a path, symbolic links will not be used when you publish the package. -For example: %localappdata%\Microsoft\AppV\Client\Integration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocationProvider -Specifies the class ID (CLSID) for a compatible implementation of the IAppvPackageLocationProvider interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationMode -Specifies whether to use migration mode. -Migration mode allows the App-V client to control shortcuts and FTAs for packages published using a previous version of App-V . - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageInstallationRoot -Specifies directory where all new applications and updates are installed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageSourceRoot -Specifies a value that overrides source location for downloading package content. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessesUsingVirtualComponents -Specifies a list of process paths which are candidates for using dynamic virtualization of supported shell extensions, browser helper objects, and ActiveX controls. -This parameter may contain wildcards. -Only processes whose full path matches one of these items can use dynamic virtualization. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReestablishmentInterval -Specifies the number of seconds between attempts to reestablish a dropped session. -Valid values are: between 0 and 3600. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReestablishmentRetries -Specifies the number of times to retry a dropped session. -Valid values are: between 0 and 99. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingDataBlockSize -Specifies the maximum size in bytes to transmit to the server for reporting upload requests. -This can help avoid permanent transmission failures when the log has reached a significant size. -Valid values are: between 1024 and unlimited. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingDataCacheLimit -Specifies the maximum size in megabytes (MB) of the XML cache for storing reporting information. -The size applies to the cache in memory. -When the limit is reached, the log file will roll over. -Valid values are: between 0 and 1024. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingEnabled -Specifies whether to enable the client to return information to a reporting server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingInterval -Specifies the retry interval that the client uses to resend data to the reporting server. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingRandomDelay -Specifies the maximum delay, in minutes, for data to be sent to the reporting server. -When the scheduled task is started, the client generates a random delay between 0 and *ReportingRandomDelay* and waits the specified duration before sending data. -This can help to prevent collisions on the server. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingServerURL -Specifies the location on the reporting server where client information is saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportingStartTime -Specifies the time to initiate the client to send data to the reporting server. -Valid values are: integers between 0-23 corresponding to the hour of the day. -By default, the *ReportingStartTime* starts on the current day at 10 P.M or 22. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequirePublishAsAdmin -(Applicable starting in App-V 5.0 SP3.) Specifies whether an unelevated user can publish registered App-V packages. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoamingFileExclusions -Specifies the file paths relative to %userprofile% that do not roam with a user's profile. -Example usage: `-RoamingFileExclusions='desktop;my pictures'`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RoamingRegistryExclusions -Specifies the registry paths that do not roam with a user profile. -Example usage: `-RoamingRegistryExclusions=software\\\\classes;software\\\\clients`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedContentStoreMode -Specifies whether streamed package contents are not saved to the local hard disk. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SupportBranchCache -Specifies whether branch caching is turned on. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VerifyCertificateRevocationList -Specifies whether to verify Server certificate revocation status before steaming using HTTPS. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConfiguration - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientConfiguration -The object is displayed as a two column table. -The first column contains the specific configuration and the second column contains the associated current value. - -In the case where the name/value option is passed, the cmdlet returns the same two column table, but only for the configuration requested. - -## NOTES -* Before applying new configuration, the cmdlet checks if Group Policy already owns any configuration by checking HKLM\Software\Policies\Microsoft\Application Virtualization. If any of the provided configuration is in the GP registry node, the cmdlet fail.s If GP does not own any of the supplied configuration, the settings are written to the HKLM\Software\Microsoft\AppV registry node. If the cmdlet is attempting to modify multiple settings, if any are owned by GP, the entire operation fails. -* In the case where GP owns the setting, the cmdlet returns the following error: The App-V configuration trying to be modified is being managed by Group Policy. The cmdlet cannot perform the modification. An error code is returned. -* If any of the provided configuration are not valid App-V Client settings, the cmdlet fails and returns an error. -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns an error. -* If the action to set a property fails, the cmdlet returns an error. - -## RELATED LINKS - -[Get-AppvClientConfiguration](./get-appvclientconfiguration.md) diff --git a/docset/mdop/appvclient/set-appvclientmode.md b/docset/mdop/appvclient/set-appvclientmode.md deleted file mode 100644 index d83a478708..0000000000 --- a/docset/mdop/appvclient/set-appvclientmode.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvClientMode ---- - -# Set-AppvClientMode - -## SYNOPSIS -Sets the mode the client is running in. - -## SYNTAX - -### Normal -``` -Set-AppvClientMode [-Normal] [] -``` - -### Uninstall -``` -Set-AppvClientMode [-Uninstall] [] -``` - -## DESCRIPTION -The **Set-AppvClientMode** cmdlet sets the mode the client is running in. -By default, the cmdlet is set to *Normal* and the Microsoft Application Virtualization (App-V) Client runs normally. -If the *Uninstall* parameter is specified, the App-V Client prevents all client activity from happening which includes adding and publishing packages, along with creating virtual environments. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -Normal -Indicates that the App-V Client functions normally. -This means all adding and publishing of App-V packages and creating of Virtual environments will function normally. - -```yaml -Type: SwitchParameter -Parameter Sets: Normal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uninstall -Indicates that prevents the App-V Client from adding and publishing packages or creating any virtual environments. -This is set to enable an uninstall of the App-V Client to properly occur. - -```yaml -Type: SwitchParameter -Parameter Sets: Uninstall -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AppvClientMode](./get-appvclientmode.md) diff --git a/docset/mdop/appvclient/set-appvclientpackage.md b/docset/mdop/appvclient/set-appvclientpackage.md deleted file mode 100644 index 5d53377163..0000000000 --- a/docset/mdop/appvclient/set-appvclientpackage.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvClientPackage ---- - -# Set-AppvClientPackage - -## SYNOPSIS -Configures an App-V Client Package. - -## SYNTAX - -### ByGuid (Default) -``` -Set-AppvClientPackage [-Path ] [-DynamicDeploymentConfiguration ] [-UseNoConfiguration] - [-PackageId] [-VersionId] [] -``` - -### ByPackage -``` -Set-AppvClientPackage [-Path ] [-DynamicDeploymentConfiguration ] [-UseNoConfiguration] - [-Package] [] -``` - -### ByName -``` -Set-AppvClientPackage [-Path ] [-DynamicDeploymentConfiguration ] [-UseNoConfiguration] - [-Name] [[-Version] ] [] -``` - -## DESCRIPTION -The **Set-AppvClientPackage** cmdlet modifies the configuration files of a Microsoft Application Virtualization (App-V) package. - -## EXAMPLES - -### Example 1: Set a deployment configuration for a package -``` -PS C:\> Set-AppvClientPackage -Name "MyApp" -Version 1 -DynamicDeploymentConfiguration "C:\policies\MyApp.xml" -``` - -This command sets a new deployment configuration for a package. - -## PARAMETERS - -### -DynamicDeploymentConfiguration -Specifies the path to a Dynamic Deployment Configuration file for the App-V package to be added. -The cmdlet uses the Dynamic Deployment Configuration file to override the default behavior provided in the package manifest. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during Sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified. - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies the GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the App-V Sequencer. -The package ID is shared by all versions of a specific package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path specifies the location of the .APPV file containing the package to be added. -This parameter can point to a local directory, a network directory, or an HTTP or HTTPS URL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PSPath - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseNoConfiguration -Indicates that the cmdlet applies the default computer policy to the selected package. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in a lineage. -If you do not specify this parameter, the cmdlet operates on all available versions of the package on the target computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## NOTES - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/set-appvpublishingserver.md b/docset/mdop/appvclient/set-appvpublishingserver.md deleted file mode 100644 index cac45cf5e7..0000000000 --- a/docset/mdop/appvclient/set-appvpublishingserver.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvPublishingServer ---- - -# Set-AppvPublishingServer - -## SYNOPSIS -Modifies properties of an App-V Publishing Server. - -## SYNTAX - -### ByServerId (Default) -``` -Set-AppvPublishingServer [-ServerId] [[-GlobalRefreshEnabled] ] - [[-GlobalRefreshOnLogon] ] [[-GlobalRefreshInterval] ] - [[-GlobalRefreshIntervalUnit] ] [[-UserRefreshEnabled] ] - [[-UserRefreshOnLogon] ] [[-UserRefreshInterval] ] - [[-UserRefreshIntervalUnit] ] [] -``` - -### ByObject -``` -Set-AppvPublishingServer [-Server] [[-GlobalRefreshEnabled] ] - [[-GlobalRefreshOnLogon] ] [[-GlobalRefreshInterval] ] - [[-GlobalRefreshIntervalUnit] ] [[-UserRefreshEnabled] ] - [[-UserRefreshOnLogon] ] [[-UserRefreshInterval] ] - [[-UserRefreshIntervalUnit] ] [] -``` - -## DESCRIPTION -The **Set-AppvPublishingServer** cmdlet modifies properties of an already existing Microsoft Application Virtualization (App-V) Publishing Server. -To obtain an App-V Publishing Server object, use the **Get-AppVPublishingServer** cmdlet. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -GlobalRefreshEnabled -Specifies whether the server does automatic syncs with the publishing server for all globally published packages. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalRefreshInterval -Specifies a time span representing the period where refreshes occur for packages published globally. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalRefreshIntervalUnit -Specifies the unit of time measurement. -Valid values are: day and hour. - -```yaml -Type: IntervalUnit -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Day - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GlobalRefreshOnLogon -Specifies whether a refresh occurs for all package published globally every time a user logs into the target computer. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Not Specified. - -```yaml -Type: AppvPublishingServer -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerId -Specifies the identifier for the App-V Publishing Server. -This can be queried using the **Get-AppvPublishingServer** cmdlet. - -```yaml -Type: UInt32 -Parameter Sets: ByServerId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshEnabled -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshInterval -Specifies a time span representing the period when refreshes occur for packages published to the user. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshIntervalUnit -Specifies the unit of time measurement. -Valid values are: day and hour. - -```yaml -Type: IntervalUnit -Parameter Sets: (All) -Aliases: -Accepted values: Hour, Day - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserRefreshOnLogon -Specifies whether a refresh occurs every time a user logs into the computer. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvPublishingServer - -## OUTPUTS - -### Microsoft.AppvAgent.AppvPublishingServer - -## NOTES - -## RELATED LINKS - -[Add-AppvPublishingServer](./add-appvpublishingserver.md) - -[Get-AppvPublishingServer](./get-appvpublishingserver.md) - -[Remove-AppvPublishingServer](./remove-appvpublishingserver.md) - -[Sync-AppvPublishingServer](./sync-appvpublishingserver.md) diff --git a/docset/mdop/appvclient/start-appvvirtualprocess.md b/docset/mdop/appvclient/start-appvvirtualprocess.md deleted file mode 100644 index 748fa01f64..0000000000 --- a/docset/mdop/appvclient/start-appvvirtualprocess.md +++ /dev/null @@ -1,299 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVClientCmdlets-help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Start-AppvVirtualProcess ---- - -# Start-AppvVirtualProcess - -## SYNOPSIS -Starts a virtual process. - -## SYNTAX - -### Default (Default) -``` -Start-AppvVirtualProcess [-FilePath] [[-ArgumentList] ] [-Credential ] - [-WorkingDirectory ] [-LoadUserProfile] [-NoNewWindow] [-PassThru] [-RedirectStandardError ] - [-RedirectStandardInput ] [-RedirectStandardOutput ] [-Wait] [-UseNewEnvironment] - -AppvClientObject [] -``` - -### UseShellExecute -``` -Start-AppvVirtualProcess [-FilePath] [[-ArgumentList] ] [-WorkingDirectory ] - [-PassThru] [-Verb ] [-Wait] [-WindowStyle ] -AppvClientObject - [] -``` - -## DESCRIPTION -The **Start-AppvVirtualProcess** cmdlet starts a new virtual process. - -## EXAMPLES - -### Example 1: Start a virtual process in a virtual environment of a package -``` -PS C:\>$AppVObj = Get-AppvClientPackage -Name "MyPackage" -PS C:\> Start-AppvVirtualProcess -FilePath "C:\Calc.exe" -AppvClientObject $AppVObj -``` - -This example starts a new virtual process for Calc.exe in virtual environment of MyPackage. - -### Example 2: Start a virtual process in a virtual environment of a connection group -``` -PS C:\>$AppVObj = Get-AppvClientConnectionGroup -Name MyConnectionGroup -PS C:\> Start-AppvVirtualProcess -FilePath "C:\Calc.exe" -AppvClientObject $AppVObj -``` - -This example starts a new virtual process for Calc.exe in the virtual environment of MyConnectionGroup. - -## PARAMETERS - -### -AppvClientObject -Specifies an **AppvClientPackage** or **AppvClientConnectionGroup** object. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArgumentList -Specifies the arguments to be passed into the virtual process. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Args - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the credential to start this process. - -```yaml -Type: PSCredential -Parameter Sets: Default -Aliases: RunAs - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePath -```yaml -Type: String -Parameter Sets: (All) -Aliases: PSPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadUserProfile -```yaml -Type: SwitchParameter -Parameter Sets: Default -Aliases: Lup - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoNewWindow -Indicates that the cmdlet attempts to keep the process in the same window instead of opening a new window. - -```yaml -Type: SwitchParameter -Parameter Sets: Default -Aliases: nnw - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectStandardError -Redirects the stderr to the file specified. - -```yaml -Type: String -Parameter Sets: Default -Aliases: RSE - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectStandardInput -Takes the stdinput from the file specified. - -```yaml -Type: String -Parameter Sets: Default -Aliases: RSI - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectStandardOutput -Redirects the stdout to the file specified. - -```yaml -Type: String -Parameter Sets: Default -Aliases: RSO - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseNewEnvironment -```yaml -Type: SwitchParameter -Parameter Sets: Default -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verb -```yaml -Type: String -Parameter Sets: UseShellExecute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Indicates that the cmdlet uses synchronous operation of the virtual process. -The cmdlet waits to exit until the virtual process exits. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowStyle -Specifies what to do in the absence of a Process Window Style. -Valid values are: - -- Normal. -Display the normal window. -- Hidden. -Launch a hidden window. -- Minimized. -Launch a minimized window. -- Maximized. -Launch a maximized window. - -The default value is Normal. - -```yaml -Type: ProcessWindowStyle -Parameter Sets: UseShellExecute -Aliases: -Accepted values: Normal, Hidden, Minimized, Maximized - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorkingDirectory -Specifies working directory of the process. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-AppvVirtualProcess](./get-appvvirtualprocess.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) diff --git a/docset/mdop/appvclient/stop-appvclientconnectiongroup.md b/docset/mdop/appvclient/stop-appvclientconnectiongroup.md deleted file mode 100644 index bf1ebb5c20..0000000000 --- a/docset/mdop/appvclient/stop-appvclientconnectiongroup.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Stop-AppvClientConnectionGroup ---- - -# Stop-AppvClientConnectionGroup - -## SYNOPSIS -Shuts down the shared virtual environment of a connection group. - -## SYNTAX - -### ByGuid (Default) -``` -Stop-AppvClientConnectionGroup [-Global] [-GroupId] [-VersionId] [] -``` - -### ByName -``` -Stop-AppvClientConnectionGroup [-Global] [-Name] [] -``` - -### ByConnectionGroup -``` -Stop-AppvClientConnectionGroup [-Global] [-ConnectionGroup] [] -``` - -## DESCRIPTION -The **Stop-AppvClientConnectionGroup** cmdlet shuts down the shared virtual environment of a connection group. -All running processes within the connection group virtual environment are shutdown. - -## EXAMPLES - -### Example 1: Stop a virtual environment for a named group -``` -PS C:\> Stop-AppvClientConnectionGroup -Name "MyGroup" -``` - -This command stops the virtual environment of the enabled connection group that has the name MyGroup. - -### Example 2: Stop a virtual environment for a group by using its ID -``` -PS C:\> Stop-AppvClientConnectionGroup -GroupID 793afd37-bd68-4ea1-859a-669f6afd0aa8 -``` - -This command stops the virtual environment of the enabled connection group with the group ID 793afd37-bd68-4ea1-859a-669f6afd0aa8. - -### Example 3: Stop virtual environment for groups with names that match a string -``` -PS C:\> Get-AppvClientConnectionGroup -Name "MyGr*" | Stop-AppvClientConnectionGroup -``` - -This command gets all of the enabled connection groups that have the string MyGr in the name, and then stops each of their virtual environments. - -## PARAMETERS - -### -ConnectionGroup -Not Specified - -```yaml -Type: AppvClientConnectionGroup -Parameter Sets: ByConnectionGroup -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Global -Indicates that the cmdlet shuts down virtual environments for the specified connection groups for all users on the computer. -Usage of the *Global* parameter requires administrative privileges. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupId -Specifies the group ID of a specific connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Microsoft Application Virtualization (App-V) connection group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a connection group version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientConnectionGroup - -## OUTPUTS - -## NOTES -* The cmdlet checks that you have permissions to perform the specific action. If not, the cmdlet returns an error. -* If the enable operation fails, the cmdlet returns an error. -* If the cmdlet cannot find the connection group on the target computer, the cmdlet returns an error. - -## RELATED LINKS - -[Add-AppvClientConnectionGroup](./add-appvclientconnectiongroup.md) - -[Disable-AppvClientConnectionGroup](./disable-appvclientconnectiongroup.md) - -[Enable-AppvClientConnectionGroup](./enable-appvclientconnectiongroup.md) - -[Get-AppvClientConnectionGroup](./get-appvclientconnectiongroup.md) - -[Mount-AppvClientConnectionGroup](./mount-appvclientconnectiongroup.md) - -[Remove-AppvClientConnectionGroup](./remove-appvclientconnectiongroup.md) - -[Repair-AppvClientConnectionGroup](./repair-appvclientconnectiongroup.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) diff --git a/docset/mdop/appvclient/stop-appvclientpackage.md b/docset/mdop/appvclient/stop-appvclientpackage.md deleted file mode 100644 index 789720a350..0000000000 --- a/docset/mdop/appvclient/stop-appvclientpackage.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Stop-AppvClientPackage ---- - -# Stop-AppvClientPackage - -## SYNOPSIS -Shuts down virtual environments for specified packages. - -## SYNTAX - -### ByGuid (Default) -``` -Stop-AppvClientPackage [-Global] [-PackageId] [-VersionId] [] -``` - -### ByPackage -``` -Stop-AppvClientPackage [-Global] [-Package] [] -``` - -### ByName -``` -Stop-AppvClientPackage [-Global] [-Name] [[-Version] ] [] -``` - -## DESCRIPTION -The **Stop-AppvClientPackage** cmdlet shuts down the virtual environment for the specified packages. -All applications and processes within that package are forced to shut down. -Any unsaved application data is lost. - -## EXAMPLES - -### Example 1: Shut down a virtual environment for a version of a package -``` -PS C:\> Stop-AppvClientPackage -Name "MyPackage" -Version 2 -``` - -This command shuts down the virtual environment of version 2 of package named MyPackage. - -### Example 2: Shut down a virtual environment for all versions of a package -``` -PS C:\> Get-AppvClientPackage -Name "MyPackage" | Stop-AppvClientPackage -``` - -This command gets all versions of the package named MyPackage, and then shuts down the virtual environment for those results. - -## PARAMETERS - -### -Global -Specifies that the cmdlet shuts down virtual environments for the specified packages for all users on the computer. -Usage of *Global* parameter requires administrative privileges. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during Sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies a GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) Sequencer. -The package ID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in a lineage. -If you do not specify this parameter, the cmdlet operateson all available versions of the package on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## NOTES - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Unpublish-AppvClientPackage](./unpublish-appvclientpackage.md) diff --git a/docset/mdop/appvclient/sync-appvpublishingserver.md b/docset/mdop/appvclient/sync-appvpublishingserver.md deleted file mode 100644 index e33f01d9c1..0000000000 --- a/docset/mdop/appvclient/sync-appvpublishingserver.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Sync-AppvPublishingServer ---- - -# Sync-AppvPublishingServer - -## SYNOPSIS -Initiates the App-V Publishing Refresh operation. - -## SYNTAX - -### ByServerId (Default) -``` -Sync-AppvPublishingServer [-ServerId] [-Global] [-Force] [-NetworkCostAware] - [-HidePublishingRefreshUI] [] -``` - -### ByObject -``` -Sync-AppvPublishingServer [-Server] [-Global] [-Force] [-NetworkCostAware] - [-HidePublishingRefreshUI] [] -``` - -### ByNameUrl -``` -Sync-AppvPublishingServer [[-Name] ] [[-URL] ] [-Global] [-Force] [-NetworkCostAware] - [-HidePublishingRefreshUI] [] -``` - -## DESCRIPTION -The **Sync-AppvPublishingServer** cmdlet Initiates the Microsoft Application Virtualization (App-V) publishing refresh operation in the context of the current user. -The publishing refresh connects to all added servers on the client and expose new App-V packages and their respective extension points to the user. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Sync-AppvPublishingServer -Name "MyServer" -``` - -## PARAMETERS - -### -Force -Indicates that the cmdlet forces all publishes and unpublishes of packages. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Global -Indicates that the cmdlet synchronizes packages from the App-V publishing server that are provisioned to the computer and are published to all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HidePublishingRefreshUI -Indicates that the cmdlet suppresses the Publishing Refresh Progress bar. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the server. - -```yaml -Type: String -Parameter Sets: ByNameUrl -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkCostAware -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Not Specified. - -```yaml -Type: AppvPublishingServer -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ServerId -```yaml -Type: UInt32 -Parameter Sets: ByServerId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -URL -Specifies the URL path to the server. - -```yaml -Type: String -Parameter Sets: ByNameUrl -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-AppvPublishingServer](./add-appvpublishingserver.md) - -[Get-AppvPublishingServer](./get-appvpublishingserver.md) - -[Remove-AppvPublishingServer](./remove-appvpublishingserver.md) - -[Set-AppvPublishingServer](./set-appvpublishingserver.md) - -[Sync-AppvPublishingServer](./sync-appvpublishingserver.md) diff --git a/docset/mdop/appvclient/unpublish-appvclientpackage.md b/docset/mdop/appvclient/unpublish-appvclientpackage.md deleted file mode 100644 index 080f08381e..0000000000 --- a/docset/mdop/appvclient/unpublish-appvclientpackage.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.AppVClientPowerShell.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Unpublish-AppvClientPackage ---- - -# Unpublish-AppvClientPackage - -## SYNOPSIS -Removes the extension points for packages. - -## SYNTAX - -### ByGuid (Default) -``` -Unpublish-AppvClientPackage [-Global] [-UserSID ] [-PackageId] [-VersionId] - [] -``` - -### ByPackage -``` -Unpublish-AppvClientPackage [-Global] [-UserSID ] [-Package] [] -``` - -### ByName -``` -Unpublish-AppvClientPackage [-Global] [-UserSID ] [-Name] [[-Version] ] - [] -``` - -## DESCRIPTION -The **Unpublish-AppvClientPackage** cmdlet removes all the extension points of the specified packages. -The package contents remain on the target computer. -The package is still added on the client and the appropriate **AppvClientPackage** object persists. - -The package can be unpublished for the current user or if all users that log on to the target computer. - -## EXAMPLES - -### Example 1: Unpublish a version of a package -``` -PS C:\> Unpublish-AppvClientPackage -Name "MyApp" -Version 3 -``` - -This command unpublishes version 3 of the package named MyApp. - -### Example 2: Unpublish a version of a package for all users -``` -PS C:\> Unpublish-AppvClientPackage -Name "Myapp" -Version 3 -Global -``` - -This command unpublishes version 3 of the package named MyApp for all users on the computer. - -## PARAMETERS - -### -Global -Indicates that the packages are unpublished to all users that log into the targeted computer. -Otherwise, the packages are only unpublished to the currently running user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during Sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Not Specified. - -```yaml -Type: AppvClientPackage -Parameter Sets: ByPackage -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PackageId -Specifies a GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) Sequencer. -The package ID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSID -Specifies the SID of the intended user, in the form of S-1-2-34-56789012-3456789012-345678901-2345. -This cmdlet parameter requires elevated rights to run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one specific lineage. -If you do not specify this parameter, the cmdlet operates on the latest version found. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionId -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on the latest version of the package. - -```yaml -Type: Guid -Parameter Sets: ByGuid -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## OUTPUTS - -### Microsoft.AppvAgent.AppvClientPackage - -## NOTES - -## RELATED LINKS - -[Add-AppvClientPackage](./add-appvclientpackage.md) - -[Get-AppvClientPackage](./get-appvclientpackage.md) - -[Mount-AppvClientPackage](./mount-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Publish-AppvClientPackage](./publish-appvclientpackage.md) - -[Remove-AppvClientPackage](./remove-appvclientpackage.md) - -[Repair-AppvClientPackage](./repair-appvclientpackage.md) - -[Set-AppvClientPackage](./set-appvclientpackage.md) - -[Stop-AppvClientPackage](./stop-appvclientpackage.md) diff --git a/docset/mdop/appvsequencer/appvsequencer.md b/docset/mdop/appvsequencer/appvsequencer.md deleted file mode 100644 index 4e23361ed6..0000000000 --- a/docset/mdop/appvsequencer/appvsequencer.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=403113 -Help Version: 4.0.0.0 -Locale: en-US -Module Guid: 120C1A42-E4B5-4FCF-9DBD-D416BD3B41F5 -Module Name: AppVSequencer -ms.date: 12/05/2016 -ms.devlang: powershell -title: AppVSequencer ---- - -# AppVSequencer Module -## Description -The following list contains links to the help topics for the App-V Sequencer cmdlets. - -## AppVSequencer Cmdlets -### [Expand-AppvSequencerPackage](./Expand-AppvSequencerPackage.md) -Expands an existing App-V package. - -### [New-AppvPackageAccelerator](./New-AppvPackageAccelerator.md) -Generates a new package accelerator. - -### [New-AppvSequencerPackage](./New-AppvSequencerPackage.md) -Creates a new App-V package. - -### [Update-AppvSequencerPackage](./Update-AppvSequencerPackage.md) -Upgrades virtual application packages. - diff --git a/docset/mdop/appvsequencer/expand-appvsequencerpackage.md b/docset/mdop/appvsequencer/expand-appvsequencerpackage.md deleted file mode 100644 index c25df39302..0000000000 --- a/docset/mdop/appvsequencer/expand-appvsequencerpackage.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.Modernizer.Cmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Expand-AppvSequencerPackage ---- - -# Expand-AppvSequencerPackage - -## SYNOPSIS -Expands an existing App-V package. - -## SYNTAX - -``` -Expand-AppvSequencerPackage [-AppvPackagePath] [] -``` - -## DESCRIPTION -The **Expand-AppvSequencerPackage** cmdlet expands a Microsoft Application Virtualization (App-V) package into its native form to the NTFS file system on the computer running the sequencer. -You can more easily add prerequisites or dependent applications to the sequencer before generating the package. - -Run this cmdlet each time to expand a new package onto the computer running the sequencer. - -## EXAMPLES - -### Example 1: Expand a package -``` -PS C:\> Expand-AppvSequencerPackage -AppvPackageFilePath "C:\MyPackages\PreReq.appv" -``` - -This command expands the package PreReq.appv to the sequencing computer. - -## PARAMETERS - -### -AppvPackagePath -Specifies the file path to an existing App-V package to be expanded to the NTFS file system of the computer running the cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: AppvPackage - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/appvsequencer/new-appvpackageaccelerator.md b/docset/mdop/appvsequencer/new-appvpackageaccelerator.md deleted file mode 100644 index 378d0c66d6..0000000000 --- a/docset/mdop/appvsequencer/new-appvpackageaccelerator.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.Modernizer.Cmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: New-AppvPackageAccelerator ---- - -# New-AppvPackageAccelerator - -## SYNOPSIS -Generates a new package accelerator. - -## SYNTAX - -### FromInstaller (Default) -``` -New-AppvPackageAccelerator [-InputPackagePath] [-Installer] - [-AcceleratorDescriptionFile ] [-Path] [] -``` - -### FromInstalledMedia -``` -New-AppvPackageAccelerator [-InputPackagePath] [-InstalledFilesPath] - [-AcceleratorDescriptionFile ] [-Path] [] -``` - -## DESCRIPTION -The **New-AppvPackageAccelerator** cmdlet generates a new package accelerator object. -It accepts an existing Application Virtualization (App-V) 5.0 package file along with the appropriately installed files or install media. -The cmdlet then generates a package accelerator file. - -## EXAMPLES - -### Example 1: Create a package accelerator -``` -PS C:\> New-AppvPackageAccelerator -AppvPackageFilePath "C:\MyPackages\Package1\Package1.appv" -Installer "C:\MyPackages\Package1" -OutputPath "C:\Output\packages\Package1.cab" -``` - -This command creates a package accelerator using an installer folder containing, for example, Windows Installer packages. - -### Example 2: Create a package accelerator with instruction sheet -``` -PS C:\> New-AppvPackageAccelerator -AppvPackageFilePath "C:\MyPackages\Package1\Package1.appv" -InstalledFilesPath "C:\Program Files\Package1InstallFolder" -OutputPath "C:\Output\packages\Package1.cab" -AcceleratorDescriptionFilePath "C:\MyPackages\Package1\Package1Description.rtf" -``` - -This command creates a package accelerator and inserts an instruction sheet on how to accelerate package. - -## PARAMETERS - -### -AcceleratorDescriptionFile -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputPackagePath -Specifies the path to the App-V package used as input to generate the accelerator from. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstalledFilesPath -Specifies the path to the folder containing the directory where the package is installed to, to generate an accelerator for. - -```yaml -Type: String -Parameter Sets: FromInstalledMedia -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Installer -Specifies the path to the folder of the application installer to generate an accelerator from. -The installer must be an .msi file, or .cab file, or .zip file. -If you do not have an installer of this format, use the *InstalledFilesPath* parameter instead. - -```yaml -Type: String -Parameter Sets: FromInstaller -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the .cab package accelerator output file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: OutputPath - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Expand-AppvSequencerPackage](./Expand-AppvSequencerPackage.md) - -[Update-AppvSequencerPackage](./Update-AppvSequencerPackage.md) - - diff --git a/docset/mdop/appvsequencer/new-appvsequencerpackage.md b/docset/mdop/appvsequencer/new-appvsequencerpackage.md deleted file mode 100644 index 948a82bd68..0000000000 --- a/docset/mdop/appvsequencer/new-appvsequencerpackage.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.Modernizer.Cmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: New-AppvSequencerPackage ---- - -# New-AppvSequencerPackage - -## SYNOPSIS -Creates a new App-V package. - -## SYNTAX - -### ByInstallerFullLoad (Default) -``` -New-AppvSequencerPackage [-FullLoad] [-Installer] [[-PrimaryVirtualApplicationDirectory] ] - [-Name] [-Path] [-TemplateFilePath ] [] -``` - -### ByPackageAcceleratorInstallMedia -``` -New-AppvSequencerPackage [-AcceleratorFilePath] [-InstallMediaPath] [-Name] - [-Path] [] -``` - -### ByPackageAcceleratorInstalledFiles -``` -New-AppvSequencerPackage [-AcceleratorFilePath] [-InstalledFilesPath] [-Name] - [-Path] [] -``` - -## DESCRIPTION -The **New-AppvSequencerPackage** cmdlet creates a new Microsoft Application Virtualization (App-V) package, either using an installer, an App-V accelerator, or an accelerator with an installed application. -The cmdlet accepts a template file, as well as the option to force the package to be fully streamed to the computer before running the package. - -## EXAMPLES - -### Example 1: Create a package -``` -PS C:\> New-AppvSequencerPackage -Name "MyPackage" -OutputPath "C:\MyPackage" -PrimaryVirtualApplicationDirectory "C:\Program Files\MyApp" -Installer "C:\installers\MyApp\setup.exe" -``` - -This command creates a package for the application MyApp. - -### Example 2: Create a package that must be fully downloaded -``` -PS C:\> New-AppvSequencerPackage -Name MyPackage2 -OutputPath C:\MyPackages -PrimaryVirtualApplicationDirectory "C:\Program Files\MyApp -Installer C:\installers\MyApp\setup.exe -FullLoad -``` - -This command creates a package that must be fully downloaded for the application MyApp. - -### Example 3: Create a package using a pre-generated accelerator -``` -PS C:\> New-AppvSequencerPackage -Name "MyPackage" -OutputPath "C:\MyPackages" -AcceleratorFilePath "C:\MyAccelerators\MyAccelerator.cab" -PrimaryVirtualApplicationDirectory "C:\MyApp\" -InstalledMediaPath "C:\Installers\PreReq\" -Installer "C:\Installers\MyApp\setup.exe" -``` - -This command creates a new package MyApp using a pre-generated package accelerator. - -### Example 4: Create a package using a template file -``` -PS C:\> New-AppvSequencerPackage -Name "MyPackage" -TemplateFilePath "C:\template.appvt" -OutputPath "C:\Packages\MyPackage" -PrimaryVirtualApplicationDirectory "C:\Program Files\MyApp" -Installer "C:\Installers\MyApp\setup.exe" -``` - -This command creates a new MyApp package using a template file. - -## PARAMETERS - -### -AcceleratorFilePath -Specifies the path to the accelerator file for this package. -If the accelerator is not signed or is not accepted by the Sequencer, an error is returned. - -```yaml -Type: String -Parameter Sets: ByPackageAcceleratorInstallMedia, ByPackageAcceleratorInstalledFiles -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullLoad -Indicates that the package is required to be fully downloaded before being launched. - -```yaml -Type: SwitchParameter -Parameter Sets: ByInstallerFullLoad -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallMediaPath -Specifies the location of the installation media that the Sequencer points to and generates an accelerator. - -```yaml -Type: String -Parameter Sets: ByPackageAcceleratorInstallMedia -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstalledFilesPath -Specifies the location of the already installed files used to create a new App-V package with the aid of an App-V Accelerator. - -```yaml -Type: String -Parameter Sets: ByPackageAcceleratorInstalledFiles -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Installer -Specifies a collection of MSIs, setup executables, or other executables needed to be run to create the App-V package. - -```yaml -Type: String -Parameter Sets: ByInstallerFullLoad -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the App-V package. -This is also the name of all files outputted by the sequencing process. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the folder where the package is saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: OutputPath - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryVirtualApplicationDirectory -Specifies the location where the application is being installed. -This must be a path on the local computer. - -```yaml -Type: String -Parameter Sets: ByInstallerFullLoad -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateFilePath -Specifies the path to the App-V package template file to be used for this package. - -```yaml -Type: String -Parameter Sets: ByInstallerFullLoad -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Null - -## NOTES - -## RELATED LINKS - -[Expand-AppvSequencerPackage](./Expand-AppvSequencerPackage.md) - -[New-AppvPackageAccelerator](./New-AppvPackageAccelerator.md) - -[Update-AppvSequencerPackage](./Update-AppvSequencerPackage.md) - - diff --git a/docset/mdop/appvsequencer/update-appvsequencerpackage.md b/docset/mdop/appvsequencer/update-appvsequencerpackage.md deleted file mode 100644 index 3b56015fcb..0000000000 --- a/docset/mdop/appvsequencer/update-appvsequencerpackage.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.AppV.Modernizer.Cmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Update-AppvSequencerPackage ---- - -# Update-AppvSequencerPackage - -## SYNOPSIS -Upgrades virtual application packages. - -## SYNTAX - -``` -Update-AppvSequencerPackage [-FullLoad] [-InputPackagePath] [-Installer] [-Name] - [-Path] [] -``` - -## DESCRIPTION -The **Update-AppvSequencerPackage** cmdlet upgrades virtual application packages. -It takes as an input the original package, the upgrade installer, and an output path. -The cmdlet returns a package that is upgraded. - -## EXAMPLES - -### Example 1: Update an application -``` -PS C:\> Update-AppvSequencerPackage -AppvPackageFilePath "C:\Packages\MyPackage.appv" -Installer "C:\PackageInstall\PackageUpgrade.exe" -OutputPath "C:\UpgradedPackages" -``` - -This command updates an application, changing the output path. - -### Example 2: Update an application and require package to be fully loaded -``` -PS C:\> Update-AppvSequencerPackage -AppvPackageFilePath "C:\Packages\MyPackage.appv" -Installer "C:\PackageInstall\PackageUpgrade.exe" -OutputPath "C:\UpgradedPackages" -FullLoad -``` - -This command updates an application, and sets the package to be fully loaded. - -## PARAMETERS - -### -FullLoad -Indicates that the cmdlet forces the package to be fully downloaded onto the computer before it can be launched. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputPackagePath -Specifies the path of the existing Microsoft Application Virtualization (App-V) package to upgrade. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Installer -Specifies the installer used to upgrade the App-V package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given during Sequencing time. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the folder where the updated package is to be saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: OutputPath - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Expand-AppvSequencerPackage](./Expand-AppvSequencerPackage.md) - -[New-AppvSequencerPackage](./New-AppvSequencerPackage.md) - - diff --git a/docset/mdop/appvserver/add-appvserverconnectiongrouppackage.md b/docset/mdop/appvserver/add-appvserverconnectiongrouppackage.md deleted file mode 100644 index 4a7c32770a..0000000000 --- a/docset/mdop/appvserver/add-appvserverconnectiongrouppackage.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Add-AppvServerConnectionGroupPackage ---- - -# Add-AppvServerConnectionGroupPackage - -## SYNOPSIS -(Cmdlet applicable starting in App-V 5.0 SP3) Appends a package to a connection group package list. - -## SYNTAX - -### ByObject -``` -Add-AppvServerConnectionGroupPackage [-AppvServerConnectionGroup] - [[-AppvServerPackage] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-Optional] [-UseAnyPackageVersion] [-Order ] [-WhatIf] [-Confirm] - [] -``` - -### ByName -``` -Add-AppvServerConnectionGroupPackage [-ConnectionGroupName] [[-AppvServerPackage] ] - [[-ConnectionGroupVersion] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-Optional] [-UseAnyPackageVersion] [-Order ] [-WhatIf] [-Confirm] - [] -``` - -### ByGUID -``` -Add-AppvServerConnectionGroupPackage [-ConnectionGroupID] [[-ConnectionGroupVersionID] ] - [[-AppvServerPackage] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-Optional] [-UseAnyPackageVersion] [-Order ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Add-AppvServerConnectionGroupPackage** cmdlet appends a package to the end of a connection group package list. -You can configure the package as optional and/or with no version within the connection group. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the connection group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AppvServerPackage -Specifies an **AppVServerPackage** object. - -```yaml -Type: PackageVersion -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectionGroupID -Specifies the GUID of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: GroupID - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupName -Specifies the name of the connection group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupVersion -Specifies the version of the connection group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: Version - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupVersionID -Specifies the GUID of the connection group version. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: VersionID - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Optional -Specifies whether the package is optional. -Optional packages are not required when a connection group virtual environment is started. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Order -Specifies the order in which packages are loaded into the virtual environment. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageVersion -Specifies the version of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageVersionID -Specifies the GUID that uniquely identifies the version of the package. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseAnyPackageVersion -Specifies whether to the latest added package version when the connection group virtual environment is started. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppV.Server.AppVMgmtDataTypes.SerializableConnectionGroup, Microsoft.AppV.Server.AppVMgmtDataTypes.PackageVersion - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Remove-AppvServerConnectionGroupPackage](./Remove-AppvServerConnectionGroupPackage.md) - -[Set-AppvServerConnectionGroupPackage](./Set-AppvServerConnectionGroupPackage.md) - - diff --git a/docset/mdop/appvserver/appvserver.md b/docset/mdop/appvserver/appvserver.md deleted file mode 100644 index ed0e3619d6..0000000000 --- a/docset/mdop/appvserver/appvserver.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=403039 -Help Version: 4.0.3.0 -Locale: en-US -Module Guid: F395C50F-FC15-4FC7-B45C-BBBE0359F08B -Module Name: AppVServer -ms.date: 12/05/2016 -ms.devlang: powershell -title: AppVServer ---- - -# AppVServer Module -## Description -The following list contains links to the help topics for the App-V Server cmdlets. - -## AppVServer Cmdlets -### [Add-AppvServerConnectionGroupPackage](./Add-AppvServerConnectionGroupPackage.md) -(Cmdlet applicable starting in App-V 5.0 SP3) Appends a package to a connection group package list. - -### [Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) -Returns connection groups. - -### [Get-AppvServerPackage](./Get-AppvServerPackage.md) -Returns App-V Server packages. - -### [Get-AppvServerPackageDeploymentConfiguration](./Get-AppvServerPackageDeploymentConfiguration.md) -Returns a set of App-V server dynamic deployment configurations for the packages specified. - -### [Get-AppvServerPackageUserConfiguration](./Get-AppvServerPackageUserConfiguration.md) -Returns App-V Server Dynamic user configurations applied to a user group for a set of packages. - -### [Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) -Entitles a connection group. - -### [Grant-AppvServerPackage](./Grant-AppvServerPackage.md) -Grants an entitlement to a package. - -### [Import-AppvServerPackage](./Import-AppvServerPackage.md) -Adds a package to the App-V Management server. - -### [New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) -Creates an App-V connection group. - -### [Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) -Publishes a connection group. - -### [Publish-AppvServerPackage](./Publish-AppvServerPackage.md) -Publish a package. - -### [Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) -Removes App-V server connection group. - -### [Remove-AppvServerConnectionGroupPackage](./Remove-AppvServerConnectionGroupPackage.md) -(Cmdlet applicable starting in App-V 5.0 SP3) Removes a package from a connection group. - -### [Remove-AppvServerPackage](./Remove-AppvServerPackage.md) -Remove a package from the App-V Management Server. - -### [Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) -Configures an App-V server package group. - -### [Set-AppvServerConnectionGroupPackage](./Set-AppvServerConnectionGroupPackage.md) -(Cmdlet applicable starting in App-V 5.0 SP3) Appends a package to the end of a connection group package list. - -### [Set-AppvServerPackage](./Set-AppvServerPackage.md) -Applies a dynamic deployment or user configuration file to a package. - -### [Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) -Unpublishes connection groups. - -### [Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) -Unpublishes packages. - -### [Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) -Updates the specified connection group. - diff --git a/docset/mdop/appvserver/get-appvserverconnectiongroup.md b/docset/mdop/appvserver/get-appvserverconnectiongroup.md deleted file mode 100644 index e84b769adb..0000000000 --- a/docset/mdop/appvserver/get-appvserverconnectiongroup.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvServerConnectionGroup ---- - -# Get-AppvServerConnectionGroup - -## SYNOPSIS -Returns connection groups. - -## SYNTAX - -### ByName (Default) -``` -Get-AppvServerConnectionGroup [[-Name] ] [[-Version] ] [] -``` - -### ByGUID -``` -Get-AppvServerConnectionGroup [-GroupID] [[-VersionID] ] [] -``` - -## DESCRIPTION -The **Get-AppvServerConnectionGroup** cmdlet returns a list of specified connection group objects. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -GroupID -Specifies the GUID of specific package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the specified package group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionID -Specifies the version GUID of the package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### AppvServer.AppvServerConnectionGroup - -## NOTES -* If the cmdlet cannot find the specified package groups, it returns the following error: The following package group(s) could not be found on the system. It lists the packages. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet returns all existing versions of the package group. -* If you do not specify any parameters, the cmdlet returns a list of all the package groups and subsequent versions on the computer. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/get-appvserverpackage.md b/docset/mdop/appvserver/get-appvserverpackage.md deleted file mode 100644 index b32f9227a6..0000000000 --- a/docset/mdop/appvserver/get-appvserverpackage.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvServerPackage ---- - -# Get-AppvServerPackage - -## SYNOPSIS -Returns App-V Server packages. - -## SYNTAX - -### ByName (Default) -``` -Get-AppvServerPackage [[-Name] ] [[-Version] ] [] -``` - -### By GUID -``` -Get-AppvServerPackage [-PackageID] [[-VersionID] ] [] -``` - -## DESCRIPTION -The **Get-AppvServerPackage** cmdlet returns a set of Microsoft Application Virtualization (App-V) Server packages based on the criteria provided. - -## EXAMPLES - -### Example 1: Return packages that include a partial name -``` -PS C:\> Get-AppvServerPackage -Name "Office*" -``` - -This command returns all packages that have a name that matches the criteria specified in the *Name* parameter. - -### Example 2: Return a single version of a package -``` -PS C:\> Get-AppvServerPackage -Name "Office" -Version "2" -``` - -This command returns the single package that has the specified name and version. - -### Example 3: Return all versions of a package -``` -PS C:\> Get-AppvServerPackage -PackageID A12D32445F -``` - -This command returns all versions of the package that have the specified package GUID. - -### Example 4: Return all the packages -``` -PS C:\> Get-AppvServerPackage -``` - -This command returns a list of all the packages on the system. - -## PARAMETERS - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageID -Specifies the package GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package using the sequencer. -The Package GUID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package. -If you do not specify a version, the cmdlet acts on all versions saved on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a GUID that differentiates a package version from other versions. -If you do not specify a version GUID, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### AppvServer.AppvServerPackage - -## NOTES - -## RELATED LINKS - -[Grant-AppvServerPackage](./Grant-AppvServerPackage.md) - -[Import-AppvServerPackage](./Import-AppvServerPackage.md) - -[Publish-AppvServerPackage](./Publish-AppvServerPackage.md) - -[Remove-AppvServerPackage](./Remove-AppvServerPackage.md) - -[Set-AppvServerPackage](./Set-AppvServerPackage.md) - -[Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/get-appvserverpackagedeploymentconfiguration.md b/docset/mdop/appvserver/get-appvserverpackagedeploymentconfiguration.md deleted file mode 100644 index df0c3083a5..0000000000 --- a/docset/mdop/appvserver/get-appvserverpackagedeploymentconfiguration.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvServerPackageDeploymentConfiguration ---- - -# Get-AppvServerPackageDeploymentConfiguration - -## SYNOPSIS -Returns a set of App-V server dynamic deployment configurations for the packages specified. - -## SYNTAX - -### ByName (Default) -``` -Get-AppvServerPackageDeploymentConfiguration [-Name] [[-Version] ] [] -``` - -### ByObject -``` -Get-AppvServerPackageDeploymentConfiguration [-AppvServerPackage] [] -``` - -### By GUID -``` -Get-AppvServerPackageDeploymentConfiguration [-PackageID] [[-VersionID] ] [] -``` - -## DESCRIPTION -The **Get-AppvServerPackageDeploymentConfiguration** cmdlet returns a set of Microsoft Application Virtualization (App-V) server dynamic deployment configurations for the packages specified. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package applied when the package was created. -This value is obtained using the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package on the computer running the sequencer. -The package GUID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package. -If you do not specify a version, the cmdlet acts on all versions saved on computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a GUID that differentiates a package version from other versions. -If you do not specify a GUID, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -### String, system.string[] - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/appvserver/get-appvserverpackageuserconfiguration.md b/docset/mdop/appvserver/get-appvserverpackageuserconfiguration.md deleted file mode 100644 index bca6c72bbb..0000000000 --- a/docset/mdop/appvserver/get-appvserverpackageuserconfiguration.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-AppvServerPackageUserConfiguration ---- - -# Get-AppvServerPackageUserConfiguration - -## SYNOPSIS -Returns App-V Server Dynamic user configurations applied to a user group for a set of packages. - -## SYNTAX - -### ByName (Default) -``` -Get-AppvServerPackageUserConfiguration -Group [-Name] [] -``` - -### ByObject -``` -Get-AppvServerPackageUserConfiguration [-AppvServerPackage] -Group - [] -``` - -### By GUID -``` -Get-AppvServerPackageUserConfiguration -Group [-PackageID] [[-VersionID] ] - [] -``` - -### By Name -``` -Get-AppvServerPackageUserConfiguration -Group [[-Version] ] [] -``` - -## DESCRIPTION -The **Get-AppvServerPackageUserConfiguration** cmdlet returns a set of Microsoft Application Virtualization (App-V) Server Dynamic user configurations (Strings) applied to a given user group for specified packages. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Group -Specifies the name of the Active Directory group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies a GUID that uniquely identifies the package. -This GUID can be found in the package manifest or by opening the package in the App-V sequencer. -The package GUID is shared by all versions of a specific package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one lineage. -If no version is supplied, the operation acts on all versions saved to computer. - -```yaml -Type: String -Parameter Sets: By Name -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -### System.String[] - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/appvserver/grant-appvserverconnectiongroup.md b/docset/mdop/appvserver/grant-appvserverconnectiongroup.md deleted file mode 100644 index 1164bee5d8..0000000000 --- a/docset/mdop/appvserver/grant-appvserverconnectiongroup.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Grant-AppvServerConnectionGroup ---- - -# Grant-AppvServerConnectionGroup - -## SYNOPSIS -Entitles a connection group. - -## SYNTAX - -### ByObject -``` -Grant-AppvServerConnectionGroup [-AppvServerConnectionGroup] [-Groups] - [-WhatIf] [-Confirm] [] -``` - -### ByName -``` -Grant-AppvServerConnectionGroup [-Groups] [-Name] [[-Version] ] [-WhatIf] [-Confirm] - [] -``` - -### ByGUID -``` -Grant-AppvServerConnectionGroup [-Groups] [-GroupID] [[-VersionID] ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Grant-AppvServerConnectionGroup** cmdlet entitles an existing connection group. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the package group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupID -Specifies the GUID of specific package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Groups -Specifies an array of strings containing the names of Active Directory groups. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the specified package group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionID -Specifies the version GUID of the package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerConnectionGroup - -## OUTPUTS - -## NOTES -* If the cmdlet cannot find a package group, the cmdlet returns the following error: The specified package group could not be found on the system. The cmdlet fails the operation. -* If you specify an invalid group, the cmdlet returns the following error: The provided entitlements are not valid. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet operates on all available versions of the group. -* When entitling a package group, the cmdlet adds all entitlements to the individual packages themselves. The cmdlet returns all the packages in the group and any newly added entitlements. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/grant-appvserverpackage.md b/docset/mdop/appvserver/grant-appvserverpackage.md deleted file mode 100644 index ee57e6d4a6..0000000000 --- a/docset/mdop/appvserver/grant-appvserverpackage.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Grant-AppvServerPackage ---- - -# Grant-AppvServerPackage - -## SYNOPSIS -Grants an entitlement to a package. - -## SYNTAX - -### ByObject -``` -Grant-AppvServerPackage [-AppvServerPackage] [-Groups] [-WhatIf] [-Confirm] - [] -``` - -### By GUID -``` -Grant-AppvServerPackage [-Groups] [-PackageID] [[-VersionID] ] [-WhatIf] [-Confirm] - [] -``` - -### ByName -``` -Grant-AppvServerPackage [-Groups] [-Name] [[-Version] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Grant-AppvServerPackage** cmdlet grants an Active Directory entitlement to an existing package. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Groups -Specifies an array of names of Active Directory groups. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies a GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) sequencer. -The package GUID is shared by all versions of a specific package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one specific lineage. -If you do not specify a version, the cmdlet acts on all versions saved on computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -## NOTES -* If the cmdlet cannot find the specified package, the cmdlet returns the following error: The specified package could not be found on the system. The cmdlet fails the operation. -* If you specify an invalid group, the cmdlet return the following error: The provided entitlements are not valid. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet takes action on all available versions of the package. -* If the *Groups* parameter is set to $Null, this cmdlet ignores the *Confirm* parameter. Specify the *Force* parameter to perform the action without confirming. - - The release documented in KB 3139245 implements this change. -It applies to subsequent releases of Microsoft Application Virtualization 5.1. -For more information, see Hotfix Package 2 for Microsoft Application Virtualization 5.1 and Hotfix Package 3 for Microsoft Application Virtualization 5.0 SP3https://support.microsoft.com/en-us/kb/3139245 (https://support.microsoft.com/kb/3139245) in the Microsoft Support Library. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Import-AppvServerPackage](./Import-AppvServerPackage.md) - -[Publish-AppvServerPackage](./Publish-AppvServerPackage.md) - -[Remove-AppvServerPackage](./Remove-AppvServerPackage.md) - -[Set-AppvServerPackage](./Set-AppvServerPackage.md) - -[Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/import-appvserverpackage.md b/docset/mdop/appvserver/import-appvserverpackage.md deleted file mode 100644 index a821907c3a..0000000000 --- a/docset/mdop/appvserver/import-appvserverpackage.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Import-AppvServerPackage ---- - -# Import-AppvServerPackage - -## SYNOPSIS -Adds a package to the App-V Management server. - -## SYNTAX - -``` -Import-AppvServerPackage [-PackagePath] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-AppvServerPackage** cmdlet accepts a path to a valid APPV package. -The specified package is imported into the Microsoft Application Virtualization (App-V) Management server and an object to the package is returned. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -PackagePath -Specifies full path to the App-V package. -This can either be an SMB or HTTP/HTTPS path. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### AppvServer.AppvServerPackage - -## NOTES - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Grant-AppvServerPackage](./Grant-AppvServerPackage.md) - -[Publish-AppvServerPackage](./Publish-AppvServerPackage.md) - -[Remove-AppvServerPackage](./Remove-AppvServerPackage.md) - -[Set-AppvServerPackage](./Set-AppvServerPackage.md) - -[Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/new-appvserverconnectiongroup.md b/docset/mdop/appvserver/new-appvserverconnectiongroup.md deleted file mode 100644 index e1f7ad4c94..0000000000 --- a/docset/mdop/appvserver/new-appvserverconnectiongroup.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: New-AppvServerConnectionGroup ---- - -# New-AppvServerConnectionGroup - -## SYNOPSIS -Creates an App-V connection group. - -## SYNTAX - -``` -New-AppvServerConnectionGroup -Name [-Priority ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-AppvServerConnectionGroup** cmdlet creates an empty Microsoft Application Virtualization (App-V) connection group on the management server. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -This parameter is applicable only for App-V 5.0 SP3 or any subsequent versions of App-V. -Specifies a value used to resolve conflicts when opening a package that has been added to multiple connection groups. -The connection group with the lowest priority value is used. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### AppvServer.AppvServerPackageGroup - -## NOTES -* This cmdlet returns the new Connection group. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/publish-appvserverconnectiongroup.md b/docset/mdop/appvserver/publish-appvserverconnectiongroup.md deleted file mode 100644 index f2833bfc84..0000000000 --- a/docset/mdop/appvserver/publish-appvserverconnectiongroup.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Publish-AppvServerConnectionGroup ---- - -# Publish-AppvServerConnectionGroup - -## SYNOPSIS -Publishes a connection group. - -## SYNTAX - -### ByObject -``` -Publish-AppvServerConnectionGroup [-AppvServerConnectionGroup] [-WhatIf] - [-Confirm] [] -``` - -### ByName -``` -Publish-AppvServerConnectionGroup [-Name] [[-Version] ] [-WhatIf] [-Confirm] - [] -``` - -### ByGUID -``` -Publish-AppvServerConnectionGroup [-GroupID] [[-VersionID] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Publish-AppvServerConnectionGroup** cmdlet publishes the specified connection group. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the package group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupID -Specifies the GUID of a specific package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the specified package group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionID -Specifies the version GUID of the package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackageGroup - -## OUTPUTS - -## NOTES -* If the cmdlet cannot find the specified package groups on the server, the cmdlet returns the following error an error: The following package group(s) could not be found on the system. It lists the packages. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet publishes all existing versions of the package group. -* If you do not specify any parameters, the cmdlet publishes all the package groups and subsequent versions on the computer. -* If a specified package group does not have at least one entitlement associated with it, the cmdlet return the following error: The following package group(s) could not be published because no associated entitlement group could be found. The cmdlet returns a list of the package groups and fails the operation for only those specific groups. -* If any of the specified groups are empty, the cmdlet returns the following error: One or more of the provided package groups is empty. The publishing operation has failed. The cmdlet returns a list of the package groups. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/publish-appvserverpackage.md b/docset/mdop/appvserver/publish-appvserverpackage.md deleted file mode 100644 index 6420545b26..0000000000 --- a/docset/mdop/appvserver/publish-appvserverpackage.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Publish-AppvServerPackage ---- - -# Publish-AppvServerPackage - -## SYNOPSIS -Publish a package. - -## SYNTAX - -### ByName (Default) -``` -Publish-AppvServerPackage [[-Name] ] [[-Version] ] [-WhatIf] [-Confirm] [] -``` - -### ByObject -``` -Publish-AppvServerPackage [-AppvServerPackage] [-WhatIf] [-Confirm] [] -``` - -### By GUID -``` -Publish-AppvServerPackage [-PackageID] [[-VersionID] ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Publish-AppvServerPackage** cmdlet publishes a package. -All connected publishing servers push the specified packages to entitled users. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion[] -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies the package GUID that uniquely identifies the package. -The GUID can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) sequencer. -The package GUID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one lineage. -If no version is supplied, the cmdlet acts on all versions saved to computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a version ID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If this parameter is not specified, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -## NOTES -* If the specified packages do not exist, the publish operation fails for those packages. The cmdlet returns the following error: The following packages could not be found on the system \. -* If you do not specify a version, the cmdlet publishes all versions of the package. -* If you do not specify any parameters, the cmdlet publishes all packages on the computer. The cmdlet returns a warning before it runs this operation. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Grant-AppvServerPackage](./Grant-AppvServerPackage.md) - -[Import-AppvServerPackage](./Import-AppvServerPackage.md) - -[Remove-AppvServerPackage](./Remove-AppvServerPackage.md) - -[Set-AppvServerPackage](./Set-AppvServerPackage.md) - -[Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/remove-appvserverconnectiongroup.md b/docset/mdop/appvserver/remove-appvserverconnectiongroup.md deleted file mode 100644 index e0313afd7f..0000000000 --- a/docset/mdop/appvserver/remove-appvserverconnectiongroup.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-AppvServerConnectionGroup ---- - -# Remove-AppvServerConnectionGroup - -## SYNOPSIS -Removes App-V server connection group. - -## SYNTAX - -### ByName (Default) -``` -Remove-AppvServerConnectionGroup [-Name] [-Force] [[-Version] ] [-WhatIf] [-Confirm] - [] -``` - -### ByObject -``` -Remove-AppvServerConnectionGroup [-AppvServerConnectionGroup] [-Force] [-WhatIf] - [-Confirm] [] -``` - -### ByGUID -``` -Remove-AppvServerConnectionGroup [-Force] [-GroupID] [[-VersionID] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Remove-AppvServerConnectionGroup** cmdlet removes a Microsoft Application Virtualization (App-V) server connection group from the computer. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the package group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Not Specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupID -Specifies the GUID of specific package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the specified package group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionID -Specifies the version GUID of the package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerConnectionGroup - -## OUTPUTS - -## NOTES -* Once the package group is removed, its packages remain in other package groups and as part of the library of imported packages on the server. -* If the cmdlet cannot find a specified package, the cmdlet returns the following error: The specified package could not be found on the system. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet acts on all available versions of the group. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/remove-appvserverconnectiongrouppackage.md b/docset/mdop/appvserver/remove-appvserverconnectiongrouppackage.md deleted file mode 100644 index f561a1f389..0000000000 --- a/docset/mdop/appvserver/remove-appvserverconnectiongrouppackage.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-AppvServerConnectionGroupPackage ---- - -# Remove-AppvServerConnectionGroupPackage - -## SYNOPSIS -(Cmdlet applicable starting in App-V 5.0 SP3) Removes a package from a connection group. - -## SYNTAX - -### ByObject -``` -Remove-AppvServerConnectionGroupPackage [-AppvServerConnectionGroup] - [[-AppvServerPackage] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-WhatIf] [-Confirm] [] -``` - -### ByName -``` -Remove-AppvServerConnectionGroupPackage [-ConnectionGroupName] [[-AppvServerPackage] ] - [[-ConnectionGroupVersion] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-WhatIf] [-Confirm] [] -``` - -### ByGUID -``` -Remove-AppvServerConnectionGroupPackage [-ConnectionGroupID] [[-ConnectionGroupVersionID] ] - [[-AppvServerPackage] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AppvServerConnectionGroupPackage** cmdlet removes a package from a connection group. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the connection group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AppvServerPackage -Specifies an **AppVServerPackage** object. - -```yaml -Type: PackageVersion -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectionGroupID -Specifies the GUID of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: GroupID - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupName -Specifies the name of the connection group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupVersion -Specifies the version of the connection group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: Version - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupVersionID -Specifies the GUID of the connection group version. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: VersionID - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageVersion -Specifies the version of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageVersionID -Specifies the GUID that uniquely identifies the version of the package. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppV.Server.AppVMgmtDataTypes.SerializableConnectionGroup, Microsoft.AppV.Server.AppVMgmtDataTypes.PackageVersion - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-AppvServerConnectionGroupPackage](./Add-AppvServerConnectionGroupPackage.md) - -[Set-AppvServerConnectionGroupPackage](./Set-AppvServerConnectionGroupPackage.md) - - diff --git a/docset/mdop/appvserver/remove-appvserverpackage.md b/docset/mdop/appvserver/remove-appvserverpackage.md deleted file mode 100644 index b69dde393e..0000000000 --- a/docset/mdop/appvserver/remove-appvserverpackage.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Remove-AppvServerPackage ---- - -# Remove-AppvServerPackage - -## SYNOPSIS -Remove a package from the App-V Management Server. - -## SYNTAX - -### ByName (Default) -``` -Remove-AppvServerPackage [-Name] [[-Version] ] [-WhatIf] [-Confirm] [] -``` - -### ByObject -``` -Remove-AppvServerPackage [-AppvServerPackage] [-WhatIf] [-Confirm] [] -``` - -### By GUID -``` -Remove-AppvServerPackage [-PackageID] [[-VersionID] ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AppvServerPackage** cmdlet removes a package from the Microsoft Application Virtualization (App-V) Management Server. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion[] -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. -The GUID can be found in the package manifest or by opening the package in the App-V sequencer. -The package GUID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one lineage. -If no version is supplied, the operation acts on all versions saved to computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -## NOTES -* If the packages do not exist, the remove operation fails for those packages. The cmdlet returns the following error: The following packages could not be found on the system \. -* If you do not specify a version, the cmdlet removes all versions of the package. -* If you do not specify any parameters, the cmdlet removes all packages on the system. The cmdlet returns a warning before it performs this operation. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Grant-AppvServerPackage](./Grant-AppvServerPackage.md) - -[Import-AppvServerPackage](./Import-AppvServerPackage.md) - -[Publish-AppvServerPackage](./Publish-AppvServerPackage.md) - -[Set-AppvServerPackage](./Set-AppvServerPackage.md) - -[Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/set-appvserverconnectiongroup.md b/docset/mdop/appvserver/set-appvserverconnectiongroup.md deleted file mode 100644 index fb0157ad97..0000000000 --- a/docset/mdop/appvserver/set-appvserverconnectiongroup.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvServerConnectionGroup ---- - -# Set-AppvServerConnectionGroup - -## SYNOPSIS -Configures an App-V server package group. - -## SYNTAX - -### ByName -``` -Set-AppvServerConnectionGroup [[-AppvServerPackage] ] [-Name] [-Priority ] - [-Order ] [[-Version] ] [-WhatIf] [-Confirm] [] -``` - -### ByObject -``` -Set-AppvServerConnectionGroup [[-AppvServerPackage] ] - [-AppvServerConnectionGroup] [-Priority ] [-Order ] [-WhatIf] - [-Confirm] [] -``` - -### ByGUID -``` -Set-AppvServerConnectionGroup [[-AppvServerPackage] ] [-Priority ] [-Order ] - [-GroupID] [[-VersionID] ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AppvServerConnectionGroup** cmdlet sets the packages within the Microsoft Application Virtualization (App-V) specified package group. -The cmdlet modifies the packages in the group, as well as the order of those packages. - -The cmdlet returns an **AppvServerConnectionGroup** object. - -## EXAMPLES - -### Example 1: Modify a package group -``` -PS C:\> $P11 = Get-AppvServerPackage -Name "Item03" -Version 1 -PS C:\> $P12 = Get-AppvServerPackage -Name "Item14" -Version 2 -PS C:\> $P13 = Get-AppvServerPackage -Name "MyGroup" -Version 3 -PS C:\> $Group = New-AppvServerConnectionGroup -Name MyGroup -PS C:\> Set-AppvServerConnectionGroup -AppvServerConnectionGroup $Group -AppVServerPackage $P11,$P12,$P13 -Order 2,0,1 -Priority 1,0,1 -``` - -This example sets the new package group, $Group, to contain the packages stored in $P11, $P12, $P13. -The priority and order fields are also added to each respective package in the group. - -### Example 2: Modify priority and order properties -``` -PS C:\> $Group.GroupedAppvServerPackage[0].priority = 1 -PS C:\> $Group.GroupedAppvServerPackage[0].order = 1 -PS C:\> Set-AppvServerConnectionGroup $Group -``` - -This example modifies the priority and order properties of the first package object that was added to the group. -The example applies the modifications to the group by using the **Set-AppvServerPackageGroup** cmdlet. - -### Example 3: Modify a package group by using the pipeline operator -``` -PS C:\> Get-AppvServerPackage -Name "Office" | Set-AppvServerConnectionGroup -Name "MyGroup" -Version 3 -``` - -This command modifies the package group named MyGroup to contain the Office package. -Although the result of the **Get-AppvServerPackage** cmdlet might contain multiple versions of the package, only the latest version is added to the package group. - -### Example 4: Add packages and metadata -``` -PS C:\> $Group = New-AppvServerConnectionGroup -Name "MyGroup" -PS C:\> $Group.Set("$Package01, $Package02", "0,0", "1,0") -``` - -This example creates a group called MyGroup, and then adds $Package01 and $Package02 to the group. -The example includes priority and order metadata for each respective package. - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the connection group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupID -Specifies the GUID of specific package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Specifies the order in which a package's virtual environment will be loaded when the package group is invoked on the App-V client. - -Specify the order as a comma separated list, with each value corresponding to the list of packages being placed in the group. - -If you do not specify this parameter, the order in which the packages are listed will be used as the virtual environment load order. - -```yaml -Type: Int32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies a numerical value used to resolve conflicts between Virtual Application Packages that appear in multiple Package Groups. -Valid values are: 0 and 1. -The default value is 0. - -Specify the priority as a comma separated list, with each value corresponding to the list of packages being placed in the group. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the version of the specified package group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies the version GUID of the package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage, AppvServer.AppvServerConnectionGroup - -## OUTPUTS - -### AppvServer.AppvServerConnectionGroup - -## NOTES -* The cmdlet accepts an ordered list of package groups. This list overwrites the current listing of packages for the specified group and increments the *VersionID* of the package. The server version will NOT be incremented. All existing metadata associated with the package, such as entitlements, are copied over to the new version. -* If the cmdlet cannot find a package group, the cmdlet returns the following error: The specified package group could not be found on the system. The cmdlet fails the entire operation. -* If the cmdlet cannot find any of the specified packages, the cmdlet returns the following error: One or more of the specified packages could not be found on the system. The cmdlet fails the entire operation and returns a listing of the packages. -* If multiple versions of a package group are selected, the latest version will be updated, and its version incremented. The other package groups are ignored. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/set-appvserverconnectiongrouppackage.md b/docset/mdop/appvserver/set-appvserverconnectiongrouppackage.md deleted file mode 100644 index 067b3d8630..0000000000 --- a/docset/mdop/appvserver/set-appvserverconnectiongrouppackage.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvServerConnectionGroupPackage ---- - -# Set-AppvServerConnectionGroupPackage - -## SYNOPSIS -(Cmdlet applicable starting in App-V 5.0 SP3) Appends a package to the end of a connection group package list. - -## SYNTAX - -### ByObject -``` -Set-AppvServerConnectionGroupPackage [-AppvServerConnectionGroup] - [[-AppvServerPackage] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-Optional ] [-UseAnyPackageVersion ] [-Order ] [-WhatIf] - [-Confirm] [] -``` - -### ByName -``` -Set-AppvServerConnectionGroupPackage [-ConnectionGroupName] [[-AppvServerPackage] ] - [[-ConnectionGroupVersion] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-Optional ] [-UseAnyPackageVersion ] [-Order ] [-WhatIf] - [-Confirm] [] -``` - -### ByGUID -``` -Set-AppvServerConnectionGroupPackage [-ConnectionGroupID] [[-ConnectionGroupVersionID] ] - [[-AppvServerPackage] ] [-PackageName ] [-PackageVersion ] [-PackageID ] - [-PackageVersionID ] [-Optional ] [-UseAnyPackageVersion ] [-Order ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AppvServerConnectionGroupPackage** cmdlet appends a package to the end of a connection group package list. -You can configure the package as optional and/or with no version within the connection group. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the connection group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AppvServerPackage -Specifies an **AppVServerPackage** object. - -```yaml -Type: PackageVersion -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConnectionGroupID -Specifies the GUID of the connection group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: GroupID - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupName -Specifies the name of the connection group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupVersion -Specifies the version of the connection group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: Version - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionGroupVersionID -Specifies the GUID of the connection group version. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: VersionID - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Optional -Specifies whether the package is optional. -Optional packages are not required when a connection group virtual environment is started. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Order -Specifies the order in which packages are loaded into the virtual environment. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageVersion -Specifies the version of the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageVersionID -Specifies the GUID that uniquely identifies the version of the package. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseAnyPackageVersion -Specifies whether to the latest added package version when the connection group virtual environment is started. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.AppV.Server.AppVMgmtDataTypes.SerializableConnectionGroup, Microsoft.AppV.Server.AppVMgmtDataTypes.PackageVersion - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-AppvServerConnectionGroupPackage](./Add-AppvServerConnectionGroupPackage.md) - -[Remove-AppvServerConnectionGroupPackage](./Remove-AppvServerConnectionGroupPackage.md) - - diff --git a/docset/mdop/appvserver/set-appvserverpackage.md b/docset/mdop/appvserver/set-appvserverpackage.md deleted file mode 100644 index b348c3c3ba..0000000000 --- a/docset/mdop/appvserver/set-appvserverpackage.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-AppvServerPackage ---- - -# Set-AppvServerPackage - -## SYNOPSIS -Applies a dynamic deployment or user configuration file to a package. - -## SYNTAX - -### ByObject -``` -Set-AppvServerPackage [-AppvServerPackage] [[-Groups] ] - [[-DynamicDeploymentConfigurationPath] ] [[-DynamicUserConfigurationPath] ] [-WhatIf] - [-Confirm] [] -``` - -### ByName -``` -Set-AppvServerPackage [[-Groups] ] [-Name] [[-Version] ] - [[-DynamicDeploymentConfigurationPath] ] [[-DynamicUserConfigurationPath] ] [-WhatIf] - [-Confirm] [] -``` - -### By GUID -``` -Set-AppvServerPackage [[-Groups] ] [-PackageID] [[-VersionID] ] - [[-DynamicDeploymentConfigurationPath] ] [[-DynamicUserConfigurationPath] ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AppvServerPackage** cmdlet applies a dynamic deployment or user configuration file to a package. - -Only one deployment configuration can be entitled to a package. - -Multiple user configuration files can be applied to a package to specific Active Directory group entitlements. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -DynamicDeploymentConfigurationPath -Specifies the path to a dynamic deployment configuration file for the specified Microsoft Application Virtualization (App-V) package. -The cmdlet uses the dynamic deployment configuration file to override the default behavior provided in the package's manifest. - -If you do not specify this parameter, the App-V agent assign the Default Machine Policy to the App-V package to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicUserConfigurationPath -Specifies the path to a dynamic user configuration file for the specified App-V package. -The cmdlet uses the user policy file to override the default behavior provided in the package manifest. -If you do not specify this parameter, the default user policy will be applied to the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Groups -Specifies an array of names of Active Directory groups. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the App-V sequencer. -The package GUID is shared by all versions of a specific package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in one specific lineage. -If you do not specify a version, the cmdlet acts on all versions saved on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify a GUID, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -## NOTES -* If the cmdlet cannot find a package cannot be found, the cmdlet returns the following error: The specified package could not be found on the system. The cmdlet fails the operation. -* If you specify an invalid group, the cmdlet returns the following error: The provided entitlements are not valid. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet acts on all available versions of the package. -* Do not specify Active Directory entitlements when supplying a deployment configuration. If so, the cmdlet returns an error. -* Do not set both deployment configuration and user configuration at the same time. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Grant-AppvServerPackage](./Grant-AppvServerPackage.md) - -[Import-AppvServerPackage](./Import-AppvServerPackage.md) - -[Publish-AppvServerPackage](./Publish-AppvServerPackage.md) - -[Remove-AppvServerPackage](./Remove-AppvServerPackage.md) - -[Unpublish-AppvServerPackage](./Unpublish-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/unpublish-appvserverconnectiongroup.md b/docset/mdop/appvserver/unpublish-appvserverconnectiongroup.md deleted file mode 100644 index 4a3ac035fd..0000000000 --- a/docset/mdop/appvserver/unpublish-appvserverconnectiongroup.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Unpublish-AppvServerConnectionGroup ---- - -# Unpublish-AppvServerConnectionGroup - -## SYNOPSIS -Unpublishes connection groups. - -## SYNTAX - -### ByObject -``` -Unpublish-AppvServerConnectionGroup [-AppvServerConnectionGroup] [-WhatIf] - [-Confirm] [] -``` - -### ByName -``` -Unpublish-AppvServerConnectionGroup [-Name] [[-Version] ] [-WhatIf] [-Confirm] - [] -``` - -### ByGUID -``` -Unpublish-AppvServerConnectionGroup [-GroupID] [[-VersionID] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Unpublish-AppvServerConnectionGroup** cmdlet unpublishes the specified connection groups. - -## EXAMPLES - -### Example 1: Unpublish one version of a group -``` -PS C:\> Unpublish-AppvServerConnectionGroup -Name "OfficePlugIns" -Version 2 -``` - -This command unpublishes version 2 of the single group named OfficePlugIns. - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the connection group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -GroupID -Specifies the GUID of specific package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -The version of the specified package group. - -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VersionID -Specifies the version GUID of the package group. - -```yaml -Type: Guid -Parameter Sets: ByGUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerConnectionGroup - -## OUTPUTS - -## NOTES -* If the cmdlet cannot find the connection groups, the cmdlet returns the following error: The following connection group(s) could not be found on the system. The cmdlet lists the packages. The cmdlet fails the operation. -* If you do not specify version information, the cmdlet unpublishes all existing versions of the package group. -* If you do not specify any parameters, the cmdlet unpublishes all the package groups and subsequent versions on the system. - -## RELATED LINKS - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Update-AppvServerConnectionGroup](./Update-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/appvserver/unpublish-appvserverpackage.md b/docset/mdop/appvserver/unpublish-appvserverpackage.md deleted file mode 100644 index 8526dd7fdd..0000000000 --- a/docset/mdop/appvserver/unpublish-appvserverpackage.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Unpublish-AppvServerPackage ---- - -# Unpublish-AppvServerPackage - -## SYNOPSIS -Unpublishes packages. - -## SYNTAX - -### ByName (Default) -``` -Unpublish-AppvServerPackage [[-Name] ] [[-Version] ] [-WhatIf] [-Confirm] [] -``` - -### ByObject -``` -Unpublish-AppvServerPackage [-AppvServerPackage] [-WhatIf] [-Confirm] [] -``` - -### By GUID -``` -Unpublish-AppvServerPackage [-PackageID] [[-VersionID] ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Unpublish-AppvServerPackage** cmdlet unpublishes a package. -All connected publishing servers no longer push the specified packages to entitled users. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -AppvServerPackage -Specifies an array of **AppVServerPackage** objects. - -```yaml -Type: PackageVersion[] -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the package given when the package was created. -This value is obtained from the package manifest. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PackageID -Specifies the GUID that uniquely identifies the package. -It can be found in the package manifest or by opening the package in the Microsoft Application Virtualization (App-V) sequencer. -The package GUID is shared by all versions of a package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Version -Specifies the version of an App-V package in a lineage. -If you do not specify a version, the cmdlet acts on all versions saved on the computer. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -VersionID -Specifies a GUID that differentiates a package version from other versions, whether older, newer, or of a completely different lineage. -If you do not specify this parameter, the cmdlet operates on all versions of the package. - -```yaml -Type: Guid -Parameter Sets: By GUID -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### AppvServer.AppvServerPackage - -## OUTPUTS - -## NOTES -* If the packages do not exist, the unpublish operation fails for those packages. The cmdlet returns the following error: The following packages could not be found on the system \. -* If you do not specify version information, the cmdlet unpublishes all versions of the package. -* If you do not specify any parameters, the cmdlet unpublishes all packages on the computer. The cmdlet returns a warning before it runs this operation. - -## RELATED LINKS - -[Get-AppvServerPackage](./Get-AppvServerPackage.md) - -[Grant-AppvServerPackage](./Grant-AppvServerPackage.md) - -[Import-AppvServerPackage](./Import-AppvServerPackage.md) - -[Publish-AppvServerPackage](./Publish-AppvServerPackage.md) - -[Remove-AppvServerPackage](./Remove-AppvServerPackage.md) - -[Set-AppvServerPackage](./Set-AppvServerPackage.md) - - diff --git a/docset/mdop/appvserver/update-appvserverconnectiongroup.md b/docset/mdop/appvserver/update-appvserverconnectiongroup.md deleted file mode 100644 index dbd427ec41..0000000000 --- a/docset/mdop/appvserver/update-appvserverconnectiongroup.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: AppVServerCmdlets.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Update-AppvServerConnectionGroup ---- - -# Update-AppvServerConnectionGroup - -## SYNOPSIS -Updates the specified connection group. - -## SYNTAX - -### ByObject -``` -Update-AppvServerConnectionGroup [-AppvServerConnectionGroup] [-WhatIf] - [-Confirm] [] -``` - -### ByName -``` -Update-AppvServerConnectionGroup [-Name] [[-Version] ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Update-AppvServerConnectionGroup** cmdlet updates a connection group. -This cmdlet increments the version of the package group in the server management console. - -## EXAMPLES - -### Example 1: Update a group -``` -PS C:\> Update-AppvServerConnectionGroup -Name "Office" | Set-AppvServerConnectionGroup $Package01 $Package02 -``` - -This command updates the group named Office, and then sets two packages to be in the group. - -### Example 2: Get an updated version -``` -PS C:\> $Group = Get-AppvServerPackage -PackageGUID A1232ACFD3EF -PS C:\> Update-AppvServerConnectionGroup -Name $Package.Name -``` - -This example returns an updated version of $Group. -The new version contains no package groups. -Note that $Group could contain multiple versions of the package group, but the cmdlet uses the latest version of the package group to create the new version. - -### Example 3: Store an updated version in a variable -``` -PS C:\> $Group = Get-AppvServerConnectionGroup -Name "Office" -PS C:\> $Group02 = $Group.Update() -``` - -This example returns an updated version of $Group, and stores it in $Group02. -The $Group02 variable contains no packages. - -## PARAMETERS - -### -AppvServerConnectionGroup -Specifies the package group object. - -```yaml -Type: SerializableConnectionGroup -Parameter Sets: ByObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the package group. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -```yaml -Type: Int32 -Parameter Sets: ByName -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### AppvServer.AppvServerPackageGroup - -## NOTES -* This cmdlet returns an **AppvServerPackageGroup** object that references the updated version of the package group. -* You must specify the name of an existing package group. If the group does not exist, the cmdlet returns the following error: The specified package group could not be found on the system. -* This cmdlet returns an empty package group with its server version incremented. The version GUID will NOT be incremented until you run the **Set-AppvServerPackageGroup** cmdlet. - -## RELATED LINKS - -[Get-AppvServerConnectionGroup](./Get-AppvServerConnectionGroup.md) - -[Grant-AppvServerConnectionGroup](./Grant-AppvServerConnectionGroup.md) - -[New-AppvServerConnectionGroup](./New-AppvServerConnectionGroup.md) - -[Publish-AppvServerConnectionGroup](./Publish-AppvServerConnectionGroup.md) - -[Remove-AppvServerConnectionGroup](./Remove-AppvServerConnectionGroup.md) - -[Set-AppvServerConnectionGroup](./Set-AppvServerConnectionGroup.md) - -[Unpublish-AppvServerConnectionGroup](./Unpublish-AppvServerConnectionGroup.md) - - diff --git a/docset/mdop/mbam/disable-mbamcmintegration.md b/docset/mdop/mbam/disable-mbamcmintegration.md deleted file mode 100644 index 3395759871..0000000000 --- a/docset/mdop/mbam/disable-mbamcmintegration.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Disable-MbamCMIntegration ---- - -# Disable-MbamCMIntegration - -## SYNOPSIS -Disables the MBAM Microsoft Endpoint Configuration Manager Integration feature. - -## SYNTAX - -``` -Disable-MbamCMIntegration [-Force] [-RemoveComplianceData] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-MbamCMIntegration** cmdlet disables the Microsoft BitLocker Administration and Monitoring (MBAM) Microsoft Endpoint Configuration Manager Integration feature. - -## EXAMPLES - -### Example 1: Disable the Microsoft Endpoint Configuration Manager Integration feature -``` -PS C:\> Disable-MbamCMIntegration -Are you sure you want to perform this action? -Performing operation "Disable MBAM CM Integration feature" -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -This command disables the MBAM Microsoft Endpoint Configuration Manager Integration feature after you confirm the operation. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that the cmdlet performs the operation without prompting you for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveComplianceData -Indicates that this cmdlet removes compliance data, as well as reports, from Configuration Manager. -If you do not specify this parameter, this cmdlet only removes the Configuration Manager reports. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MbamCMIntegration](enable-mbamcmintegration.md) - -[Get-MbamCMIntegration](get-mbamcmintegration.md) - -[Test-MbamCMIntegration](test-mbamcmintegration.md) - - diff --git a/docset/mdop/mbam/disable-mbamreport.md b/docset/mdop/mbam/disable-mbamreport.md deleted file mode 100644 index c0093856f8..0000000000 --- a/docset/mdop/mbam/disable-mbamreport.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Disable-MbamReport ---- - -# Disable-MbamReport - -## SYNOPSIS -Disables the Reports feature. - -## SYNTAX - -``` -Disable-MbamReport [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-MbamReport** cmdlet disables the Microsoft BitLocker Administration and Monitoring (MBAM) Reports feature. - -## EXAMPLES - -### Example 1: Disable the Reports feature -``` -PS C:\> Disable-MbamReport -Are you sure you want to perform this action? -Performing operation "Disable MBAM Reports feature" -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -This command disables the Reports feature. -The command does not specify the *Force* parameter, and, therefore, the command prompts you for confirmation. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Indicates that the cmdlet performs the operation without prompting you for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MbamReport](enable-mbamreport.md) - -[Get-MbamReport](get-mbamreport.md) - -[Test-MbamReport](test-mbamreport.md) - - diff --git a/docset/mdop/mbam/disable-mbamwebapplication.md b/docset/mdop/mbam/disable-mbamwebapplication.md deleted file mode 100644 index 39fc154950..0000000000 --- a/docset/mdop/mbam/disable-mbamwebapplication.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Disable-MbamWebApplication ---- - -# Disable-MbamWebApplication - -## SYNOPSIS -Disables a web application. - -## SYNTAX - -### ParameterSetAdministrationPortal -``` -Disable-MbamWebApplication [-Force] [-AdministrationPortal] [-WhatIf] [-Confirm] [] -``` - -### ParameterSetAgentService -``` -Disable-MbamWebApplication [-Force] [-AgentService] [-WhatIf] [-Confirm] [] -``` - -### ParameterSetSelfServicePortal -``` -Disable-MbamWebApplication [-Force] [-SelfServicePortal] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-MbamWebApplication** cmdlet disables a Microsoft BitLocker Administration and Monitoring (MBAM) web application. -This cmdlet removes any website files that the **Enable-MbamWebApplication** cmdlet installed when you enabled the application. - -## EXAMPLES - -### Example 1: Disable Administration and Monitoring Website -``` -PS C:\> Disable-MbamWebApplication -AdministrationPortal -Are you sure you want to perform this action? -Performing operation "Disable MBAM Web Application (AdministrationPortal) feature" -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -This command disables the Administration and Monitoring Portal feature. -The cmdlet prompts you to confirm the operation. - -### Example 2: Disable the Self-Service Portal -``` -PS C:\> Disable-MbamWebApplication -SelfServicePortal -Force -``` - -This command disables the Self-Service Portal feature. -The command specifies the *Force* parameter, and, therefore, the cmdlet does not prompt you to confirm the operation. - -### Example 3: Disable Agent Services -``` -PS C:\> Disable-MbamWebApplication -AgentService -Are you sure you want to perform this action? -Performing operation "Disable MBAM Web Application (AgentService) feature" -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -This command disables the Agent Services feature. -The cmdlet prompts you to confirm the operation. - -## PARAMETERS - -### -AdministrationPortal -Indicates that this cmdlet acts on the Administration and Monitoring Website web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentService -Indicates that this cmdlet acts on the Agent Services web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelfServicePortal -Indicates that this cmdlet acts on the Self-Service Portal web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MbamWebApplication](enable-mbamwebapplication.md) - -[Get-MbamWebApplication](get-mbamwebapplication.md) - -[Test-MbamWebApplication](test-mbamwebapplication.md) - - diff --git a/docset/mdop/mbam/enable-mbamcmintegration.md b/docset/mdop/mbam/enable-mbamcmintegration.md deleted file mode 100644 index 1d29ecfddd..0000000000 --- a/docset/mdop/mbam/enable-mbamcmintegration.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-MbamCMIntegration ---- - -# Enable-MbamCMIntegration - -## SYNOPSIS -Enables the MBAM Microsoft Endpoint Configuration Manager Integration feature. - -## SYNTAX - -### ParameterSetCMReportsOnly -``` -Enable-MbamCMIntegration [-SkipValidation] [-SsrsServer ] [-SsrsInstance ] [-ReportsOnly] - -ReportsCollectionID -BitLockerProtectionBaselineLogicalName - -OperatingSystemDriveConfigurationItemLogicalName - -FixedDataDriveConfigurationItemLogicalName [-WhatIf] [-Confirm] [] -``` - -### ParameterSetDefault -``` -Enable-MbamCMIntegration [-SkipValidation] [-SsrsServer ] [-SsrsInstance ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Enable-MbamCMIntegration** cmdlet enables the Microsoft BitLocker Administration and Monitoring (MBAM) Microsoft Endpoint Configuration Manager Integration feature. -This feature integrates Configuration Manager with MBAM, and moves the compliance and reporting infrastructure into the Configuration Manager environment. - -## EXAMPLES - -### Example 1: Enable the Integration feature -``` -PS C:\> Enable-MbamCMIntegration -``` - -This command enables the MBAM Microsoft Endpoint Configuration Manager Integration feature on the local Configuration Manager server. -The MBAM reports are deployed on the default SQL Server Reporting Services instance, MSSQLSERVER. - -## PARAMETERS - -### -BitLockerProtectionBaselineLogicalName -Specifies the logical name of the BitLocker protection baseline. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: BaselineLogicalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FixedDataDriveConfigurationItemLogicalName -Specifies the logical name of the fixed data drive configuration item. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: FDDLogicalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystemDriveConfigurationItemLogicalName -Specifies the logical name of the operating system drive configuration item. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: OSDLogicalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportsCollectionID -Specifies an existing collection ID. -This ID is used by the reports to set the default collection for which the reports display compliance data. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportsOnly -Indicates that only the Configuration Manager reports are deployed. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetCMReportsOnly -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipValidation -Indicates that this cmdlet bypasses validation of parameter values. -If you specify this parameter, the feature may not function properly after you enable it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SsrsInstance -Specifies the SQL Server Reporting Services instance. -This instance hosts the Configuration Manager reports. -This parameter is ignored if the server has Configuration Manager installed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SsrsServer -Specifies the server with the SQL Server Reporting Services point role. -This server hosts the Configuration Manager reports. -If you do not specify a server, the Configuration Manager reports are deployed to the local server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-MbamCMIntegration](disable-mbamcmintegration.md) - -[Get-MbamCMIntegration](get-mbamcmintegration.md) - -[Test-MbamCMIntegration](test-mbamcmintegration.md) - - diff --git a/docset/mdop/mbam/enable-mbamdatabase.md b/docset/mdop/mbam/enable-mbamdatabase.md deleted file mode 100644 index f0e51b6783..0000000000 --- a/docset/mdop/mbam/enable-mbamdatabase.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-MbamDatabase ---- - -# Enable-MbamDatabase - -## SYNOPSIS -Enables the Compliance and Audit and Recovery databases. - -## SYNTAX - -### ParameterSetCompliance -``` -Enable-MbamDatabase [-SkipValidation] -ConnectionString [-DatabaseName ] - -AccessAccount -ReportAccount [-ComplianceAndAudit] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetRecovery -``` -Enable-MbamDatabase [-SkipValidation] -ConnectionString [-DatabaseName ] - -AccessAccount [-Recovery] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-MbamDatabase** cmdlet enables a Compliance and Audit or a Recovery Database. - -## EXAMPLES - -### Example 1: Enable the Compliance and Audit Database -``` -PS C:\> Enable-MbamDatabase -ComplianceAndAudit -ConnectionString "Integrated Security=SSPI;Data Source=MyDatabaseServer" -AccessAccount "MyDomain\MyAccessAccount" -ReportAccount "MyDomain\MyReportAccount" -DatabaseName "MyComplianceDatabaseName" -``` - -This command enables the Compliance and Audit Database on MyDatabaseServer. -The name of the database is MyComplianceDatabaseName. -The domain account MyAccessAccount has read and write permission to the database, and MyReportAccount has read-only permission to the database for reporting purposes. -The current Windows account credentials are used for authentication. - -### Example 2: Enable the Recovery Database -``` -PS C:\> Enable-MbamDatabase -Recovery -ConnectionString "Integrated Security=SSPI;Data Source=MyDatabaseServer" -AccessAccount "MyDomain\MyAccessAccount" -DatabaseName "MyRecoveryDatabaseName" -``` - -This command enables the Recovery database on MyRecoveryDatabaseServer. -The name of the database is MyRecoveryDatabaseName. -The domain account MyAccessAccount has read/write permission to the database. -The command uses the current Windows account credentials for authentication. - -## PARAMETERS - -### -AccessAccount -Specifies a domain user or group. -This domain user or group has read and write permission to this database, which enables web applications to access the data and reports. -If the value is a domain user, the *WebServiceApplicationPoolCredential* parameter in the **Enable-MbamWebApplication** cmdlet must use the same user account. -If the value is a group, the domain account used by the *WebServiceApplicationPoolCredential* parameter must be a member of this group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComplianceAndAudit -Indicates that the Compliance and Audit Database is enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetCompliance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionString -Specifies the connection string used to connect to the data store. -The Integrated Security field must be in the connection string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. -This parameter cannot contain leading or trailing spaces or non-printable characters. -If you do not specify a name, the Compliance and Audit Database is given the name MBAM Compliance Status, and the Recovery database is given the name MBAM Recovery and Hardware. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recovery -Indicates that the Recovery Database is enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetRecovery -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportAccount -Specifies a domain user or group. -This domain user or group has read-only permission to this database, which enables reports to access the compliance and audit data. -If the value is a domain user, the *ComplianceAndAuditDBCredential* parameter in the **Enable-MbamReport** cmdlet must use the same user account. -If the value is a domain user group, the domain account used by the *ComplianceAndAuditDBCredential* parameter must be a member of this group. - -```yaml -Type: String -Parameter Sets: ParameterSetCompliance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipValidation -Indicates that this cmdlet bypasses validation of parameter values. -If you specify this parameter, the feature may not function properly after you enable it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MbamReport](enable-mbamreport.md) - -[Enable-MbamWebApplication](enable-mbamwebapplication.md) - -[Test-MbamDatabase](test-mbamdatabase.md) - - diff --git a/docset/mdop/mbam/enable-mbamreport.md b/docset/mdop/mbam/enable-mbamreport.md deleted file mode 100644 index ac66d0921d..0000000000 --- a/docset/mdop/mbam/enable-mbamreport.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-MbamReport ---- - -# Enable-MbamReport - -## SYNOPSIS -Enables the Reports feature on the local server. - -## SYNTAX - -``` -Enable-MbamReport [-SkipValidation] [-ComplianceAndAuditDBConnectionString ] - -ComplianceAndAuditDBCredential [-SsrsInstance ] -ReportsReadOnlyAccessGroup - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-MbamReport** cmdlet enables the Microsoft BitLocker Administration and Monitoring (MBAM) Reports feature on a local Microsoft SQL Server Reporting Services instance. - -## EXAMPLES - -### Example 1: Enable the Reports feature -``` -PS C:\> Enable-MbamReport -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -ComplianceAndAuditDBCredential (Get-Credential) -ReportsReadOnlyAccessGroup "Contoso\ReportsGroup" -``` - -This command enables the Reports feature on the local server. -The feature uses the Compliance and Audit Database on ContosoDatabaseServer. -The command prompts you to enter credentials to access the Compliance and Audit Database. -The reports group is Contoso\ReportsGroup. -The command installs reports on the default SQL Server Reporting Services instance. - -## PARAMETERS - -### -ComplianceAndAuditDBConnectionString -Specifies a connection string. -The local SQL Server Reporting Services uses the string that this parameter specifies to connect to the Compliance and Audit Database feature. -The connection string must contain values for the **Integrated Security** and **Initial Catalog** fields. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ComplianceDB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComplianceAndAuditDBCredential -Specifies the domain account credentials that the local SQL Server Reporting Services instance uses to connect to the Compliance and Audit Database. -The domain user in the credentials must be the same as the user that you specify for the *ReportAccount* parameter in the **Enable-MbamDatabase** cmdlet. -If you specified a domain user group for the *ReportAccount* parameter, the credentials that you specify for the current parameter must be a member of that group. - -Important: For improved security, use an account that has limited privileges. -Also, configure the account so that the password never expires. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: ComplianceDBCred - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportsReadOnlyAccessGroup -Specifies a domain user group. -Specify a group that has read permission for the reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ReportsGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipValidation -Indicates that this cmdlet bypasses validation of parameter values. -If you specify this parameter, the feature may not function properly after you enable it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SsrsInstance -Specifies the SQL Server Reporting Services instance. -After installation, this instance hosts the reports. -If you do not specify an instance, the cmdlet uses the default instance, MSSQLSERVER. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-MbamReport](disable-mbamreport.md) - -[Get-MbamReport](get-mbamreport.md) - -[Test-MbamReport](test-mbamreport.md) - -[Enable-MbamDatabase](enable-mbamdatabase.md) - - diff --git a/docset/mdop/mbam/enable-mbamwebapplication.md b/docset/mdop/mbam/enable-mbamwebapplication.md deleted file mode 100644 index abb579e056..0000000000 --- a/docset/mdop/mbam/enable-mbamwebapplication.md +++ /dev/null @@ -1,571 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-MbamWebApplication ---- - -# Enable-MbamWebApplication - -## SYNOPSIS -Enables a web application. - -## SYNTAX - -### ParameterSetAdministrationPortal -``` -Enable-MbamWebApplication [-SkipValidation] [-ComplianceAndAuditDBConnectionString ] - [-RecoveryDBConnectionString ] -AdvancedHelpdeskAccessGroup -HelpdeskAccessGroup - -ReportsReadOnlyAccessGroup [-Certificate ] [-HostName ] [-Port ] - -ReportUrl [-VirtualDirectory ] [-InstallationPath ] - [-WebServiceApplicationPoolCredential ] [-CMIntegrationMode] [-AdministrationPortal] [-WhatIf] - [-Confirm] [] -``` - -### ParameterSetSelfServicePortal -``` -Enable-MbamWebApplication [-SkipValidation] [-ComplianceAndAuditDBConnectionString ] - [-RecoveryDBConnectionString ] [-Certificate ] [-HostName ] [-Port ] - [-VirtualDirectory ] [-InstallationPath ] - [-WebServiceApplicationPoolCredential ] [-CompanyName ] [-HelpdeskUrlText ] - [-HelpdeskUrl ] [-DisableNoticePage] [-NoticeTextPath ] [-SelfServicePortal] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetAgentService -``` -Enable-MbamWebApplication [-SkipValidation] [-ComplianceAndAuditDBConnectionString ] - [-RecoveryDBConnectionString ] [-Certificate ] [-HostName ] [-Port ] - [-InstallationPath ] [-WebServiceApplicationPoolCredential ] [-CMIntegrationMode] - [-TpmLockoutAutoReset] [-DataMigrationAccessGroup ] [-AgentService] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Enable-MbamWebApplication** cmdlet enables a Microsoft BitLocker Administration and Monitoring (MBAM) web application on the local server. -The cmdlet enables one of the following web applications: - -- Administration and Monitoring Website -- Agent Services -- Self-Service Portal - -## EXAMPLES - -### Example 1: Enable Administration and Monitoring Website -``` -PS C:\> Enable-MbamWebApplication -AdministrationPortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -AdvancedHelpdeskAccessGroup "Contoso\AdvancedUserGroup" -HelpdeskAccessGroup "Contoso\StandardUserGroup" -ReportsReadOnlyAccessGroup "Contoso\ReportUserGroup" -ReportUrl "https://ContosoReportsServer/ReportServer" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -``` - -This command enables the Administration and Monitoring Website web application on the current server. -The portal uses the Compliance and Audit Database and the Recovery Database on ContosoDatabaseServer, and it uses the reports on ContosoReportsServer. - -### Example 2: Enable Self-Service Portal -``` -PS C:\> Enable-MbamWebApplication -SelfServicePortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -``` - -This command enables the Self-Service Portal web application on the current server. -The Self-Service Portal uses the Compliance and Audit Database and the Recovery Database on ContosoDatabaseServer. - -### Example 3: Enable Agent Services -``` -PS C:\> Enable-MbamWebApplication -AgentService -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -``` - -This command enables the Agent Services feature on the current server. -The services use the Compliance and Audit Database and the Recovery Database on ContosoDatabaseServer. - -### Example 4: Enable Administration and Monitoring Website for a mirrored environment -``` -PS C:\> Enable-MbamWebApplication -AdministrationPortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Failover Partner=ContosoMirror;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Failover Partner=ContosoMirror;Initial Catalog=MBAM Recovery and Hardware" -AdvancedHelpdeskAccessGroup "Contoso\AdvancedUserGroup" -HelpdeskAccessGroup "Contoso\StandardUserGroup" -ReportsReadOnlyAccessGroup "Contoso\ReportUserGroup" -ReportUrl "https://ContosoReportsServer/ReportServer" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -``` - -This command enables the Administration and Monitoring Website web application, and it configures web applications to use a mirrored Microsoft SQL Server environment. -The connection strings specify a failover partner. - -### Example 5: Enable the Self-Service Portal for a mirrored environment -``` -PS C:\> Enable-MbamWebApplication -SelfServicePortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Failover Partner=ContosoMirror;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Failover Partner=ContosoMirror;Initial Catalog=MBAM Recovery and Hardware" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -``` - -This command enables the Self-Service Portal on the current server, and it configures web applications to use a mirrored SQL Server environment. -The connection strings specify a failover partner. - -## PARAMETERS - -### -AdministrationPortal -Indicates that this cmdlet acts on the Administration and Monitoring Website web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdvancedHelpdeskAccessGroup -Specifies a domain user group. -This group has permissions for all areas of the Administration and Monitoring Website web application, except for reports. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: AdvancedHelpdeskGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AgentService -Indicates that this cmdlet acts on the Agent Services web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CMIntegrationMode -Indicates that all reports, except the Recovery Audit Report, are integrated into Microsoft Endpoint Configuration Manager. -If you enable the Configuration Manager Integration feature, specify this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAdministrationPortal -Aliases: CMMode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: CMMode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificate -Specifies the certificate to use for encrypted web communications. -If you do not specify a certificate, web communications are not encrypted. - -```yaml -Type: X509Certificate2 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CompanyName -Specifies the company name associated with the web application. - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComplianceAndAuditDBConnectionString -Specifies a connection string. -The web application uses the string that this parameter specifies to connect to the Compliance and Audit Database feature. -The connection string must contain values for the **Integrated Security** and **Initial Catalog** fields. - -If you do not specify this parameter, the cmdlet uses the connection string that you previously specified for any enabled web application. -All of the web applications connect to the Compliance and Audit Database by using the same connection string. -If you specify connection strings more than once, web applications will use the most recent value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ComplianceDB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataMigrationAccessGroup -Specifies the domain user group that is authorized to migrate Recovery information to MBAM server. - -```yaml -Type: String -Parameter Sets: ParameterSetAgentService -Aliases: DataMigrationGroup - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisableNoticePage -Indicates the Self-Service Portal notice text on or off. By default, the notice text is turned on. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HelpdeskAccessGroup -Specifies the domain user group that has permissions for the Manage TPM and Drive Recovery areas of the Administration and Monitoring Website web application. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: HelpdeskGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HelpdeskUrl -Specifies the URL for the MBAM help desk site. - -```yaml -Type: Uri -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HelpdeskUrlText -Specifies the helpdesk link text that will be displayed on the self-service portal. - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostName -Specifies a host name. -If you do not specify a host name, the cmdlet uses the fully qualified host name of the local computer. -Ensure that you specify the same host name for all of the web applications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstallationPath -Specifies the installation path of the web application. -The installation process creates a folder named Microsoft BitLocker Management Solution in location that this parameter specifies. -If you do not specify a path, the cmdlet uses \. -Specify the same installation path for all of the web applications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoticeTextPath -Specifies the absolute path to the text file (.txt) that contains the notice text. - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the web service port. -If you do not specify a port, unencrypted communications use port 80, and encrypted communications use port 443. -You need to specify the same value for all of the web applications. - -You must configure your firewall to allow communication through the ports for the Self-Service Portal and the Administration and Monitoring Website web applications. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoveryDBConnectionString -Specifies a connection string. -The web application uses the string that this parameter specifies to connect to the Recovery Database. -The connection string must contain values for the **Integrated Security** and **Initial Catalog** fields. - -If you do not specify this parameter, the cmdlet uses the connection string that you previously specified for any enabled web application. -All of the web applications connect to the Recovery Database by using the same connection string. -If you specify connection strings more than once, web applications use the most recent value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RecoveryDB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportUrl -Specifies the URL for the reports that the Microsoft SQL Server Reporting Services instance publishes. - -```yaml -Type: Uri -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportsReadOnlyAccessGroup -Specifies a domain user group. -Specify a group that has read permissions for the Reports area of the Administration and Monitoring Website web application. -The value for this parameter must be the same as the group that you specify for the *ReportsReadOnlyAccessGroup* parameter in the **Enable-MbamReport** cmdlet. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: ReportsGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SelfServicePortal -Indicates that this cmdlet acts on the Self-Service Portal web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipValidation -Indicates that this cmdlet bypasses validation of parameter values. -If you specify this parameter, the feature may not function properly after you enable it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmLockoutAutoReset -Indicates that Agent Services allows TPM lockout resets. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualDirectory -Specifies a virtual directory for the web application. -If you do not specify a virtual directory, the cmdlet uses the value HelpDesk for the Administration and Monitoring Website, or it uses the value self-service for the Self-Service Portal. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebServiceApplicationPoolCredential -Specifies the domain user that the application pool for the web applications uses. -If you specified a domain user group for the *AccessAccount* parameter when you ran the **Enable-MbamDatabase** cmdlet, the domain user that you specify for this parameter must be a member of that group. - -If you do not specify this parameter, the cmdlet uses the credentials that you previously specified for any enabled web application. -All of the web applications use the same application pool credentials. -If you specify credentials for web applications more than once, web applications use the most recent value. - -Important: For improved security, use an account that has limited user rights. -Also, configure the account so that the password never expires. -Verify that the account that you specify for this parameter is a built-in IIS_IUSRS account or has been added to the Impersonate a client after authentication and Log on as a batch job local security settings. -To view the local security setting, open the Local Security Policy editor, expand the Local Policies node, click the User Rights Assignment node, and then double-click the Impersonate a client after authentication and Log on as a batch job policies in the right pane. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: AppPoolCred - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-MbamWebApplication](disable-mbamwebapplication.md) - -[Get-MbamWebApplication](get-mbamwebapplication.md) - -[Test-MbamWebApplication](test-mbamwebapplication.md) - -[Enable-MbamReport](enable-mbamreport.md) - -[Enable-MbamDatabase](enable-mbamdatabase.md) - - diff --git a/docset/mdop/mbam/get-mbambitlockerrecoverykey.md b/docset/mdop/mbam/get-mbambitlockerrecoverykey.md deleted file mode 100644 index 769cce138e..0000000000 --- a/docset/mdop/mbam/get-mbambitlockerrecoverykey.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-MbamBitLockerRecoveryKey ---- - -# Get-MbamBitLockerRecoveryKey - -## SYNOPSIS -Requests an MBAM recovery key. - -## SYNTAX - -``` -Get-MbamBitLockerRecoveryKey -KeyID -Reason [-UserDomain ] [-UserID ] - -HelpDeskUrl [] -``` - -## DESCRIPTION -The **Get-MbamBitLockerRecoveryKey** cmdlet requests a Microsoft BitLocker Administration and Monitoring (MBAM) recovery key. -This recovery key enables a user to unlock a volume that is in recovery mode. -A volume can enter recovery mode due to a forgotten BitLocker PIN or password, a Windows update, or a change to the BIOS settings of the computer. - -## EXAMPLES - -### Example 1: Get a recovery key by specifying an eight-digit recovery key ID -``` -PS C:\> Get-MbamBitLockerRecoveryKey -KeyID "4374f3b9" -Reason "Forgot PIN" -HelpDeskUrl https://helpdeskserver/HelpDesk -UserDomain "ContosoDomain" -UserID "ContosoUser" -``` - -This command gets the recovery key from the specified help desk server for the user ContosoUser. -The command specifies only the first eight digits of the key ID. - -### Example 2: Get a recovery key by specifying the complete recovery key ID -``` -PS C:\> Get-MbamBitLockerRecoveryKey -KeyID "4374f3b9-58c7-4a41-87a5-0701d4fdbb86" -Reason "Forgot PIN" -HelpDeskUrl https://helpdeskserver/HelpDesk -UserDomain "ContosoDomain" -UserID "ContosoUser" -``` - -This command gets the recovery key from the specified help desk server for the user ContosoUser. -The command specifies the complete key ID. - -## PARAMETERS - -### -HelpDeskUrl -Specifies the URL for the MBAM help desk site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: url - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyID -Specifies the recovery key ID. -You can specify the first eight digits of the recovery key ID for this parameter or you can specify the complete ID. -For example, if the recovery key ID is 4734f3b9-58c7-4a41-87a5-0701d4fdbb86, you can specify 4734f3b9 for this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: key, k - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reason -Specifies the reason for the recovery key request. -Reasons can include a forgotten BitLocker PIN or password, a Windows Update, or a change to BIOS settings of the computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: r - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserDomain -Specifies the domain of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ud - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserID -Specifies the ID of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: uid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### string -The BitLocker recovery key for the specified volume. - -## NOTES - -## RELATED LINKS - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/get-mbamcmintegration.md b/docset/mdop/mbam/get-mbamcmintegration.md deleted file mode 100644 index cab415ed89..0000000000 --- a/docset/mdop/mbam/get-mbamcmintegration.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-MbamCMIntegration ---- - -# Get-MbamCMIntegration - -## SYNOPSIS -Gets the configuration of the MBAM Microsoft Endpoint Configuration Manager Integration feature. - -## SYNTAX - -``` -Get-MbamCMIntegration [] -``` - -## DESCRIPTION -The **Get-MbamCMIntegration** cmdlet gets the configuration of the Microsoft BitLocker Administration and Monitoring (MBAM) Microsoft Endpoint Configuration Manager Integration feature. - -## EXAMPLES - -### Example 1: Get the configuration of the Microsoft Endpoint Configuration Manager Integration feature -``` -PS C:\> Get-MbamCMIntegration -Name : Configuration Manager Integration -Enabled : False -Description : This feature will integrate MBAM with a Microsoft Endpoint Configuration Manager server. -``` - -This command gets the configuration of the MBAM Microsoft Endpoint Configuration Manager Integration feature in the local server. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.MBAM.Server.Commands.CMIntegrationConfiguration - -## NOTES - -## RELATED LINKS - -[Disable-MbamCMIntegration](disable-mbamcmintegration.md) - -[Enable-MbamCMIntegration](enable-mbamcmintegration.md) - -[Test-MbamCMIntegration](test-mbamcmintegration.md) - - diff --git a/docset/mdop/mbam/get-mbamreport.md b/docset/mdop/mbam/get-mbamreport.md deleted file mode 100644 index 83157a04f6..0000000000 --- a/docset/mdop/mbam/get-mbamreport.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-MbamReport ---- - -# Get-MbamReport - -## SYNOPSIS -Gets the configuration of the Reports feature. - -## SYNTAX - -``` -Get-MbamReport [] -``` - -## DESCRIPTION -The **Get-MbamReport** cmdlet gets the configuration of the Microsoft BitLocker Administration and Monitoring (MBAM) Reports feature. - -## EXAMPLES - -### Example 1: Get configuration of the Reports feature -``` -PS C:\> Get-MbamReport -Name : Reports -Enabled : True -Description : This feature includes reports for the Compliance and Auditing data that has been gathered by the MBAM Client. -ComplianceAndAuditDBConnectionString : Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog="MBAM Compliance Status"; -ComplianceAndAuditDBUser : ContosoDomain\ReportAccount -SsrsInstance : MSSQLSERVER -ReportsReadOnlyAccessGroup : ContosoDomain\ReportGroup -ReportUrl : https://ContosoReportsServer:443/ReportServer/ReportService2005.asmx -``` - -Gets the configuration of the Reports feature on the local server. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.MBAM.Server.Commands.ReportConfiguration - -## NOTES - -## RELATED LINKS - -[Disable-MbamReport](disable-mbamreport.md) - -[Enable-MbamReport](enable-mbamreport.md) - -[Test-MbamReport](test-mbamreport.md) - - diff --git a/docset/mdop/mbam/get-mbamtpmownerpassword.md b/docset/mdop/mbam/get-mbamtpmownerpassword.md deleted file mode 100644 index 5e23d782c3..0000000000 --- a/docset/mdop/mbam/get-mbamtpmownerpassword.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-MbamTPMOwnerPassword ---- - -# Get-MbamTPMOwnerPassword - -## SYNOPSIS -Gets a Trusted Platform Module (TPM). -owner password. - -## SYNTAX - -``` -Get-MbamTPMOwnerPassword -ComputerDomain -ComputerName -Reason - [-UserDomain ] [-UserID ] -HelpDeskUrl [] -``` - -## DESCRIPTION -The **Get-MbamTPMOwnerPassword** cmdlet gets an owner password for a Trusted Platform Module (TPM). -If a TPM does not accept the user PIN, it becomes locked. -You need to use the owner password to unlock the TPM. - -## EXAMPLES - -### Example 1: Get the TPM owner password -``` -PS C:\> Get-MbamTPMOwnerPassword -ComputerDomain "ContosoDomain" -ComputerName "ContosoComputer" -Reason "Forgot PIN" -HelpDeskUrl https://helpdeskserver/HelpDesk -UserDomain "ContosoDomain" -UserID "ContosoUser" -``` - -This command gets the TPM owner password from the MBAM help desk server for the specified computer and user. -The command also specifies the reason the TPM is locked. - -## PARAMETERS - -### -ComputerDomain -Specifies the domain of the locked computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: cd - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the name of the locked computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: cn - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HelpDeskUrl -Specifies the URL for the Microsoft BitLocker Administration and Monitoring (MBAM) help desk site. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: url - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Reason -Specifies the reason for the password request. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: r - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserDomain -Specifies the domain of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ud - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserID -Specifies the ID of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: uid - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### String -The TPM owner password. - -## NOTES - -## RELATED LINKS - -[Read-ADTpmInformation](read-adtpminformation.md) - -[Write-MbamTPMInformation](write-mbamtpminformation.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/get-mbamwebapplication.md b/docset/mdop/mbam/get-mbamwebapplication.md deleted file mode 100644 index 62f9800f9c..0000000000 --- a/docset/mdop/mbam/get-mbamwebapplication.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-MbamWebApplication ---- - -# Get-MbamWebApplication - -## SYNOPSIS -Gets the configuration of a web application. - -## SYNTAX - -### ParameterSetAdministrationPortal -``` -Get-MbamWebApplication [-AdministrationPortal] [] -``` - -### ParameterSetAgentService -``` -Get-MbamWebApplication [-AgentService] [] -``` - -### ParameterSetSelfServicePortal -``` -Get-MbamWebApplication [-SelfServicePortal] [] -``` - -## DESCRIPTION -The **Get-MbamWebApplication** cmdlet gets the configuration of a Microsoft BitLocker Administration and Monitoring (MBAM) web application. - -## EXAMPLES - -### Example 1: Get the configuration of Administration and Monitoring Website -``` -PS C:\> Get-MbamWebApplication -AdministrationPortal -Name : Administration Web Portal -Enabled : True -Description : This feature includes the Help Desk web application for administration. -InstallationPath : C:\inetpub -HostName : MYSERVER.contoso.com -Port : 443 -CertificateThumbprint : E2A7EA5533890D6567E40DFC46F53B3D31D6B689 -ComplianceAndAuditDBConnectionString : Integrated Security=SSPI;Data Source=MyDatabaseServer;Initial Catalog="MBAM Compliance Status"; -RecoveryDBConnectionString : Integrated Security=SSPI;Data Source=MyDatabaseServer;Initial Catalog="MBAM Recovery and Hardware"; -WebServiceApplicationPoolUser : MyDomain\MBAMWebServicesAccount -VirtualDirectory : /HelpDesk -CMIntegrationMode : False -ReportUrl : https://MyReportsServer/ReportServer -AdvancedHelpdeskAccessGroup : MyDomain\AdvancedHelpdeskUserGroup -HelpdeskAccessGroup : MyDomain\HelpdeskUserGroup -ReportsReadOnlyAccessGroup : MyDomain\ReportsUserGroup -``` - -This command gets the configuration of the Administration and Monitoring Website feature on the local server. - -### Example 2: Get the configuration of the Self-Service Portal -``` -PS C:\> Get-MbamWebApplication -SelfServicePortal -Name : Self Service Web Portal -Enabled : True -Description : This feature includes the Self Service web application that allows users to recover their own BitLocker keys. -InstallationPath : C:\inetpub -HostName : MYSERVER.contoso.com -Port : 443 -CertificateThumbprint : E2A7EA5533890D6567E40DFC46F53B3D31D6B689 -ComplianceAndAuditDBConnectionString : Integrated Security=SSPI;Data Source=MyDatabaseServer;Initial Catalog="MBAM Compliance Status"; -RecoveryDBConnectionString : Integrated Security=SSPI;Data Source=MyDatabaseServer;Initial Catalog="MBAM Recovery and Hardware"; -WebServiceApplicationPoolUser : MyDomain\MBAMWebServicesAccount -VirtualDirectory : /SelfService -``` - -This command gets the configuration of the Self-Service Portal feature on the local server. - -### Example 3: Get the configuration of the Agent Services feature -``` -PS C:\> Get-MbamWebApplication -AgentService -Name : Agent Web Services -Enabled : True -Description : This feature includes the web services to support the MBAM agent. -InstallationPath : C:\inetpub -HostName : MYSERVER.contoso.com -Port : 443 -ComplianceAndAuditDBConnectionString : Integrated Security=SSPI;Data Source=MyDatabaseServer;Initial Catalog="MBAM Compliance Status"; -RecoveryDBConnectionString : Integrated Security=SSPI;Data Source=MyDatabaseServer;Initial Catalog="MBAM Recovery and Hardware"; -WebServiceApplicationPoolUser : MyDomain\MBAMWebServicesAccount -CMIntegrationMode : False -``` - -This command gets the configuration of the Agent Services feature on the local server. - -## PARAMETERS - -### -AdministrationPortal -Indicates that this cmdlet acts on the Administration and Monitoring Website web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgentService -Indicates that this cmdlet acts on the Agent Services web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelfServicePortal -Indicates that this cmdlet acts on the Self-Service Portal web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.MBAM.Server.Commands.AdministrationPortalConfiguration, Microsoft.MBAM.Server.Commands.SelfServicePortalConfiguration, Microsoft.MBAM.Server.Commands.AgentServiceConfiguration - -## NOTES - -## RELATED LINKS - -[Disable-MbamWebApplication](disable-mbamwebapplication.md) - -[Enable-MbamWebApplication](enable-mbamwebapplication.md) - -[Test-MbamWebApplication](test-mbamwebapplication.md) - - diff --git a/docset/mdop/mbam/mbam.md b/docset/mdop/mbam/mbam.md deleted file mode 100644 index 8470709cd1..0000000000 --- a/docset/mdop/mbam/mbam.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=615114 -Help Version: 4.0.2.0 -Locale: en-US -Module Guid: CMDLETS -Module Name: MBAM -ms.date: 12/05/2016 -ms.devlang: powershell -title: MBAM ---- - -# MBAM Module -## Description -The following list contains links to the help topics for the Microsoft BitLocker Administration and Monitoring (MBAM) cmdlets. - -## MBAM Cmdlets -### [Disable-MbamCMIntegration](disable-mbamcmintegration.md) -Disables the MBAM Microsoft Endpoint Configuration Manager Integration feature. - -### [Disable-MbamReport](disable-mbamreport.md) -Disables the Reports feature. - -### [Disable-MbamWebApplication](disable-mbamwebapplication.md) -Disables a web application. - -### [Enable-MbamCMIntegration](enable-mbamcmintegration.md) -Enables the MBAM Microsoft Endpoint Configuration Manager Integration feature. - -### [Enable-MbamDatabase](enable-mbamdatabase.md) -Enables the Compliance and Audit and Recovery databases. - -### [Enable-MbamReport](enable-mbamreport.md) -Enables the Reports feature on the local server. - -### [Enable-MbamWebApplication](enable-mbamwebapplication.md) -Enables a web application. - -### [Get-MbamBitLockerRecoveryKey](get-mbambitlockerrecoverykey.md) -Requests an MBAM recovery key. - -### [Get-MbamCMIntegration](get-mbamcmintegration.md) -Gets the configuration of the MBAM Microsoft Endpoint Configuration Manager Integration feature. - -### [Get-MbamReport](get-mbamreport.md) -Gets the configuration of the Reports feature. - -### [Get-MbamTPMOwnerPassword](get-mbamtpmownerpassword.md) -Gets a Trusted Platform Module (TPM). - -### [Get-MbamWebApplication](get-mbamwebapplication.md) -Gets the configuration of a web application. - -### [Read-ADRecoveryInformation](read-adrecoveryinformation.md) -Reads the BitLocker volume recovery information from an Active Directory for one or more computer volumes. - -### [Read-ADTpmInformation](read-adtpminformation.md) -Reads Trusted Platform Module (TPM) owner information from Active Directory for one or more computers. - -### [Test-MbamCMIntegration](test-mbamcmintegration.md) -Checks server prerequisites and validates parameters. - -### [Test-MbamDatabase](test-mbamdatabase.md) -Checks server prerequisites and validates parameters for an MBAM database. - -### [Test-MbamReport](test-mbamreport.md) -Checks server prerequisites and validates parameter values for the Reports feature. - -### [Test-MbamWebApplication](test-mbamwebapplication.md) -Checks server prerequisites and validates parameter values for a web application feature. - -### [Write-MbamComputerUser](write-mbamcomputeruser.md) -Writes a set of users to a computer's Trusted Platform Module (TPM) owner authorization and each of the currently known computer's encrypted volumes. - -### [Write-MbamRecoveryInformation](write-mbamrecoveryinformation.md) -Writes the recovery information of a BitLocker encrypted volume to the Microsoft BitLocker Administration and Monitoring (MBAM) server. - -### [Write-MbamTPMInformation](write-mbamtpminformation.md) -Writes Trusted Platform Module (TPM) information to a Microsoft BitLocker Administration and Monitoring (MBAM) server. - diff --git a/docset/mdop/mbam/read-adrecoveryinformation.md b/docset/mdop/mbam/read-adrecoveryinformation.md deleted file mode 100644 index 2f81dfa71b..0000000000 --- a/docset/mdop/mbam/read-adrecoveryinformation.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Read-ADRecoveryInformation ---- - -# Read-ADRecoveryInformation - -## SYNOPSIS -Reads the BitLocker volume recovery information from an Active Directory for one or more computer volumes. - -## SYNTAX - -``` -Read-ADRecoveryInformation [-IgnoreVolumeRecoveryPackage] [-After ] [-Credential ] - [-ResultPageSize ] [-SearchBase ] -Server [-Recurse] [] -``` - -## DESCRIPTION -The **Read-ADRecoveryInformation** cmdlet gets BitLocker volume recovery data from an Active Directory computer object and child **msFVE-RecoveryInformation** objects or performs a search to retrieve this data from multiple computer objects. -The *Server* parameter is required and specifies the server hosting a Lightweight Directory Access Protocol (LDAP) service for the target domain. -The search for computer objects is not recursive. -A search is performed in the Active Directory path specified by the *SearchBase* parameter. -The default value of the *SearchBase* parameter is the default naming context of the target domain. -You can also use the *SearchBase* parameter to set the full path of a single computer object. - -## EXAMPLES - -### Example 1: Get RecoveryInformation records for each computer object -``` -PS C:\>$Cred = Get-Credential Contoso\adpullreader -PS C:\> Read-ADRecoveryInformation -Server "Contoso.com" -Credential $Cred -SearchBase "OU=Workstations,OU=Machines,DC=contoso,DC=com" -Computer : User1-pc.contoso.com -Time : 03/31/2015 20:42:45 -VolumeID : a750976a-1d28-4180-a164-b2315f97bde1 -RecoveryPasswordID : 808d0925-8044-4533-8f8c-411d6c020039 -RecoveryPassword : System.Security.SecureString -RecoveryPackage : {188, 1, 0, 0...} -ComputerDistinguishedName : CN= USER1-PC,OU=Workstations,OU=Machines,DC=contoso,DC=com - -Computer : User2-pc.contoso.com -Time : 11/21/2013 04:38:33 -VolumeID : a750976a-1d28-4180-a164-b2315f97bde1 -RecoveryPasswordID : 808d0925-8044-4533-8f8c-411d6c020039 -RecoveryPassword : System.Security.SecureString -RecoveryPackage : {188, 1, 0, 0...} -ComputerDistinguishedName : CN=USER2-PC,OU=Workstations,OU=Machines,DC=contoso,DC=com -``` - -This command queries for RecoveryInformation records corresponding to each computer object in the container "OU=Workstations,OU=Machines,DC=contoso,DC=com" (not including sub-containers). - -The Active Directory query is performed as the user Contoso.com\adpullreader. - -Each returned record is an instance of **PsObject** with name of the computer, the volume's id, recovery password id, recovery password, recovery package and the time at which it was backed up to Active Directory (if known). - -### Example 2: Get RecoveryInformation records for computer objects in a specified container recursively -``` -PS C:\>Read-ADRecoveryInformation -Server "Contoso.com" -SearchBase "OU=Machines,DC=contoso,DC=com" -Recurse -Computer : User3-pc.contoso.com -Time : 03/31/2015 20:42:45 -VolumeID : 14b2bc13-8061-4e82-a8e7-497fedebd978 -RecoveryPasswordID : 83a2c59b-5673-4dfc-930f-3dcbacab1cbc -RecoveryPassword : System.Security.SecureString -RecoveryPackage : {188, 1, 0, 0...} -ComputerDistinguishedName : CN=USER3-PC,OU=LAPTOPS,OU=Machines,DC=contoso,DC=com - -Computer : User1-pc.contoso.com -Time : 04/31/2015 20:40:30 -VolumeID : a750976a-1d28-4180-a164-b2315f97bde1 -RecoveryPasswordID : 808d0925-8044-4533-8f8c-411d6c020039 -RecoveryPassword : System.Security.SecureString -RecoveryPackage : {188, 1, 0, 0...} -ComputerDistinguishedName : CN= USER1-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com -``` - -This command queries for RecoveryInformation records for each computer object in the container "OU=Machines,DC=contoso,DC=com" and child containers recursively. - -The Active Directory query is performed under the cmdlet's process credentials. - -Each returned record is an instance of **PsObject** with name of the computer, the volume's id, recovery password id, recovery password, recovery package and the time at which it was backed up to Active Directory (if known). - -### Example 3: Get RecoveryInformation records for computer objects in a specified container after a specified date -``` -PS C:\>Read-ADRecoveryInformation -Server Contoso.com -SearchBase "OU=Workstations,OU=Machines,DC=Contoso,DC=com" -After ([datetime]::Parse("09/01/2014 01:00:00")) -Computer : User3-pc.contoso.com -Time : 03/31/2015 20:42:45 -VolumeID : 14b2bc13-8061-4e82-a8e7-497fedebd978 -RecoveryPasswordID : 83a2c59b-5673-4dfc-930f-3dcbacab1cbc -RecoveryPassword : System.Security.SecureString -RecoveryPackage : {188, 1, 0, 0...} -ComputerDistinguishedName : CN=USER3-PC,OU=LAPTOPS,OU=Machines,DC=Contoso,DC=com -``` - -This command queries for RecoveryInformation records corresponding to each computer object in the container "OU=Workstations,OU=Machines,DC=contoso,DC=com" (not including sub-containers). - -Only RecoveryInformation data that might have been backed up to Active Directory after September 1, 2014 01:00:00 UTC will be retrieved. - -The Active Directory query is performed under the cmdlet's process credentials. - -Each returned record is an instance of PsObject with name of the computer, the volume's id, recovery password id, recovery password, recovery package and the time at which it was backed up to Active Directory (if known). - -### Example 4: Get RecoveryInformation records for a distinguished computer in a specified container -``` -PS C:\>Read-ADRecoveryInformation -Server "Contoso.com" -SearchBase "CN=USER1-PC,OU=Workstations,OU=Machines,DC=contoso,DC=com" -Computer : User1-pc.contoso.com -Time : 31/03/2015 20:42:45 -VolumeID : a750976a-1d28-4180-a164-b2315f97bde1 -RecoveryPasswordID : 808d0925-8044-4533-8f8c-411d6c020039 -RecoveryPassword : System.Security.SecureString -RecoveryPackage : {188, 1, 0, 0...} -ComputerDistinguishedName : CN=USER1-PC,OU=Workstations,OU=Machines,DC=contoso,DC=com -``` - -This command queries the RecoveryInformation records for the computer object with the distinguished name: "CN= USER1-PC,OU=Workstations,OU=Machines,DC=contoso,DC=com" - -The Active Directory query is performed under the cmdlet's process credentials. - -Each returned record is an instance of PsObject with name of the computer, the volume's id, recovery password id, recovery password, recovery package, and the time at which it was backed up to Active Directory (if known). - -### Example 5: Migrate Bitlocker volume recovery information from Active Directory to the MBAM databases in a specified domain -``` -PS C:\>Read-ADRecoveryInformation -Server "Contoso.com" -Recurse | Write-MbamRecoveryInformation -RecoveryServiceEndPoint "https://mbam.contoso.com/MBAMRecoveryAndHardwareService/CoreService.svc" -``` - -This command migrates all of the Bitlocker volume recovery information data from Active Directory to the MBAM databases in the contoso.com domain. - -The write to MBAM is performed through the Hardware and Recovery service located on the mbam.contoso.com server machine. - -The Active Directory query and the write to MBAM is performed under the credentials of the hosting cmdlet process. - -## PARAMETERS - -### -After -Specifies that the cmdlet reads volume recovery information from Active Directory with corresponding timestamps more recent than the specified data and time. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the domain account credentials in which this cmdlet operates. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IgnoreVolumeRecoveryPackage -Indicates that this cmdlet ignores the volume recovery package. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recurse -Indicates that the cmdlet retrieves recovery information associated with the computer objects in the specified container and in all child containers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the maximum number of objects the server should return in a single page of results. -The default is 1000, which is the default server MaxPageSize limit. -If you change the server MaxPageSize to a value less than 1000, that value will take precedence over this parameter.Changing this value can be useful to throttling network bandwidth and reducing the Lightweight Directory Access Protocol (LDAP) server memory footprint required to service this query. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SearchBase -Specifies the Active Directory path under which to perform a one level search for computer objects or the full path to a specific computer object. -The default value of this parameter is the default naming context of the target domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: base - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: -- Active Directory Lightweight Domain Services -- Active Directory Domain Services -- Active Directory Snapshot instance - -You can specify the Active Directory Domain Services instance in one of the following ways: - Domain name values: -- Fully qualified domain name -- NetBIOS name -Directory server values: -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### PsObject -PropertyName PropertyType Example Value -Computer String "Server01.NA.Contoso.com" -VolumeID Guid -RecoveryPasswordID Guid -RecoveryPassword SecureString "111111-111111-111111-111111-111111-111111-111111-111111" -RecoveryPackage byte\[\] -Time DateTime - -## NOTES -* All arguments can be retrieved from input by property name. - -## RELATED LINKS - -[Read-ADTpmInformation](read-adtpminformation.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/read-adtpminformation.md b/docset/mdop/mbam/read-adtpminformation.md deleted file mode 100644 index 513e8ffebe..0000000000 --- a/docset/mdop/mbam/read-adtpminformation.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Read-ADTpmInformation ---- - -# Read-ADTpmInformation - -## SYNOPSIS -Reads Trusted Platform Module (TPM) owner information from Active Directory for one or more computers. - -## SYNTAX - -``` -Read-ADTpmInformation [-After ] [-Credential ] [-ResultPageSize ] - [-SearchBase ] -Server [-Recurse] [] -``` - -## DESCRIPTION -The **Read-ADTpmInformation** cmdlet gets Trusted Platform Module (TPM) owner information from an Active Directory computer object or linked **msTPM-InformationObject** or performs a search to retrieve this data for multiple computers. -The *Server* parameter is required and specifies the Active Directory Domain Services instance to connect to. -The search is not recursive. -A search for computer objects is performed in the Active Directory path specified by the *SearchBase* parameter. -The default value of the *SearchBase* parameter is the default naming context of the target domain. -You can also set the *SearchBase* parameter to the full path of a single computer object. - -## EXAMPLES - -### Example 1: Get TmpOwnerInformation records from a specified server -``` -PS C:\>$Cred = Get-Credential contoso\adpullreader -PS C:\> Read-ADTpmInformation -Server "Contoso.com" -Credential $Cred -SearchBase "OU=Workstations,OU=Machines,DC=Contoso,DC=com" -Computer : User1-pc.Contoso.com -Time : 23/09/2014 19:31:22 -TpmOwnerInformation : System.Security.SecureString -ComputerDistinguishedName : CN=USER1-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com - -Computer : User2-pc.Contoso.com -Time : 21/11/2013 04:38:33 -TpmOwnerInformation : System.Security.SecureString -ComputerDistinguishedName : CN=User2-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com -``` - -This command queries for TpmOwnerInformation records corresponding to each computer object in the container "OU=Workstations,OU=Machines,DC=Contoso,DC=com" (not including sub-containers). - -The Active Directory query is performed as a user named Contoso.com\adpullreader. - -Each returned record is an instance of **PsObject** with name of the computer, the TPM owner authorization string, and the time at which it was backed up to Active Directory (if known). - -### Example 2: Get TmpOwnerInformation records from a specified server recursively -``` -PS C:\>Read-ADTpmInformation -Server "Contoso.com" -SearchBase "OU=Machines,DC=Contoso,DC=com" -Recurse -Computer : user3-pc.Contoso.com -Time : 09/23/2014 19:31:22 -TpmOwnerInformation : System.Security.SecureString -ComputerDistinguishedName : CN=USER3-PC,OU=LAPTOPS,OU=Machines,DC=contoso,DC=com - -Computer : user1-pc.Contoso.com -Time : 11/21/2013 04:38:33 -TpmOwnerInformation : System.Security.SecureString -ComputerDistinguishedName : CN=USER1-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com -``` - -This command queries for TpmOwnerInformation records corresponding to each computer object in the container "OU=Workstations,OU=Machines,DC=Contoso,DC=com" and sub-containers. - -The Active Directory query is performed under the cmdlet's process credentials. - -Each returned record is an instance of **PsObject** with name of the computer, the TPM owner authorization string and the time at which it was backed up to Active Directory (if known). - -### Example 3: Get TpmOwnerInformation records for each computer in a specified container after a specified date -``` -PS C:\>Read-ADTpmInformation -Server "Contoso.com" -SearchBase "OU=Workstations,OU=Machines,DC=Contoso,DC=com" -After ([datetime]::Parse("09/01/2014 01:00:00")) -Computer : user3-pc.Contoso.com -Time : 09/23/2014 19:31:22 -TpmOwnerInformation : System.Security.SecureString -ComputerDistinguishedName : CN=USER3-PC,OU=LAPTOPS,OU=Machines,DC=Contoso,DC=com -``` - -This command queries for TpmOwnerInformation records corresponding to each computer object in the container "OU=Workstations,OU=Machines,DC=contoso,DC=com" (not including sub-containers). -The Active Directory query is performed under the cmdlet process's credentials. - -Only TPMOwnerInformation that might have been backed up to Active Directory after September 1, 2014 01:00:00 UTC will be retrieved. - -Each returned record is an instance of **PsObject** with name of the computer, the TPM owner authorization string and the time at which it was backed up to Active Directory (if known). - -### Example 4: Get a TpmOwnerInformation record for a distinguished computer in a specified container -``` -PS C:\>Read-ADTpmInformation -Server "Contoso.com" -SearchBase "CN=USER1-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com" -Computer : user1-pc.Contoso.com -Time : 23/09/2014 19:31:22 -TpmOwnerInformation : System.Security.SecureString -ComputerDistinguishedName : CN=USER1-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com -``` - -This command queries the TPMOwnerInformation record for the computer object with the distinguished computer name: "CN=USER1-PC,OU=Workstations,OU=Machines,DC=Contoso,DC=com". - -The Active Directory query is performed under the cmdlet's process credentials. - -The returned record is an instance of **PsObject** with name of the computer, the TPM owner authorization string and the time at which it was backed up to Active Directory (if known). - -## PARAMETERS - -### -After -Specifies that TPM owner passwords from Active Directory with corresponding timestamps more recent than the specified DateTime be read. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the domain account credentials in which this cmdlet operates. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that the cmdlet retrieves recovery information associated with the computer objects in the specified container and all child containers. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the maximum number of objects the server should return in a single page of results. -The default is 1000, which is the default server MaxPageSize limit. -If you change the server MaxPageSize to a value less than 1000, that value will take precedence over this parameter.Changing this value can be useful to throttling network bandwidth and reducing the LDAP server memory footprint required to service this query. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path in which this cmdlet searches. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: base - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the server in which to search for TPM information. -The value to use for \ in the Lightweight Directory Access Protocol (LDAP) query "LDAP://\/...". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### -Cmdlet parameters can be read from input by Property Name. - -## OUTPUTS - -### PsObject -Property Name PropertyType -Computer String -TpmOwnerInformation SecureString -Time DateTime - -## NOTES - -## RELATED LINKS - -[Read-ADRecoveryInformation](read-adrecoveryinformation.md) - -[Write-MbamTPMInformation](write-mbamtpminformation.md) - -[Write-MbamRecoveryInformation](write-mbamrecoveryinformation.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/test-mbamcmintegration.md b/docset/mdop/mbam/test-mbamcmintegration.md deleted file mode 100644 index e1300c4fc4..0000000000 --- a/docset/mdop/mbam/test-mbamcmintegration.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Test-MbamCMIntegration ---- - -# Test-MbamCMIntegration - -## SYNOPSIS -Checks server prerequisites and validates parameters. - -## SYNTAX - -### ParameterSetCMReportsOnly -``` -Test-MbamCMIntegration [-Detailed] [-SsrsServer ] [-SsrsInstance ] [-ReportsOnly] - -ReportsCollectionID -BitLockerProtectionBaselineLogicalName - -OperatingSystemDriveConfigurationItemLogicalName - -FixedDataDriveConfigurationItemLogicalName [] -``` - -### ParameterSetDefault -``` -Test-MbamCMIntegration [-Detailed] [-SsrsServer ] [-SsrsInstance ] [] -``` - -## DESCRIPTION -The **Test-MbamCMIntegration** cmdlet checks the server prerequisites and validates the parameters for the Microsoft BitLocker Administration and Monitoring (MBAM) Microsoft Endpoint Configuration Manager Integration feature. - -## EXAMPLES - -### Example 1: Check prerequisites to enable integration -``` -PS C:\> Test-MbamCMIntegration -``` - -This command tests the prerequisites for enabling the MBAM Microsoft Endpoint Configuration Manager Integration on the local Configuration Manager server. -The MBAM reports are deployed on the default SQL Server Reporting Services instance, MSSQLSERVER. - -### Example 2: Check prerequisites to enable integration with detailed output -``` -PS C:\> Test-MbamCMIntegration -Detailed - - -ID Type Message --- ---- ------- -CmInstallation Error This feature can be installed only on a server that is running Microsoft Endpoint Configuration Manager. -``` - -This command checks the prerequisites to enable the MBAM Microsoft Endpoint Configuration Manager Integration feature on the local Configuration Manager server with detailed output. - -## PARAMETERS - -### -BitLockerProtectionBaselineLogicalName -Specifies the logical name of the BitLocker protection baseline. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: BaselineLogicalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Detailed -Indicates that the cmdlet displays detailed information about the prerequisite check and parameter validation failures. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FixedDataDriveConfigurationItemLogicalName -Specifies the logical name of the fixed data drive configuration item. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: FDDLogicalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystemDriveConfigurationItemLogicalName -Specifies the logical name of the operating system drive configuration item. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: OSDLogicalName - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportsCollectionID -Specifies an existing collection ID. -This ID is used by the reports to set the default collection for which the reports display compliance data. - -```yaml -Type: String -Parameter Sets: ParameterSetCMReportsOnly -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportsOnly -Indicates that only the Configuration Manager reports are deployed. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetCMReportsOnly -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SsrsInstance -Specifies the SQL Server Reporting Services instance. -This instance hosts the Configuration Manager reports. -This parameter is ignored if the server has Configuration Manager installed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SsrsServer -Specifies the server with the SQL Server Reporting Services point role. -This server hosts the Configuration Manager reports. -If you do not specify a server, the Configuration Manager reports are deployed to the local server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### bool - -## NOTES - -## RELATED LINKS - -[Disable-MbamCMIntegration](disable-mbamcmintegration.md) - -[Enable-MbamCMIntegration](enable-mbamcmintegration.md) - -[Get-MbamCMIntegration](get-mbamcmintegration.md) - - diff --git a/docset/mdop/mbam/test-mbamdatabase.md b/docset/mdop/mbam/test-mbamdatabase.md deleted file mode 100644 index bf0e46893f..0000000000 --- a/docset/mdop/mbam/test-mbamdatabase.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Test-MbamDatabase ---- - -# Test-MbamDatabase - -## SYNOPSIS -Checks server prerequisites and validates parameters for an MBAM database. - -## SYNTAX - -### ParameterSetCompliance -``` -Test-MbamDatabase [-Detailed] -ConnectionString [-DatabaseName ] -AccessAccount - -ReportAccount [-ComplianceAndAudit] [] -``` - -### ParameterSetRecovery -``` -Test-MbamDatabase [-Detailed] -ConnectionString [-DatabaseName ] -AccessAccount - [-Recovery] [] -``` - -## DESCRIPTION -The **Test-MbamDatabase** cmdlet checks the server prerequisites and validates the parameters for the Microsoft BitLocker Administration and Monitoring (MBAM) database feature. - -## EXAMPLES - -### Example 1: Check prerequisites and validate parameters for the Compliance and Audit Database -``` -PS C:\> Test-MbamDatabase -ComplianceAndAudit -ConnectionString "Integrated Security=SSPI;Data Source=MyDatabaseServer" -AccessAccount "MyDomain\MyAccessAccount" -ReportAccount "MyDomain\MyReportAccount" -DatabaseName "MyComplianceDatabaseName" -``` - -This command checks the prerequisites and validates the parameters to enable the Compliance and Audit Database on MyDatabaseServer. -The name of the database is MyComplianceDatabaseName. -The domain account MyAccessAccount has read/write permission to the database, and MyReportAccount has read-only permission to the database for reporting purposes. -The command uses the current Windows account credentials for authentication. - -### Example 2: Check prerequisites and validate parameters for the Recovery Database -``` -PS C:\> Test-MbamDatabase -Recovery -ConnectionString "Integrated Security=SSPI;Data Source=MyDatabaseServer" -AccessAccount "MyDomain\MyAccessAccount" -DatabaseName "MyRecoveryDatabaseName" -``` - -This command checks the prerequisites and validates the parameters to enable the Recovery Database on MyRecoveryDatabaseServer. -The name of the database is MyRecoveryDatabaseName. -The domain account MyAccessAccount has read/write permission to the database. -The command uses the current Windows account credentials for authentication. - -### Example 3: Check prerequisites and validate parameters with detailed output -``` -PS C:\> Test-MbamDatabase -ComplianceAndAudit -ConnectionString "Integrated Security=SSPI;Data Source=MyDatabaseServer" -AccessAccount "MyDomain\MyAccessAccount" -ReportAccount "MyDomain\MyReportAccount" -DatabaseName "MyComplianceDatabaseName" -Detailed - - -ID Type Message --- ---- ------- -ComplianceConnectionString Error Cannot connect to the database with the provided connection string. -ComplianceDatabaseAccessAccount Error The user or group 'MyDomain\MyAccessAccount' cannot be found in Active Directory. -``` - -This command checks the prerequisites and validates the parameters to enable the Compliance and Audit Database on MyDatabaseServer with detailed output. - -## PARAMETERS - -### -AccessAccount -Specifies a domain user or group. -This domain user or group must have read/write permission to this database, which enables web applications to access the data and reports. -If the value is a domain user, the *WebServiceApplicationPoolCredential* parameter in the **Enable-MbamWebApplication** cmdlet must use the same user account. -If the value is a group, the domain account used by the *WebServiceApplicationPoolCredential* parameter must be a member of this group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComplianceAndAudit -Indicates that the cmdlet checks the server prerequisites and validates the parameter values for the Compliance and Audit Database. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetCompliance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionString -Specifies the connection string used to connect to the data store. -The Integrated Security field must be in the connection string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseName -Specifies the name of the database. -This parameter cannot contain leading or trailing spaces or non-printable characters. -If you do not specify a name, the Compliance and Audit Database is given the name MBAM Compliance Status, and the Recovery Database is given the name MBAM Recovery and Hardware. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Detailed -Indicates that the cmdlet displays detailed information about the prerequisite check and parameter validation failures. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recovery -Indicates that the cmdlet checks the server prerequisites and validates the parameter values for the Recovery Database. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetRecovery -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportAccount -Specifies a domain user or group. -This domain user or group must have read-only permission to this database, which enables reports to access the compliance and audit data. -If the value is a domain user, then the Compliance and Audit Database domain account of the report feature must be the same as the user. -If the value is a group, then the Compliance and Audit Database domain account of the report feature must be a member of this group. - -```yaml -Type: String -Parameter Sets: ParameterSetCompliance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### bool - -## NOTES - -## RELATED LINKS - -[Enable-MbamDatabase](enable-mbamdatabase.md) - -[Enable-MbamWebApplication](enable-mbamwebapplication.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/test-mbamreport.md b/docset/mdop/mbam/test-mbamreport.md deleted file mode 100644 index f8e1da0f1b..0000000000 --- a/docset/mdop/mbam/test-mbamreport.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Test-MbamReport ---- - -# Test-MbamReport - -## SYNOPSIS -Checks server prerequisites and validates parameter values for the Reports feature. - -## SYNTAX - -``` -Test-MbamReport [-Detailed] [-ComplianceAndAuditDBConnectionString ] - -ComplianceAndAuditDBCredential [-SsrsInstance ] -ReportsReadOnlyAccessGroup - [] -``` - -## DESCRIPTION -The **Test-MbamReport** cmdlet checks server prerequisites and validates parameter values for the Microsoft BitLocker Administration and Monitoring (MBAM) Reports feature. - -## EXAMPLES - -### Example 1: Check prerequisites and validate parameters for the Reports feature -``` -PS C:\> Test-MbamReport -ComplianceAndAuditDBConnectionString "Data Source=MyDatabaseServer;Initial Catalog=MBAM Compliance Status;Integrated Security=True" -ReportsReadOnlyAccessGroup "MyDomain\MyReportsGroup" -True -``` - -This command checks the prerequisites and validates the parameters for the Reports feature on the local server. -The connection string specifies that ContosoDatabaseServer hosts the Compliance and Audit Database. -The cmdlet prompts you to enter credentials for the Compliance and Audit Database. -The reports group is ContosoDomain\ReportsGroup. - -### Example 2: View details about prerequisites and validation for the Reports feature -``` -PS C:\> Test-MbamReport -ComplianceAndAuditDBConnectionString "Data Source=MyDatabaseServer;Initial Catalog=MBAM Compliance Status;Integrated Security=True" -ReportsReadOnlyAccessGroup "MyDomain\MyReportsGroup" -Detailed -ID Type Message --- ---- ------- -ReportsInstallation Error Unable to connect to the Reporting Services web service. Error message: The request failed with HTTP status 504: Proxy Timeout (The connection timed out.). -False -``` - -This command displays detailed information about prerequisites and validation of parameters for the Reports feature. -This command specifies the *Detailed* parameter. - -## PARAMETERS - -### -ComplianceAndAuditDBConnectionString -Specifies a connection string. -The local Microsoft SQL Server Reporting Services uses the string that this parameter specifies to connect to the Compliance and Audit Database feature. -The connection string must contain values for the **Integrated Security** and **Initial Catalog** fields. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ComplianceDB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComplianceAndAuditDBCredential -Specifies the domain account credentials that the local SQL Server Reporting Services instance uses to connect to the Compliance and Audit Database. -The domain user in the credentials must be the same as or a member of the report account of the Compliance and Audit Database. - -Important: For improved security, use an account that has limited privileges. -Also, configure the account so that the password never expires. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: ComplianceDBCred - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Detailed -Indicates that the cmdlet displays detailed information about the prerequisite check and parameter validation failures. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportsReadOnlyAccessGroup -Specifies a domain user group. -Specify a group that has read permissions for the reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ReportsGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SsrsInstance -Specifies the SQL Server Reporting Services instance. -After installation, this instance hosts the reports. -If you do not specify an instance, the cmdlet uses the default instance, MSSQLSERVER. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### bool - -## NOTES - -## RELATED LINKS - -[Disable-MbamReport](disable-mbamreport.md) - -[Enable-MbamReport](enable-mbamreport.md) - -[Get-MbamReport](get-mbamreport.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/test-mbamwebapplication.md b/docset/mdop/mbam/test-mbamwebapplication.md deleted file mode 100644 index 2872894bee..0000000000 --- a/docset/mdop/mbam/test-mbamwebapplication.md +++ /dev/null @@ -1,529 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Test-MbamWebApplication ---- - -# Test-MbamWebApplication - -## SYNOPSIS -Checks server prerequisites and validates parameter values for a web application feature. - -## SYNTAX - -### ParameterSetAdministrationPortal -``` -Test-MbamWebApplication [-Detailed] [-ComplianceAndAuditDBConnectionString ] - [-RecoveryDBConnectionString ] -AdvancedHelpdeskAccessGroup -HelpdeskAccessGroup - -ReportsReadOnlyAccessGroup [-Certificate ] [-HostName ] [-Port ] - -ReportUrl [-VirtualDirectory ] [-InstallationPath ] - [-WebServiceApplicationPoolCredential ] [-CMIntegrationMode] [-AdministrationPortal] - [] -``` - -### ParameterSetSelfServicePortal -``` -Test-MbamWebApplication [-Detailed] [-ComplianceAndAuditDBConnectionString ] - [-RecoveryDBConnectionString ] [-Certificate ] [-HostName ] [-Port ] - [-VirtualDirectory ] [-InstallationPath ] - [-WebServiceApplicationPoolCredential ] [-CompanyName ] [-HelpdeskUrlText ] - [-HelpdeskUrl ] [-DisableNoticePage] [-NoticeTextPath ] [-SelfServicePortal] [] -``` - -### ParameterSetAgentService -``` -Test-MbamWebApplication [-Detailed] [-ComplianceAndAuditDBConnectionString ] - [-RecoveryDBConnectionString ] [-Certificate ] [-HostName ] [-Port ] - [-InstallationPath ] [-WebServiceApplicationPoolCredential ] [-CMIntegrationMode] - [-TpmLockoutAutoReset] [-DataMigrationAccessGroup ] [-AgentService] [] -``` - -## DESCRIPTION -The **Test-MbamWebApplication** cmdlet checks server prerequisites and validates parameter values for a Microsoft BitLocker Administration and Monitoring (MBAM) web application feature. -The cmdlet validates the current computer for one of the following web applications: - -- Administration and Monitoring Website -- Agent Services -- Self-Service Portal - -## EXAMPLES - -### Example 1: Check prerequisites and validate parameters for Administration and Monitoring Website -``` -PS C:\> Test-MbamWebApplication -AdministrationPortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -AdvancedHelpdeskAccessGroup "Contoso\AdvancedUserGroup" -HelpdeskAccessGroup "Contoso\StandardUserGroup" -ReportsReadOnlyAccessGroup "Contoso\ReportUserGroup" -ReportUrl "https://ContosoReportServer/ReportServer" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -True -``` - -This command checks the prerequisites and validates parameter values to enable the Administration and Monitoring Website web application on the current server. -The command tests a configuration of the website that uses the Compliance and Audit Database and the Recovery Database present in the ContosoDatabaseServer and the reports present in the ContosoReportsServer. - -### Example 2: Check prerequisites and validate parameters for Self-Service Portal -``` -PS C:\> Test-MbamWebApplication -SelfServicePortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -True -``` - -This command checks the prerequisites and validates parameter values to enable the Self-Service Portal web application on this server. -The command checks the configuration of the Portal that uses the Compliance and Audit Database and the Recovery Database present in the ContosoDatabaseServer. - -### Example 3: Check prerequisites and validate parameters for Agent Services -``` -PS C:\> Test-MbamWebApplication -AgentService -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -True -``` - -This command checks the prerequisites and validates parameter values to enable the Agent Services feature on the current server. -The cmdlets verify a configuration of services that uses the Compliance and Audit Database and the Recovery Database present in the ContosoDatabaseServer. - -### Example 4: View detailed information -``` -PS C:\> Test-MbamWebApplication -AdministrationPortal -ComplianceAndAuditDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" -RecoveryDBConnectionString "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Recovery and Hardware" -AdvancedHelpdeskAccessGroup "Contoso\AdvancedUserGroup" -HelpdeskAccessGroup "Contoso\StandardUserGroup" -ReportsReadOnlyAccessGroup "Contoso\ReportUserGroup" -ReportUrl "https://ContosoReportServer/ReportServer" -Port 443 -WebServiceApplicationPoolCredential (Get-Credential) -Certificate (dir cert:\LocalComputer\My\E2A7EA5533890D6567E40DFC46F53B3D31D6B689) -Detailed -Type Message ----- ------- -Error Parameter "ComplianceAndAuditDBConnectionString" using value "Integrated Security=SSPI;Data Source=ContosoDatabaseServer;Initial Catalog=MBAM Compliance Status" is ... -Warning The application pool credential has a password that is set to expire. -Warning The application pool credential has administrator rights. -Warning Server communications have been configured without a certificate, which is not a secure configuration. -False -``` - -This command checks the prerequisites and validates parameter values to enable the Administration and Monitoring Website on this server. -The command specifies the *Detailed* parameter, and, therefore, displays detailed information. - -## PARAMETERS - -### -AdministrationPortal -Indicates that this cmdlet acts on the Administration and Monitoring Website web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdvancedHelpdeskAccessGroup -Specifies a domain user group. -This group has permissions for all areas of the Administration and Monitoring Website web application, except for reports. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: AdvancedHelpdeskGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AgentService -Indicates that this cmdlet acts on the Agent Services web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CMIntegrationMode -Indicates that all reports, except the Recovery Audit Report, are integrated into Microsoft Endpoint Configuration Manager. -If you enable the Configuration Manager Integration feature, specify this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAdministrationPortal -Aliases: CMMode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: CMMode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificate -Specifies the certificate to use for encrypted web communications. -If you do not specify a certificate, web communications are not encrypted. - -```yaml -Type: X509Certificate2 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -CompanyName -Specifies the company name associated with the web application. - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComplianceAndAuditDBConnectionString -Specifies a connection string. -The web application uses the string that this parameter specifies to connect to the Compliance and Audit Database feature. -The connection string must contain values for the **Integrated Security** and **Initial Catalog** fields. - -All of the web applications connect to the Compliance and Audit Database by using the same connection string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ComplianceDB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DataMigrationAccessGroup -Specifies the domain user group that is authorized to migrate Recovery information to MBAM server. - -```yaml -Type: String -Parameter Sets: ParameterSetAgentService -Aliases: DataMigrationGroup - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Detailed -Indicates that the cmdlet displays detailed information about the prerequisite check and parameter validation failures. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableNoticePage -Indicates whether the Self-Service Portal notice text is turned on or off. By default, the notice text is turned on. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HelpdeskAccessGroup -Specifies the domain user group that has permissions for the Manage TPM and Drive Recovery areas of the Administration and Monitoring Website web application. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: HelpdeskGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HelpdeskUrl -Specifies the URL for the MBAM help desk site. - -```yaml -Type: Uri -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HelpdeskUrlText -Specifies the helpdesk link text that will be displayed on the self-service portal. - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostName -Specifies a host name. -If you do not specify a host name, the cmdlet uses the fully qualified host name of the local computer. -Ensure that you specify the same host name for all of the web applications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InstallationPath -Specifies the installation path of the web application. -The installation process creates a folder named Microsoft BitLocker Management Solution in the location that this parameter specifies. -If you do not specify a path, the cmdlet uses \. -Specify the same installation path for all of the web applications. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoticeTextPath -Specifies the absolute path to the text file (.txt) that contains the notice text. - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Port -Specifies the web service port. -If you do not specify a port, unencrypted communications use port 80, and encrypted communications use port 443. -You need to specify the same value for all of the web applications. - -You must configure your firewall to allow communication through the ports for the Self-Service Portal and the Administration and Monitoring Website web applications. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoveryDBConnectionString -Specifies a connection string. -The web application uses the string that this parameter specifies to connect to the Recovery Database. -The connection string must contain values for the **Integrated Security** and **Initial Catalog** fields. -You need to use the same connection string to ensure that all of the web applications connect to the Recovery Database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RecoveryDB - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportUrl -Specifies the URL for the reports that the Microsoft SQL Server Reporting Services instance publishes. - -```yaml -Type: Uri -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportsReadOnlyAccessGroup -Specifies a domain user group. -You need to specify a group that has read permissions for the Reports area of the Administration and Monitoring Website web application. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: ReportsGroup - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SelfServicePortal -Indicates that this cmdlet acts on the Self-Service Portal web application. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmLockoutAutoReset -Indicates that Agent Services allows TPM lockout resets. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAgentService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualDirectory -Specifies a virtual directory for the web application. -If you do not specify a virtual directory, the cmdlet uses the value HelpDesk for Administration and Monitoring Website, or it uses the value SelfService for Self-Service Portal. - -```yaml -Type: String -Parameter Sets: ParameterSetAdministrationPortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ParameterSetSelfServicePortal -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WebServiceApplicationPoolCredential -Specifies the domain user that the application pool for the web applications uses. - -If you do not specify this parameter, the cmdlet uses the credentials that you previously specified for any enabled web application. -All of the web applications use the same application pool credentials. -If you specify credentials for web applications more than once, web applications use the most recent value. - -Important: For improved security use an account that has limited user rights. -Also, you need to configure the account so that the password never expires. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: AppPoolCred - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### bool - -## NOTES - -## RELATED LINKS - -[Disable-MbamWebApplication](disable-mbamwebapplication.md) - -[Enable-MbamWebApplication](enable-mbamwebapplication.md) - -[Get-MbamWebApplication](get-mbamwebapplication.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/write-mbamcomputeruser.md b/docset/mdop/mbam/write-mbamcomputeruser.md deleted file mode 100644 index 939f151cab..0000000000 --- a/docset/mdop/mbam/write-mbamcomputeruser.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Write-MbamComputerUser ---- - -# Write-MbamComputerUser - -## SYNOPSIS -Writes a set of users to a computer's Trusted Platform Module (TPM) owner authorization and each of the currently known computer's encrypted volumes. - -## SYNTAX - -``` -Write-MbamComputerUser -ComputerUser -Computer -RecoveryServiceEndPoint - [-RetryCount ] [-RetryIntervalSeconds ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Write-MbamComputerUser** cmdlet writes a set of users to a computer's Trusted Platform Module (TPM) owner authorization and each of the currently known computer's encrypted volumes. - -## EXAMPLES - -### Example 1: Give a user permission to recover TPM and Bitlocker information for a specified computer -``` -PS C:\>Write-MbamComputerUser -RecoveryServiceEndPoint http://MBAMServer.contoso.com:8080 -Computer User12-PC.Contoso.com -user @("User12@Contoso.com") -``` - -This command gives User12@Contoso.com permission to recover TPM and Bitlocker information from self-service portal for computer User12-PC.Contoso.com and its volumes. - -### Example 2: Give a user permission to recover TPM and Bitlocker information for a specified computer and suppress user confirmation -``` -PS C:\>Write-MbamComputerUser -RecoveryServiceEndPoint http://MBAMServer.contoso.com:8080 -Computer User12-PC.Contoso.com -user @("User12@Contoso.com") -Force -``` - -This command gives User12@Contoso.com permission to recover TPM and Bitlocker information from self-service portal for computer User12-PC.Contoso.com and its volumes. - -This command additionally suppresses user confirmation. - -### Example 3: Give multiple users permission to recover TPM and Bitlocker information for a specified computer and attempt recovery if the cmdlet fails -``` -PS C:\>Write-MbamComputerUser -svc http://MBAMServer.contoso.com:8080 -Computer User12-PC.Contoso.com -ComputerUser @("User12@Contoso.com", "User13@Contoso.net") -RetryCount 2 -RetryIntervalSeconds 10 -Force -``` - -This command gives User12@Contoso.com and User13@Contoso.com permission to recover TPM and Bitlocker information from self-service portal for computer User12-PC.Contoso.com and its volumes. - -The command also attempts recovery two more times with a ten second wait time between attempts. -This command additionally suppresses user confirmation. - -### Example 4: Give a user permission to recover TPM and Bitlocker information for a specified computer and attempt recovery if the cmdlet fails -``` -PS C:\>Write-MbamComputerUser -service http://MBAMServer.contoso.com:8080 -Computer User13-Desktop.Domain.Net -user @("User12@Contoso.com") -rc 2 -ri 10 -``` - -This command gives User12@Contoso.com permission to recover TPM and Bitlocker information from self-service portal for the computer User13-Desktop.Domain.Net and its volumes. - -This command attempts recovery two more times with a ten second wait time between attempts. - -### Example 5: Give a user permission to recover TPM and Bitlocker information for a specified machine and attempt recovery if the cmdlet fails -``` -PS C:\>Write-MbamComputerUser -service http://MBAMServer.contoso.com:8080 -Computer User13-Desktop.Domain.Net -user @("User12@Contoso.com") -rc 2 -ri 10 -Confirm -``` - -This command gives User12@Contoso.com permission to recover TPM and Bitlocker information from the self-service portal for the machine User13-Desktop.Domain.Net and its volumes. - -This command also attempts recovery two more times with a ten second wait time between attempts. - -## PARAMETERS - -### -Computer -Specifies the domain name and machine name of the domain-joined computer in \\\\ format (For instance, "contoso.com\ user12-pc"). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerUser -Specifies an array of fully qualified domain user accounts that have permission to access this volume recovery information in user principal name (UPN) (\@\ format (For instance, @("user12@contoso.com", " user13@contoso.com")). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: user - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryServiceEndPoint -Specifies the path to the Microsoft BitLocker Administration and Monitoring (MBAM) Recovery Service endpoint on the network. -The URL for the MBAM Recovery service endpoint is http(s)://\:\/MBAMRecoveryAndHardwareService/CoreService.svc (for instance, https://mbamserver.contoso.com:8080/ MBAMRecoveryAndHardwareService/CoreService.svc). - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: svc, service - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryCount -Specifies the maximum number of times to retry to send recovery information. -The cmdlet proceeds to the next record after the retry limit is exceeded. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: rc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryIntervalSeconds -Specifies the amount of time in seconds to wait before the cmdlet retries to send the recovery information. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ri - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Write-MbamRecoveryInformation](write-mbamrecoveryinformation.md) - -[Write-MbamTPMInformation](write-mbamtpminformation.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/write-mbamrecoveryinformation.md b/docset/mdop/mbam/write-mbamrecoveryinformation.md deleted file mode 100644 index d1f423e964..0000000000 --- a/docset/mdop/mbam/write-mbamrecoveryinformation.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Write-MbamRecoveryInformation ---- - -# Write-MbamRecoveryInformation - -## SYNOPSIS -Writes the recovery information of a BitLocker encrypted volume to the Microsoft BitLocker Administration and Monitoring (MBAM) server. - -## SYNTAX - -``` -Write-MbamRecoveryInformation [-ComputerUser ] [-RecoveryPackage ] - -RecoveryPassword -RecoveryPasswordID -VolumeID [-Time ] - -Computer -RecoveryServiceEndPoint [-RetryCount ] [-RetryIntervalSeconds ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Write-MbamRecoveryInformation** cmdlet writes the recovery information of a BitLocker encrypted volume to the Microsoft BitLocker Administration and Monitoring (MBAM) server. -The *RecoveryServiceEndPoint* parameter is required and identifies the MBAM server instance to which the recovery information will be written. -The *Computer* parameter is required and identifies the name and domain of the computer associated with the recovery information. -The *VolumeID* parameter is required and uniquely identifies the BitLocker encrypted volume associated with the recovery information. -The *RecoveryPassword* parameter is required and is the 48-digit value used for securing the recovery key package of the BitLocker encrypted volume. -The *RecoveryPasswordID* parameter is required and uniquely identifies the correct recovery password. -The timestamp of the recovery information is required and is supplied through the *Time* parameter. - -## EXAMPLES - -### Example 1: Write user recovery information on a specified computer to the MBAM server -``` -PS C:\>Write-MbamRecoveryInformation -Computer Computer.Contoso.com -ComputerUser @("User1@Contoso.com") -Time 1/20/2015 -RecoveryPassword 311111-363319-126170-621720-547228-519706-367873-363880 -RecoveryPasswordID Af3d4a74-f650-4370-AAA2-cbfc7fe2abb8 -VolumeId Bf3d4a74-f650-4370-BBB2-cbfc7fe2abb8 -RecoveryPackage @(49, 48, 49, 48, 49, 48, 49, 48, 49, 48, 49, 48, 49) -RecoveryServiceEndPoint http://mbamserver.contoso.com:8080 -Force -``` - -This command writes the recovery information for the user named User1@Contoso.com on the computer named Computer.Contoso.com to the MBAM server listening at the recovery service end point address http://mbamserver.contoso.com:8080. - -### Example 2: Write user recovery information on a specified computer to the MBAM server with verbose output -``` -PS C:\>Write-MbamRecoveryInformation -Computer Machine.Contoso.com -ComputerUser @("User1@Contoso.com") -Time 1/20/2015 -RecoveryPassword 311111-363319-126170-621720-547228-519706-367873-363880 -RecoveryPasswordID Af3d4a74-f650-4370-AAA2-cbfc7fe2abb8 -VolumeId Bf3d4a74-f650-4370-BBB2-cbfc7fe2abb8 -RecoveryPackage @(49, 48, 49, 48, 49, 48, 49, 48, 49, 48, 49, 48, 49) -RecoveryServiceEndPoint http://mbamserver.contoso.com:8080 -Force -Verbose -VERBOSE: Performing the operation "Write-MbamRecoveryInformation" on target "MBAM Recovery Database". -VERBOSE: Recovery Information for Volume bf3d4a74-f650-4370-bbb2-cbfc7fe2abb8 on Computer Machine.Contoso.com sent - successfully. -``` - -This command writes the recovery information specified by the cmdlet input parameters to the MBAM server listening at the recovery service end point address http://mbamserver.contoso.com:8080. - -This command also displays a confirmation message. - -### Example 3: Write user recovery information on a specified computer to the MBAM server with verbose output and attempt recovery if the cmdlet fails -``` -PS C:\>Write-MbamRecoveryInformation -Computer Machine.Contoso.com -ComputerUser @("user@Contoso.com") -Time 1/20/2015 -RetryCount 2 -RetryIntervalSeconds 5 -RecoveryPassword 311111-363319-126170-621720-547228-519706-367873-363880 -RecoveryPasswordID Af3d4a74-f650-4370-AAA2-cbfc7fe2abb8 -VolumeId Bf3d4a74-f650-4370-BBB2-cbfc7fe2abb8 -RecoveryPackage @(49, 48, 49, 48, 49, 48, 49, 48, 49, 48, 49, 48, 49) -RecoveryServiceEndPoint http://mbamserver.contoso.com:8080 -Force -Verbose -VERBOSE: Performing the operation "Write-MbamRecoveryInformation" on target "MBAM Recovery Database". -VERBOSE: Recovery Information for Volume bf3d4a74-f650-4370-bbb2-cbfc7fe2abb8 on Computer Machine.Contoso.com sent -successfully. -``` - -This command writes the recovery information specified by the cmdlet input parameters to the MBAM server listening at the recovery service end point address http://mbamserver.contoso.com:8080. - -This command also displays a confirmation message. - -If the write attempt is unsuccessful, the cmdlet retries two more times after an interval of five seconds. - -## PARAMETERS - -### -Computer -Specifies the domain name and computer name of the domain-joined computer in \\\\ format (for instance "contoso.com\User1-pc"). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerUser -Specifies a string array of fully qualified domain user accounts that have permission to access this volume recovery information in user principal name (UPN) (\@\ format (for instance: @("User1@contoso.com", "User2@contoso.com")) - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: user - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPackage -Specifies a byte array representing the BitLocker encryption key secured by the corresponding recovery password. -The package is associated with the volume identified by the VolumeID. -The recovery package corresponds to the **ms-FVE-KeyPackage** value in Active Directory (AD). - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: rkp, package - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoveryPassword -Specifies the 48-digit recovery password used for securing the recovery key package and unlocking BitLocker-protected drive in recovery mode. -The recovery password corresponds to the **ms-FVE-RecoveryPassword** value in AD, and has the standard 8 tuples of 6 digits format dddddd-dd ... -dd-dddddd. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: rp, password - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoveryPasswordID -Specifies the unique identifier associated with a BitLocker recovery password, used for identifying the correct recovery password. -The identifier is in GUID format (for instance: {xxxxxxxx-xxxx ... -xxxx}) and corresponds to the **ms-FVE-RecoveryGuid**, and has the standard GUID format. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: rpid, passwordid - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RecoveryServiceEndPoint -Specifies the path to the MBAM Recovery Service endpoint on the network. -The URL for MBAM Recovery service endpoint is http(s)://\:\/MBAMRecoveryAndHardwareService/CoreService.svc. -(for instance: https://mbamserver.contoso.com:8080/ MBAMRecoveryAndHardwareService/CoreService.svc) - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: svc, service - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryCount -Specifies the maximum number of times to retry to send Recovery Information. -The cmdlet proceeds to the next record after the retry limit is exceeded. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: rc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryIntervalSeconds -Specifies the amount of time in seconds to wait before the cmdlet retries to send the recovery information. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ri - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -Specifies the timestamp associated with the recovery information. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VolumeID -Specifies the unique drive identifier of the BitLocker protected drive associated with the recovery information. -The identifier is in GUID format (for instance: {xxxxxxxx-xxxx ... -xxxx}) and corresponds to the **msFVE-VolumeGuid** value in AD. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: vid - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Write-MbamComputerUser](write-mbamcomputeruser.md) - -[Write-MbamTPMInformation](write-mbamtpminformation.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/mbam/write-mbamtpminformation.md b/docset/mdop/mbam/write-mbamtpminformation.md deleted file mode 100644 index 5f5efeca6f..0000000000 --- a/docset/mdop/mbam/write-mbamtpminformation.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.MBAM.Server.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Write-MbamTPMInformation ---- - -# Write-MbamTPMInformation - -## SYNOPSIS -Writes Trusted Platform Module (TPM) information to a Microsoft BitLocker Administration and Monitoring (MBAM) server. - -## SYNTAX - -``` -Write-MbamTPMInformation [-ComputerUser ] -TpmOwnerInformation [-Time ] - -Computer -RecoveryServiceEndPoint [-RetryCount ] [-RetryIntervalSeconds ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Write-MbamTpmInformation** cmdlet writes Trusted Platform Module (TPM) owner information for a single computer to a Microsoft BitLocker Administration and Monitoring (MBAM) server. -The *RecoveryServiceEndPoint* parameter is required and identifies the MBAM server instance to which the TPM information is written. -The *Computer* parameter is required and identifies the name and domain of the computer associated with the TPM information. -The timestamp of the *TpmOwnerInformation* parameter is required and is supplied through the *Time* parameter. -A value with a newer timestamp will overwrite an older value in the database. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -Computer -Specifies the domain name and computer name of the domain-joined computer in \\\\ format (for instance "contoso.com\User1-pc"). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerUser -Specifies a string array of fully qualified domain user accounts that have permission to access this volume recovery information in user principal name (UPN) (\@\ format (for instance: @("User1@contoso.com", "User2@contoso.com")). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: user - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryServiceEndPoint -Specifies the path to the MBAM Recovery Service endpoint on the network. -The URL for MBAM Recovery service endpoint is http(s)://\:\/MBAMRecoveryAndHardwareService/CoreService.svc. -(for instance: https://mbamserver.contoso.com:8080/ MBAMRecoveryAndHardwareService/CoreService.svc). - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: svc, service - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryCount -Specifies the maximum number of times to retry to send recovery information. -The cmdlet proceeds to the next record after the retry limit is exceeded. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: rc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryIntervalSeconds -Specifies the amount of time in seconds to wait before the cmdlet retries to send the recovery information. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ri - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -Specifies the timestamp associated with the recovery information. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TpmOwnerInformation -Specifies the TPM Password hash value. -This value corresponds to the **msTPM-OwnerInformation** value or **msTPM-InformationObject** in Active Directory (AD). - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Write-MbamComputerUser](write-mbamcomputeruser.md) - -[Write-MbamRecoveryInformation](write-mbamrecoveryinformation.md) - -[Microsoft BitLocker Administration and Monitoring](/microsoft-desktop-optimization-pack/mbam-v25/) diff --git a/docset/mdop/uev/clear-uevappxpackage.md b/docset/mdop/uev/clear-uevappxpackage.md deleted file mode 100644 index c479f61a30..0000000000 --- a/docset/mdop/uev/clear-uevappxpackage.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Clear-UevAppxPackage ---- - -# Clear-UevAppxPackage - -## SYNOPSIS -Clears a setting in the computer or user sections of the registry. - -## SYNTAX - -### ParameterSetUser (Default) -``` -Clear-UevAppxPackage [-CurrentComputerUser] [-PackageFamilyName] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetComputer -``` -Clear-UevAppxPackage [-Computer] [-PackageFamilyName] [-WhatIf] [-Confirm] [] -``` - -### ParameterSetAllComputerTemplates -``` -Clear-UevAppxPackage [-Computer] [-All] [-WhatIf] [-Confirm] [] -``` - -### ParameterSetAllUserTemplates -``` -Clear-UevAppxPackage [-CurrentComputerUser] [-All] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Clear-UevAppxPackage** cmdlet clears a setting in the computer or user sections of the registry that enables or disables the uev_1 synchronization of Windows® 8 apps. -If you do not specify the *Computer* or *CurrentComputerUser* parameter, the cmdlet clears the setting for the package families for the current user. - -## EXAMPLES - -### Example 1: Remove Windows 8 apps -``` -PS C:\>Clear-UevAppxPackage -Computer -All -``` - -This command removes all Windows 8 apps from the Windows 8 app list on the computer. - -## PARAMETERS - -### -All -Indicates that the cmdlet clears all of the computer or user settings for the package families that you specify. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAllComputerTemplates, ParameterSetAllUserTemplates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Computer -Indicates that the cmdlet clears the setting for package families that you specify for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer, ParameterSetAllComputerTemplates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet clears the setting for the package families that you specify for the current user on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser, ParameterSetAllUserTemplates -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageFamilyName -Specifies an array of names of package families. -The cmdlet clears the setting for the package families of Windows 8 apps that you specify. - -```yaml -Type: String[] -Parameter Sets: ParameterSetUser, ParameterSetComputer -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-UevAppxPackage](./Disable-UevAppxPackage.md) - -[Enable-UevAppxPackage](./Enable-UevAppxPackage.md) - -[Get-UevAppxPackage](./Get-UevAppxPackage.md) - - diff --git a/docset/mdop/uev/clear-uevconfiguration.md b/docset/mdop/uev/clear-uevconfiguration.md deleted file mode 100644 index b51dd5679b..0000000000 --- a/docset/mdop/uev/clear-uevconfiguration.md +++ /dev/null @@ -1,473 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Clear-UevConfiguration ---- - -# Clear-UevConfiguration - -## SYNOPSIS -Clears uev_tla configuration settings. - -## SYNTAX - -### ParameterSetUser (Default) -``` -Clear-UevConfiguration [-CurrentComputerUser] [-MaxPackageSizeInBytes] [-SettingsStoragePath] - [-SyncProviderPingEnabled] [-SyncTimeoutInMilliseconds] [-SyncMethod] [-SyncEnabled] [-SyncOverMeteredNetwork] - [-SyncOverMeteredNetworkWhenRoaming] [-SettingsImportNotifyEnabled] [-SettingsImportNotifyDelayInSeconds] - [-DontSyncWindows8AppSettings] [-WaitForSyncTimeoutInMilliseconds] [-WaitForSyncOnApplicationStart] - [-WaitForSyncOnLogon] [-SyncUnlistedWindows8Apps] [-VdiCollectionName] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetComputer -``` -Clear-UevConfiguration [-Computer] [-MaxPackageSizeInBytes] [-SettingsStoragePath] - [-SettingsTemplateCatalogPath] [-SyncProviderPingEnabled] [-SyncTimeoutInMilliseconds] [-SyncMethod] - [-SyncEnabled] [-SyncOverMeteredNetwork] [-SyncOverMeteredNetworkWhenRoaming] [-SettingsImportNotifyEnabled] - [-SettingsImportNotifyDelayInSeconds] [-ContactITUrl] [-ContactITDescription] [-TrayIconEnabled] - [-FirstUseNotificationEnabled] [-DontSyncWindows8AppSettings] [-WaitForSyncTimeoutInMilliseconds] - [-WaitForSyncOnApplicationStart] [-WaitForSyncOnLogon] [-SyncUnlistedWindows8Apps] [-VdiCollectionName] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Clear-UevConfiguration** cmdlet clears uev_1 configuration settings. -If you specify the *CurrentComputerUser* parameter, the cmdlet clears the settings that you specify for the current user only. -If you specify the *Computer* parameter, the cmdlet clears the settings that you specify for all users on the computer. -You must have administrative credentials to use this cmdlet to clear settings for all users on the computer. -If you do not specify the *CurrentComputerUser* or *Computer* parameter, the cmdlet clears the settings that you specify for the current user only. - -## EXAMPLES - -### Example 1: Clear the setting for maximum package size for all users -``` -PS C:\> Clear-UevConfiguration -Computer -MaxPackageSizeInBytes -``` - -This command clears the setting for maximum package size for all users on the computer. - -### Example 2: Clear the setting for maximum package size for the current user -``` -PS C:\> Clear-UevConfiguration -CurrentComputerUser -MaxPackageSizeInBytes -``` - -This command clears the setting for maximum package size for the current user. - -### Example 3: Clear the setting for maximum package size by default for the current user -``` -PS C:\> Clear-UevConfiguration -MaxPackageSizeInBytes -``` - -This command clears the setting for maximum package size by default for the current user. - -### Example 4: Clear multiple settings for the current user -``` -PS C:\> Clear-UevConfiguration -MaxPackageSizeInBytes -SyncTimeoutInMilliseconds -``` - -This command clears the settings for maximum package size and synchronization timeout for the current user. - -## PARAMETERS - -### -Computer -Indicates that the cmdlet clears the settings for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactITDescription -Indicates that the cmdlet clears the setting for the description of the Contact IT link. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactITUrl -Indicates that the cmdlet clears the setting for the URL of the Contact IT link. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet clears the settings that you specify for the current user only. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DontSyncWindows8AppSettings -Indicates that the cmdlet clears the setting for not synchronizing settings for Windows® 8 apps. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FirstUseNotificationEnabled -Indicates that the cmdlet clears the setting for the notification of first-use. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPackageSizeInBytes -Indicates that the cmdlet clears the setting for the maximum package size. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsImportNotifyDelayInSeconds -Indicates that the cmdlet clears the setting for the delay before uev_tla notifies the user about the settings import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsImportNotifyEnabled -Indicates that the cmdlet clears the setting for the notification of settings import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsStoragePath -Indicates that the cmdlet clears the setting for the path of the location where uev_tla stores the user settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsTemplateCatalogPath -Indicates that the cmdlet clears the setting for the path of the location where uev_tla stores the settings template catalog. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncEnabled -Indicates that the cmdlet clears the setting that enables the synchronization of settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncMethod -Indicates that the cmdlet clears the setting for the method of the synchronization of settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncOverMeteredNetwork -Indicates that the cmdlet clears the setting for synchronization over metered connections. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncOverMeteredNetworkWhenRoaming -Indicates that the cmdlet clears the setting for synchronization over a metered connection that is roaming. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncProviderPingEnabled -Indicates that the cmdlet clears the setting that enables the sync provider to ping for network access before doing a sync. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncTimeoutInMilliseconds -Indicates that the cmdlet clears the setting for the timeout before uev_tla synchronizes settings from the settings repository. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncUnlistedWindows8Apps -Indicates that the cmdlet clears the setting for the synchronization of unlisted Windows 8 apps. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrayIconEnabled -Indicates that the cmdlet clears the setting for the icon in the notification area. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VdiCollectionName -Indicates that the cmdlet performs synchronization in a pooled VDI-type environment when computers are not persistent. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForSyncOnApplicationStart -Indicates that the cmdlet clears the setting for waiting for synchronization to finish before the user can start an application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForSyncOnLogon -Indicates that the cmdlet clears the setting for waiting for synchronization to finish before the user can log on. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForSyncTimeoutInMilliseconds -For internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-UevConfiguration](./Get-UevConfiguration.md) - -[Set-UevConfiguration](./Set-UevConfiguration.md) - -[Import-UevConfiguration](./Import-UevConfiguration.md) - -[Export-UevConfiguration](./Export-UevConfiguration.md) - - diff --git a/docset/mdop/uev/disable-uevappxpackage.md b/docset/mdop/uev/disable-uevappxpackage.md deleted file mode 100644 index 9f94c70fde..0000000000 --- a/docset/mdop/uev/disable-uevappxpackage.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Disable-UevAppxPackage ---- - -# Disable-UevAppxPackage - -## SYNOPSIS -Disables uev_tla synchronization of Windows 8 apps. - -## SYNTAX - -### ParameterSetUser (Default) -``` -Disable-UevAppxPackage [-CurrentComputerUser] [-PackageFamilyName] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetComputer -``` -Disable-UevAppxPackage [-Computer] [-PackageFamilyName] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-UevAppxPackage** cmdlet disables uev_1 synchronization of Windows® 8 apps. -The cmdlet adds a setting to the computer or user sections of the registry that disables the package family names of Windows 8 apps that you specify. -If you do not specify the *Computer* or *CurrentComputerUser* parameters, the cmdlet disables the package family names of Windows 8 apps for the current user. - -## EXAMPLES - -### Example 1: Disable synchronization of a Windows 8 app -``` -PS C:\>Disable-UevAppxPackage -Computer -PackageFamilyName "Microsoft.BingFinance" -``` - -This command disables synchronization of the Bing Finance app for all users on the computer. - -## PARAMETERS - -### -Computer -Indicates that the cmdlet disables the Windows 8 apps that you specify for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet disables the Windows 8 apps that you specify for the current user only. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageFamilyName -Specifies an array of package families. -The cmdlet disables the package families of Windows 8 apps that you specify. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-UevAppxPackage](./Clear-UevAppxPackage.md) - -[Enable-UevAppxPackage](./Enable-UevAppxPackage.md) - -[Get-UevAppxPackage](./Get-UevAppxPackage.md) - - diff --git a/docset/mdop/uev/disable-uevtemplate.md b/docset/mdop/uev/disable-uevtemplate.md deleted file mode 100644 index 364e8e9f71..0000000000 --- a/docset/mdop/uev/disable-uevtemplate.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Disable-UevTemplate ---- - -# Disable-UevTemplate - -## SYNOPSIS -Disables a settings location template. - -## SYNTAX - -``` -Disable-UevTemplate [-ID] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-UevTemplate** cmdlet disables a settings location template for the current user of the computer. -Use this cmdlet to disable a settings location template for an individual user. -To disable a settings location template for all users on the computer, use the **Unregister-UevTemplate** cmdlet. - -## EXAMPLES - -### Example 1: Disable a specific template -``` -PS C:\> Disable-UevTemplate -ID "MicrosoftCalculator6" -``` - -This command disables a settings location template that has the specified ID for the current user. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ID -Specifies the ID of a settings location template. -The cmdlet disables the template that you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TemplateID - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string -The settings location template ID. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-UevTemplate](./Enable-UevTemplate.md) - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Register-UevTemplate](./Register-UevTemplate.md) - -[Test-UevTemplate](./Test-UevTemplate.md) - -[Unregister-UevTemplate](./Unregister-UevTemplate.md) - -[Update-UevTemplate](./Update-UevTemplate.md) - - diff --git a/docset/mdop/uev/enable-uevappxpackage.md b/docset/mdop/uev/enable-uevappxpackage.md deleted file mode 100644 index 606198f425..0000000000 --- a/docset/mdop/uev/enable-uevappxpackage.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-UevAppxPackage ---- - -# Enable-UevAppxPackage - -## SYNOPSIS -Enables uev_tla synchronization of Windows 8 apps. - -## SYNTAX - -### ParameterSetUser (Default) -``` -Enable-UevAppxPackage [-CurrentComputerUser] [-PackageFamilyName] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetComputer -``` -Enable-UevAppxPackage [-Computer] [-PackageFamilyName] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-UevAppxPackage** cmdlet enables uev_1 synchronization of Windows® 8 apps. -The cmdlet adds a setting to the computer or user sections of the registry that enables the package family names of Windows 8 apps that you specify. -If you do not specify the *Computer* or *CurrentComputerUser* parameters, the cmdlet enables the package family names for the current user. - -## EXAMPLES - -### Example 1: Enable synchronization of a Windows 8 app -``` -PS C:\>Enable-UevAppxPackage -PackageFamilyName "Microsoft.BingTravel" -``` - -This command enables synchronization of settings for the Bing Travel Windows 8 app for the current user. - -## PARAMETERS - -### -Computer -Indicates that the cmdlet enables the package families that you specify for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet enables the package families that you specify for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PackageFamilyName -Specifies an array of names of package families. -The cmdlet enables the package families of Windows 8 apps that you specify. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-UevAppxPackage](./Clear-UevAppxPackage.md) - -[Disable-UevAppxPackage](./Disable-UevAppxPackage.md) - -[Get-UevAppxPackage](./Get-UevAppxPackage.md) - - diff --git a/docset/mdop/uev/enable-uevtemplate.md b/docset/mdop/uev/enable-uevtemplate.md deleted file mode 100644 index 174d09559a..0000000000 --- a/docset/mdop/uev/enable-uevtemplate.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Enable-UevTemplate ---- - -# Enable-UevTemplate - -## SYNOPSIS -Enables a settings location template. - -## SYNTAX - -``` -Enable-UevTemplate [-ID] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-UevTemplate** cmdlet enables a settings location template for the current user of the computer. - -## EXAMPLES - -### Example 1: Enable a specific template -``` -PS C:\> Enable-UevTemplate -ID "MicrosoftCalculator6" -``` - -This command enables a settings location template that has the specified ID for the current user. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ID -Specifies the ID of a settings location template. -The cmdlet enables the template that you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TemplateID - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string -The settings location template ID. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-UevTemplate](./Disable-UevTemplate.md) - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Register-UevTemplate](./Register-UevTemplate.md) - -[Test-UevTemplate](./Test-UevTemplate.md) - -[Unregister-UevTemplate](./Unregister-UevTemplate.md) - -[Update-UevTemplate](./Update-UevTemplate.md) - - diff --git a/docset/mdop/uev/export-uevconfiguration.md b/docset/mdop/uev/export-uevconfiguration.md deleted file mode 100644 index 140713ebfe..0000000000 --- a/docset/mdop/uev/export-uevconfiguration.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Export-UevConfiguration ---- - -# Export-UevConfiguration - -## SYNOPSIS -Exports the uev_tla configuration. - -## SYNTAX - -``` -Export-UevConfiguration [-Path] [] -``` - -## DESCRIPTION -The **Export-UevConfiguration** cmdlet exports the uev_1 computer configuration to a settings migration (.uev) file. -The cmdlet exports all uev_tla agent settings for all users on the computer. - -## EXAMPLES - -### Example 1: Export the UE-V configuration -``` -PS C:\> Export-UevConfiguration -Path "ContosoUev.uev" -``` - -This command exports the uev_tla computer configuration to the settings migration file named ContosoUev.uev. - -## PARAMETERS - -### -Path -Specifies the path of the settings migration file. -The cmdlet exports the uev_tla configuration to the settings migration file that you specify. -The extension of the settings migration file must be .uev. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-UevConfiguration](./Get-UevConfiguration.md) - -[Set-UevConfiguration](./Set-UevConfiguration.md) - -[Clear-UevConfiguration](./Clear-UevConfiguration.md) - -[Import-UevConfiguration](./Import-UevConfiguration.md) - - diff --git a/docset/mdop/uev/export-uevpackage.md b/docset/mdop/uev/export-uevpackage.md deleted file mode 100644 index e0aa5eab73..0000000000 --- a/docset/mdop/uev/export-uevpackage.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Export-UevPackage ---- - -# Export-UevPackage - -## SYNOPSIS -Exports the settings stored in a settings package. - -## SYNTAX - -### Path (Default) -``` -Export-UevPackage [-Path] [-WhatIf] [-Confirm] [] -``` - -### LiteralPath -``` -Export-UevPackage -LiteralPath [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-UevPackage** cmdlet exports the settings that are stored in a settings package to an XML file. - -## EXAMPLES - -### Example 1: Export a UE-V package -``` -PS C:\> Export-UevPackage -Path "MicrosoftCalculator6.pkgx" - - -LAAAAAAAAAABAAAA/////////////////////60AAABQAAAAVAIAANQBAAA= -2 - - -``` - -This command exports a settings package file for Microsoft calculator by using the *Path* parameter. - -### Example 2: Export a UE-V package by name -``` -PS C:\> Export-UevPackage -Path "*calc*.pkgx" - - - - -LAAAAAAAAAABAAAA/////////////////////60AAABQAAAAVAIAANQBAAA= -2 - - -``` - -This command exports a settings package file for Microsoft calculator by using wildcard characters in the file name. - -### Example 3: Export a UE-V package by path -``` -PS C:\> Export-UevPackage -LiteralPath "MicrosoftCalculator6.pkgx" - - -LAAAAAAAAAABAAAA/////////////////////60AAABQAAAAVAIAANQBAAA= -2 - - -``` - -This command exports a settings package file for Microsoft calculator. -The example does not use wildcard characters in the path. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiteralPath -Specifies an array of literal file paths. -The cmdlet exports the settings location templates that have the literal paths that you specify. - -```yaml -Type: String[] -Parameter Sets: LiteralPath -Aliases: PSPath - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies an array of file paths. -The cmdlet exports the settings location templates that have the paths you specify. -Use wildcards to specify multiple files. - -```yaml -Type: String[] -Parameter Sets: Path -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string[] -A collection of paths to the settings packages. - -## OUTPUTS - -### System.String -This cmdlet generates XML text that describes the settings stored in the specified settings package. - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/uev/get-uevappxpackage.md b/docset/mdop/uev/get-uevappxpackage.md deleted file mode 100644 index f9661e94f2..0000000000 --- a/docset/mdop/uev/get-uevappxpackage.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-UevAppxPackage ---- - -# Get-UevAppxPackage - -## SYNOPSIS -Gets a list of Windows 8 apps and synchronization status. - -## SYNTAX - -### ParameterSetNoParameter (Default) -``` -Get-UevAppxPackage [] -``` - -### ParameterSetComputer -``` -Get-UevAppxPackage [-Computer] [] -``` - -### ParameterSetUser -``` -Get-UevAppxPackage [-CurrentComputerUser] [] -``` - -## DESCRIPTION -The **Get-UevAppxPackage** cmdlet gets a list of Windows® 8 apps and the uev_1 synchronization status for the apps. -If you do not specify the **Computer** or **CurrentComputerUser** parameters, the cmdlet gets the list of Windows 8 apps for the current user. - -## EXAMPLES - -### Example 1: Get the list of Windows 8 apps -``` -PS C:\>Get-UevAppxPackage -CurrentComputerUser -``` - -This command gets the list of Windows 8 apps that are configured for the current user. - -## PARAMETERS - -### -Computer -Indicates that the cmdlet gets the Windows 8 apps and uev_tla synchronization status for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet gets the Windows 8 apps and uev_tla synchronization status for the current user on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-UevAppxPackage](./Clear-UevAppxPackage.md) - -[Disable-UevAppxPackage](./Disable-UevAppxPackage.md) - -[Enable-UevAppxPackage](./Enable-UevAppxPackage.md) - - diff --git a/docset/mdop/uev/get-uevconfiguration.md b/docset/mdop/uev/get-uevconfiguration.md deleted file mode 100644 index 181346d9bd..0000000000 --- a/docset/mdop/uev/get-uevconfiguration.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-UevConfiguration ---- - -# Get-UevConfiguration - -## SYNOPSIS -Gets the uev_tla configuration settings. - -## SYNTAX - -### ParameterSetActiveSettings (Default) -``` -Get-UevConfiguration [] -``` - -### ParameterSetComputer -``` -Get-UevConfiguration [-Computer] [] -``` - -### ParameterSetUser -``` -Get-UevConfiguration [-CurrentComputerUser] [] -``` - -### ParameterSetDetails -``` -Get-UevConfiguration [-Details] [] -``` - -## DESCRIPTION -The **Get-UevConfiguration** cmdlet gets the uev_1 configuration settings. -If you specify the *Computer* parameter, the cmdlet gets the settings for all users on the computer. -If you specify the *CurrentComputerUser* parameter, the cmdlet gets the settings for just the current user. - -## EXAMPLES - -### Example 1: Get the uev_tla configurationuev_tla -``` -PS C:\> Get-UevConfiguration - - -Key Value ---- ----- -MaxPackageSizeInBytes 700000 -SettingsImportNotifyDelayInSeconds 10 -SettingsImportNotifyEnabled False -SettingsStoragePath \\ServerName\Path\To\CentralStore -SettingsTemplateCatalogPath -SyncEnabled True -SyncMethod OfflineFiles -SyncFromRepositoryTimeoutInMilliseconds 2000 -``` - -This command gets the active uev_tla configuration on the computer where you run the cmdlet. - -### Example 2: Get the computer-wide configuration -``` -PS C:\> Get-UevConfiguration -Computer - - -Key Value ---- ----- -MaxPackageSizeInBytes 700000 -SettingsImportNotifyDelayInSeconds -SettingsImportNotifyEnabled -SettingsStoragePath \\ServerName\Path\To\CentralStore -SettingsTemplateCatalogPath -SyncEnabled -SyncMethod OfflineFiles -SyncFromRepositoryTimeoutInMilliseconds 2000 -``` - -This command gets the uev_tla configuration settings for all users on the computer. -The command gets the HKey Local Machine (HKLM) configuration settings that are in the registry. - -### Example 3: Get the user-specific configuration -``` -PS C:\> Get-UevConfiguration -CurrentComputerUser - - -Key Value ---- ----- -MaxPackageSizeInBytes -SettingsImportNotifyDelayInSeconds -SettingsImportNotifyEnabled -SettingsStoragePath -SyncEnabled -SyncMethod -SyncFromRepositoryTimeoutInMilliseconds -``` - -This command gets the user-specific uev_tla configuration, including the HKey Current User (HKCU) configuration settings that are in the registry. - -## PARAMETERS - -### -Computer -Indicates that the cmdlet gets the uev_tla configuration settings for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet gets the uev_tla configuration settings for the current user only. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Details -Indicates that the cmdlet gets the uev_tla configuration settings, including all of the details. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetDetails -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Collections.Generic.Dictionary, System.Collections.Generic.KeyValuePair -This cmdlet generates a **KeyValuePair** object that represents the setting name and value, if you specify a setting name. -Otherwise, this cmdlet generates a list of all of the settings. - -## NOTES -* A setting value can be from four sources (in order of precedence): group policy settings for the current user, group policy settings for the local computer, the current user, and the local computer. If no setting value is found in any of the sources, uev_tla uses the default setting. - -## RELATED LINKS - -[Set-UevConfiguration](./Set-UevConfiguration.md) - -[Clear-UevConfiguration](./Clear-UevConfiguration.md) - -[Import-UevConfiguration](./Import-UevConfiguration.md) - -[Export-UevConfiguration](./Export-UevConfiguration.md) - - diff --git a/docset/mdop/uev/get-uevtemplate.md b/docset/mdop/uev/get-uevtemplate.md deleted file mode 100644 index f68500c078..0000000000 --- a/docset/mdop/uev/get-uevtemplate.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-UevTemplate ---- - -# Get-UevTemplate - -## SYNOPSIS -Gets settings location templates for uev_tla. - -## SYNTAX - -### ParameterSetNoParameter (Default) -``` -Get-UevTemplate [] -``` - -### ParameterSetApplication -``` -Get-UevTemplate -Application [] -``` - -### ParameterSetTemplateID -``` -Get-UevTemplate -TemplateID [] -``` - -### ParameterProfile -``` -Get-UevTemplate -Profile [] -``` - -### ParameterSetApplicationOrTemplateID -``` -Get-UevTemplate [-ApplicationOrTemplateID] [] -``` - -## DESCRIPTION -The **Get-UevTemplate** cmdlet gets settings location templates that are registered with uev_1. -Use this cmdlet to display information which includes the template ID, template name, template version, template description, template type, and the state settings of the template. -The template ID includes a primary ID and a secondary ID. -Applications in the same suite share the same primary ID. - -## EXAMPLES - -### Example 1: Get all registered templates -``` -PS C:\> Get-UevTemplate | Format-Table -AutoSize -TemplateId TemplateName TemplateVersion PackageVersion TemplateType Enabled EnableStateLocation TemplateDescription ----------- ------------ --------------- -------------- ------------ ------- ------------------- ------------------- -DesktopSettings Desktop Settings 1 N/A OS False LocalMachine -MicrosoftNotepad6 Microsoft Notepad 0 N/A Application True NotSet -MicrosoftCalculator6 Microsoft Calculator 0 N/A Application True NotSet -MicrosoftCommunicator2007 Microsoft Communicator 2007 7 N/A Application True NotSet -MicrosoftOffice2010Win64 Microsoft Office 2010 (64-bit) 18 N/A Application True NotSet -MicrosoftOffice2010Win64.common Common Settings 18 N/A Application True NotSet -MicrosoftOffice2010Win64.Access Microsoft Access 2010 (64-bit) 18 N/A Application True NotSet -``` - -This command gets all the settings location templates that are registered with uev_tla, and then passes them to the **Format-Table** cmdlet by using the pipeline operator. -For more information, type `Get-Help Format-Table`. - -### Example 2: Get registered templates that contain a specified string -``` -PS C:\> Get-UevTemplate -ApplicationOrTemplateID "office" | Format-Table -AutoSize -TemplateId TemplateName TemplateVersion PackageVersion TemplateType Enabled EnableStateLocation TemplateDescription ----------- ------------ --------------- -------------- ------------ ------- ------------------- ------------------- -MicrosoftOffice2010Win64 Microsoft Office 2010 (64-bit) 18 N/A Application True NotSet -MicrosoftOffice2010Win64.common Common Settings 18 N/A Application True NotSet -MicrosoftOffice2010Win64.Access Microsoft Access 2010 (64-bit) 18 N/A Application True NotSet -MicrosoftOffice2010Win64.Excel Microsoft Excel 2010 (64-bit) 18 N/A Application True NotSet -MicrosoftOffice2010Win64.Groove Microsoft Groove 2010 (64-bit) 18 N/A Application True NotSet -MicrosoftOffice2010Win64.InfoPath Microsoft InfoPath 2010 (64-bit) 18 N/A Application True NotSet -``` - -This command gets settings location templates that are registered with uev_tla, and passes them to **Format-Table** by using the pipeline operator. -This command specifies a value for the *ApplicationOrTemplateID* parameter. -The cmdlet gets the templates that have a name or template ID that includes the specified string. - -### Example 3: Get registered templates that contain a specified string that includes a wildcard -``` -PS C:\> Get-UevTemplate -ApplicationOrTemplateID "office*word" | Format-Table -AutoSize -TemplateId TemplateName TemplateVersion PackageVersion TemplateType Enabled EnableStateLocation TemplateDescription ----------- ------------ --------------- -------------- ------------ ------- ------------------- ------------------- -MicrosoftOffice2010Win64.Word Microsoft Word 2010 (64-bit) 18 N/A Application True NotSet -``` - -This command gets settings location templates that are registered with uev_tla, and passes them to **Format-Table** by using the pipeline operator. -This command specifies a value for the *ApplicationOrTemplateID* parameter that contains a wildcard. -The cmdlet gets the templates that have a name or template ID that includes the string office followed by the string word. - -### Example 4: Get registered templates associated with the Backup profile -``` -PS C:\>Get-UevTemplate -Profile Backup -TemplateId : MicrosoftCalculator6 - -TemplateName : Microsoft Calculator -TemplateDescription : -TemplateVersion : 0 -TemplateType : Application -Enabled : True -EnableStateLocation : NotSet -TemplateProfile : Backup - -TemplateId : MicrosoftWordpad6 - -TemplateName : Microsoft Wordpad - -TemplateDescription : - -TemplateVersion : 0 - -TemplateType : Application - -Enabled : True - -EnableStateLocation : LocalUser - -TemplateProfile : Backup -``` - -This command gets settings location templates that are registered with uev_tla and are associated with the Backup profile. - -## PARAMETERS - -### -Application -Specifies the name of an application. -The cmdlet gets templates that include the applications that you specify. -Use wildcards to specify a partial name. - -```yaml -Type: String -Parameter Sets: ParameterSetApplication -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationOrTemplateID -Specifies an application name or a template ID. -The cmdlet gets templates that include the applications or IDs that you specify. -Use wildcards to specify partial names or IDs. - -```yaml -Type: String -Parameter Sets: ParameterSetApplicationOrTemplateID -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Profile -Specifies the name of a profile. -The cmdlet gets all templates associated with the specified profile. -Valid values are: - -- Roaming -- Backup - -```yaml -Type: String -Parameter Sets: ParameterProfile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateID -Specifies the ID of a template. -The cmdlet gets templates that include the applications that you specify. -Use wildcards to specify partial IDs. - -```yaml -Type: String -Parameter Sets: ParameterSetTemplateID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.UEV.Commands.Template -This cmdlet generates a **Template** object that contains the general information about a settings location template, such as template ID, template name, and template version. - -## NOTES - -## RELATED LINKS - -[Disable-UevTemplate](./Disable-UevTemplate.md) - -[Enable-UevTemplate](./Enable-UevTemplate.md) - -[Register-UevTemplate](./Register-UevTemplate.md) - -[Set-UevTemplateProfile](./Set-UevTemplateProfile.md) - -[Test-UevTemplate](./Test-UevTemplate.md) - -[Unregister-UevTemplate](./Unregister-UevTemplate.md) - -[Update-UevTemplate](./Update-UevTemplate.md) - - diff --git a/docset/mdop/uev/get-uevtemplateprogram.md b/docset/mdop/uev/get-uevtemplateprogram.md deleted file mode 100644 index ab09fc5162..0000000000 --- a/docset/mdop/uev/get-uevtemplateprogram.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Get-UevTemplateProgram ---- - -# Get-UevTemplateProgram - -## SYNOPSIS -Gets the information about programs defined by a settings location template. - -## SYNTAX - -``` -Get-UevTemplateProgram [-ID] [] -``` - -## DESCRIPTION -The **Get-UevTemplateProgram** cmdlet gets the information about programs defined by a settings location template. -uev_1 monitors each program that is defined in the template for changes to the settings. - -## EXAMPLES - -### Example 1: Get all defined programs -``` -PS C:\> Get-UevTemplate | Get-UevTemplateProgram | Format-Table -AutoSize - - -TemplateId ProgramName ProductVersionRange FileVersionRange ----------- ----------- ------------------- ---------------- -MicrosoftCalculator6 CALC.EXE 6-6 -MicrosoftNotepad6 NOTEPAD.EXE 6-6 -MicrosoftOffice2010.OneNote ONENOTE.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Word WINWORD.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Excel EXCEL.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.PowerPoint POWERPNT.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Outlook OUTLOOK.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.InfoPath INFOPATH.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Visio VISIO.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Groove Groove.exe 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Access MSACCESS.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Project WINPROJ.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Publisher MSPUB.EXE 14.0-14.0 14.0-14.0 -MicrosoftWordpad6 WORDPAD.EXE 6-6 -MicrosoftInternetExplorer.Version8 iexplore.exe 8.0-8.0 8.0-8.0 -MicrosoftInternetExplorer.Version9 iexplore.exe 9.0-9.0 9.0-9.0 -MicrosoftInternetExplorer.Version10 iexplore.exe 10.0-10.0 10.0-10.0 -MicrosoftLync2010 communicator.exe 4.0-4.0 4.0-4.0 -``` - -This command gets the defined programs for all of the registered settings location templates. -The command uses the **Get-UevTemplate** cmdlet to get the template that is stored on the computer, and passes the output to the **Get-UevTemplateProgram** cmdlet by using the pipeline operator. -The command then passes the results to the **Format-Table** cmdlet by using the pipeline operator. -For more information, type `Get-Help Format-Table`. - -### Example 2: Get all defined programs for Office applications -``` -PS C:\> Get-UevTemplate -Application "office" | Get-UevTemplateProgram | Format-Table -AutoSize - - -TemplateId ProgramName ProductVersionRange FileVersionRange ----------- ----------- ------------------- ---------------- -MicrosoftOffice2010.OneNote ONENOTE.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Word WINWORD.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Excel EXCEL.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.PowerPoint POWERPNT.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Outlook OUTLOOK.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.InfoPath INFOPATH.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Visio VISIO.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Groove Groove.exe 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Access MSACCESS.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Project WINPROJ.EXE 14.0-14.0 14.0-14.0 -MicrosoftOffice2010.Publisher MSPUB.EXE 14.0-14.0 14.0-14.0 -``` - -This command gets the defined programs for the registered settings location templates of Office applications. -The command uses the **Get-UevTemplate** cmdlet to get the Office applications that are defined on the computer, and passes the output to the **Get-UevTemplateProgram** cmdlet by using the pipeline operator. -The command then passes the results to the **Format-Table** cmdlet by using the pipeline operator. -For more information, type `Get-Help Format-Table`. - -### Example 3: Get all defined programs by template ID -``` -PS C:\> Get-UevTemplateProgram -TemplateId "MicrosoftCalculator6" | Format-Table -AutoSize -TemplateId ExecutableName VersionRangeList ----------- -------------- ---------------- -MicrosoftCalculator6 CALC.EXE 6-6 -``` - -This command gets the defined programs for the settings location template whose ID is MicrosoftCalculator6. -The command uses the **Get-UevTemplateProgram** cmdlet to get the application that is identified by the ID MicrosoftCalculator6. -The command then passes the results to the **Format-Table** cmdlet by using the pipeline operator. -For more information, type `Get-Help Format-Table`. - -## PARAMETERS - -### -ID -Specifies the ID of a settings location template. -A settings location template stores the location of files and registry keys that contain application settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TemplateID - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -The settings location template ID. - -## OUTPUTS - -### Microsoft.UEV.Commands.Process -This cmdlet generates an object that contains general information about a program defined in a settings location template, such as the program name and the range of the versions to monitor. - -## NOTES -* uev_tla can define multiple programs for a single application in the settings location template. - -## RELATED LINKS - -[Get-UevTemplate](./Get-UevTemplate.md) - - diff --git a/docset/mdop/uev/import-uevconfiguration.md b/docset/mdop/uev/import-uevconfiguration.md deleted file mode 100644 index a2c502bce8..0000000000 --- a/docset/mdop/uev/import-uevconfiguration.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Import-UevConfiguration ---- - -# Import-UevConfiguration - -## SYNOPSIS -Imports the uev_tla configuration. - -## SYNTAX - -``` -Import-UevConfiguration [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-UevConfiguration** cmdlet imports the uev_1 computer configuration from a settings migration (.uev) file. -You must have administrative credentials to run this cmdlet. - -## EXAMPLES - -### Example 1: Import the UE-V configuration -``` -PS C:\> Import-UevConfiguration -Path "ContosoUev.uev" -``` - -This command imports the uev_tla computer configuration from the settings migration file named ContosoUev.uev. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the settings migration file. -The cmdlet imports the uev_tla configuration from the settings migration file (.uev file) that you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-UevConfiguration](./Get-UevConfiguration.md) - -[Set-UevConfiguration](./Set-UevConfiguration.md) - -[Clear-UevConfiguration](./Clear-UevConfiguration.md) - -[Export-UevConfiguration](./Export-UevConfiguration.md) - - diff --git a/docset/mdop/uev/register-uevtemplate.md b/docset/mdop/uev/register-uevtemplate.md deleted file mode 100644 index 50f3fde885..0000000000 --- a/docset/mdop/uev/register-uevtemplate.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Register-UevTemplate ---- - -# Register-UevTemplate - -## SYNOPSIS -Registers a settings location template with uev_tla. - -## SYNTAX - -### Path (Default) -``` -Register-UevTemplate [-Path] [-WhatIf] [-Confirm] [] -``` - -### LiteralPath -``` -Register-UevTemplate -LiteralPath [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Register-UevTemplate** cmdlet registers a settings location template with uev_1. -A template defines settings to synchronize between computers. -After you register a template, uev_tla synchronizes the settings. -If you try to register a template that is already registered, the cmdlet returns an error. - -You must have administrative credentials to run this cmdlet. - -## EXAMPLES - -### Example 1: Register a template -``` -PS C:\> Register-UevTemplate -Path "MicrosoftCalculator.xml" -``` - -This command registers a template in the current directory. - -### Example 2: Register multiple templates -``` -PS C:\> Register-UevTemplate -Path "Microsoft*.xml" -``` - -This command uses a wildcard to specify multiple templates in the current directory. - -### Example 3: Register all templates in a directory -``` -PS C:\> Register-UevTemplate -Path "*.xml" -``` - -This command uses a wildcard to register all settings location templates that are in the current directory but that are not currently registered. - -### Example 4: Register a template by using a literal path -``` -PS C:\> Register-UevTemplate -LiteralPath "C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftCalculator.xml" -``` - -This command registers a settings location template by using the literal path of the template file. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiteralPath -Specifies an array of literal file paths. -The cmdlet registers the settings location templates that have the literal paths that you specify. - -```yaml -Type: String[] -Parameter Sets: LiteralPath -Aliases: PSPath - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies an array of file paths. -The cmdlet registers the settings location templates that have the paths that you specify. -Use wildcards to specify multiple files. - -```yaml -Type: String[] -Parameter Sets: Path -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string[] -An array of paths to the settings location templates. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-UevTemplate](./Disable-UevTemplate.md) - -[Enable-UevTemplate](./Enable-UevTemplate.md) - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Test-UevTemplate](./Test-UevTemplate.md) - -[Unregister-UevTemplate](./Unregister-UevTemplate.md) - -[Update-UevTemplate](./Update-UevTemplate.md) - - diff --git a/docset/mdop/uev/repair-uevtemplateindex.md b/docset/mdop/uev/repair-uevtemplateindex.md deleted file mode 100644 index f2575fbfab..0000000000 --- a/docset/mdop/uev/repair-uevtemplateindex.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Repair-UevTemplateIndex ---- - -# Repair-UevTemplateIndex - -## SYNOPSIS -Repairs a corrupted uev_tla template index. - -## SYNTAX - -``` -Repair-UevTemplateIndex [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Repair-UevTemplateIndex** cmdlet repairs the index for the uev_1 settings location templates. -A corrupted template prevents you from enumerating the uev_tla templates, and can prevent uev_tla from synchronizing settings for any application on the computer. -You must have administrator privileges to run this cmdlet. - -## EXAMPLES - -### Example 1: Repair the template index -``` -PS C:\> Repair-UevTemplateIndex -``` - -This command repairs the corrupted template index. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/uev/restore-uevbackup.md b/docset/mdop/uev/restore-uevbackup.md deleted file mode 100644 index dfd0f85dd6..0000000000 --- a/docset/mdop/uev/restore-uevbackup.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Restore-UevBackup ---- - -# Restore-UevBackup - -## SYNOPSIS -Applies backed up settings from another computer to this computer. - -## SYNTAX - -``` -Restore-UevBackup [-ComputerName] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Restore-UevBackup** cmdlet allows all of the backed up settings from another computer to apply to this computer. -This cmdlet sets a restore flag for each user application that has a profile of Backup. -The next time that such an application runs, the backed up settings apply to the application. - -## EXAMPLES - -### Example 1: Restore backed up settings from another computermachinecomputer -``` -PS C:\>Restore-UevBackup -MachineName "PattiFullerDevice03@Contoso.Com" -``` - -This command restores all backup packages from another computer. -The command sets a restore flag for all applications associated with the Backup profile on this computer. - -## PARAMETERS - -### -ComputerName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-UevTemplateProfile](./Set-UevTemplateProfile.md) - diff --git a/docset/mdop/uev/restore-uevusersetting.md b/docset/mdop/uev/restore-uevusersetting.md deleted file mode 100644 index a8c5a847c8..0000000000 --- a/docset/mdop/uev/restore-uevusersetting.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Restore-UevUserSetting ---- - -# Restore-UevUserSetting - -## SYNOPSIS -Sets a restore flag for the user settings. - -## SYNTAX - -### ParameterSetApplication -``` -Restore-UevUserSetting [-Force] -Application [-LastKnownGood] [-WhatIf] [-Confirm] - [] -``` - -### ParameterSetTemplateId -``` -Restore-UevUserSetting [-TemplateId] [-LastKnownGood] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Restore-UevUserSetting cmdlet sets a restore flag for the user application settings or Windows operating system settings group. -You must perform this action for each application for which to restore the user settings. -The settings are restored the next time you run the application or log on to the operating system. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\> -Restore-UevUserSetting -TemplateId "MicrosoftCalculator6" -``` - -Description-----------This command sets a restore flag for the user settings that are identified by the template ID MicrosoftCalculator6. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -PS C:\> -Get-UevTemplate | Restore-UevUserSetting -``` - -Description-----------This command sets a restore flag for all user settings. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -PS C:\> -Restore-UevUserSetting -Application "word" - -Confirm -The following user settings will be restored: - -MicrosoftOffice2010.Word (Microsoft Office 2010.Word) -MicrosoftWordpad6 (Microsoft Wordpad) - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -Description-----------This command sets a restore flag for user settings for applications with names that contain the string word. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -PS C:\> -Restore-UevUserSetting -Application "office*word" -Force -``` - -Description-----------This command sets a restore flag for the user settings of the application whose name contains the strings office and word, in that order. - -## PARAMETERS - -### -Application -Specifies the name of an application. -Use the application name, or a partial name with wildcard characters, to set the restore flag for specific applications. - -```yaml -Type: String -Parameter Sets: ParameterSetApplication -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to execute without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetApplication -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastKnownGood -Restore the application to the settings last known good state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TemplateId -Specifies the ID of a template. -The cmdlet sets the restore flag for the application settings or operating system settings group to restore. - -```yaml -Type: String -Parameter Sets: ParameterSetTemplateId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/mdop/uev/set-uevconfiguration.md b/docset/mdop/uev/set-uevconfiguration.md deleted file mode 100644 index 5a2400438a..0000000000 --- a/docset/mdop/uev/set-uevconfiguration.md +++ /dev/null @@ -1,658 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-UevConfiguration ---- - -# Set-UevConfiguration - -## SYNOPSIS -Modifies uev_tla configuration settings. - -## SYNTAX - -### ParameterSetUser (Default) -``` -Set-UevConfiguration [-CurrentComputerUser] [-MaxPackageSizeInBytes ] [-SettingsStoragePath ] - [-EnableSyncProviderPing] [-DisableSyncProviderPing] [-SyncTimeoutInMilliseconds ] - [-SyncMethod ] [-EnableSync] [-DisableSync] [-EnableSyncOverMeteredNetwork] - [-DisableSyncOverMeteredNetwork] [-EnableSyncOverMeteredNetworkWhenRoaming] - [-DisableSyncOverMeteredNetworkWhenRoaming] [-EnableSettingsImportNotify] [-DisableSettingsImportNotify] - [-SettingsImportNotifyDelayInSeconds ] [-EnableDontSyncWindows8AppSettings] - [-DisableDontSyncWindows8AppSettings] [-WaitForSyncTimeoutInMilliseconds ] - [-EnableWaitForSyncOnApplicationStart] [-DisableWaitForSyncOnApplicationStart] [-EnableWaitForSyncOnLogon] - [-DisableWaitForSyncOnLogon] [-EnableSyncUnlistedWindows8Apps] [-DisableSyncUnlistedWindows8Apps] - [-VdiCollectionName ] [-WhatIf] [-Confirm] [] -``` - -### ParameterSetComputer -``` -Set-UevConfiguration [-Computer] [-MaxPackageSizeInBytes ] [-SettingsStoragePath ] - [-SettingsTemplateCatalogPath ] [-EnableSyncProviderPing] [-DisableSyncProviderPing] - [-SyncTimeoutInMilliseconds ] [-SyncMethod ] [-EnableSync] [-DisableSync] - [-EnableSyncOverMeteredNetwork] [-DisableSyncOverMeteredNetwork] [-EnableSyncOverMeteredNetworkWhenRoaming] - [-DisableSyncOverMeteredNetworkWhenRoaming] [-EnableSettingsImportNotify] [-DisableSettingsImportNotify] - [-SettingsImportNotifyDelayInSeconds ] [-ContactITUrl ] [-ContactITDescription ] - [-EnableTrayIcon] [-DisableTrayIcon] [-EnableFirstUseNotification] [-DisableFirstUseNotification] - [-EnableDontSyncWindows8AppSettings] [-DisableDontSyncWindows8AppSettings] - [-WaitForSyncTimeoutInMilliseconds ] [-EnableWaitForSyncOnApplicationStart] - [-DisableWaitForSyncOnApplicationStart] [-EnableWaitForSyncOnLogon] [-DisableWaitForSyncOnLogon] - [-EnableSyncUnlistedWindows8Apps] [-DisableSyncUnlistedWindows8Apps] [-VdiCollectionName ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-UevConfiguration** cmdlet modifies uev_1 configuration settings. -If you specify the *CurrentComputerUser* parameter, the cmdlet changes the settings that you specify for the current user only. -If you specify the *Computer* parameter, the cmdlet clears the settings that you specify for all users on the computer. -You must have administrative credentials to use this cmdlet to modify settings for all users on the computer. -If you do not specify the *CurrentComputerUser* or *Computer* parameter, the cmdlet changes the settings that you specify for the current user only. - -## EXAMPLES - -### Example 1: Modify the synchronization timeout setting for all users -``` -PS C:\> Set-UevConfiguration -Computer -SyncTimeoutInMilliseconds 3000 -``` - -This command modifies the synchronization timeout setting to three seconds for all users on the computer. - -### Example 2: Modify the synchronization timeout setting for the current user -``` -PS C:\> Set-UevConfiguration -CurrentComputerUser -SyncTimeoutInMilliseconds 3000 -``` - -This command modifies the synchronization timeout setting to three seconds for the current user on the computer. - -### Example 3: Modify the synchronization timeout setting for the current user by default -``` -PS C:\> Set-UevConfiguration -SyncTimeoutInMilliseconds 3000 -``` - -This command modifies the synchronization timeout setting to three seconds by default for the current user on the computer. - -### Example 4: Modify multiple settings for the current user -``` -PS C:\> Set-UevConfiguration -CurrentComputerUser -SyncTimeoutInMilliseconds 5000 -MaxPackageSizeInBytes 700000 -``` - -This command modifies the settings for the synchronization timeout and maximum package size for the current user on the computer. - -## PARAMETERS - -### -Computer -Indicates that the cmdlet changes the settings that you specify for all users on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactITDescription -Specifies a description for the Contact IT link. - -```yaml -Type: String -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactITUrl -Specifies a URL for the Contact IT link. - -```yaml -Type: String -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentComputerUser -Indicates that the cmdlet modifies the settings that you specify for the current user only. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetUser -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableDontSyncWindows8AppSettings -Indicates that the cmdlet disables the setting for not synchronizing Windows® 8 app settings. -If you specify this parameter, uev_tla synchronizes Windows 8 app settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableFirstUseNotification -Indicates that the cmdlet disables the notification of first-use. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSettingsImportNotify -Indicates that the cmdlet disables the notification of settings import. -If you specify this parameter, uev_tla does not notify the user about the settings import. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSync -Indicates that the cmdlet disables the synchronization of settings. -If you specify this parameter, uev_tla stops the synchronization of settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSyncOverMeteredNetwork -Indicates that the cmdlet disables the synchronization of settings over metered connections. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSyncOverMeteredNetworkWhenRoaming -Indicates that the cmdlet disables the synchronization of settings over metered connections outside of the home provider network, for example, when connected by using a roaming connection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSyncProviderPing -Indicates that the cmdlet disables the synchronization provider from pinging the network before it synchronizes. -If you specify this parameter, uev_tla attempts to synchronize settings, even if the network is not available. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableSyncUnlistedWindows8Apps -Indicates that the cmdlet disables the synchronization of unlisted Windows 8 apps. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableTrayIcon -Indicates that the cmdlet disables the icon in the notification area. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableWaitForSyncOnApplicationStart -Indicates that the cmdlet disables uev_tla from waiting for synchronization to finish before the user can start an application. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableWaitForSyncOnLogon -For internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableDontSyncWindows8AppSettings -Indicates that the cmdlet enables the setting for not synchronizing Windows 8 app settings. -If you specify this parameter, uev_tla does not synchronize Windows 8 app settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFirstUseNotification -Indicates that the cmdlet enables first use notification. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSettingsImportNotify -Indicates that the cmdlet enables the notification for settings import. -If the settings import takes longer than the amount of time that you specify for the *SettingsImportNotifyDelayInSecond* parameter, uev_tla notifies the user. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSync -Indicates that the cmdlet enables the synchronization of settings. -uev_tla synchronizes the settings that are defined in the settings location templates that you have enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSyncOverMeteredNetwork -Indicates that the cmdlet enables the synchronization of settings over metered connections. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSyncOverMeteredNetworkWhenRoaming -Indicates that the cmdlet enables the synchronization of settings over metered connections outside of the home provider network, for example, when connected by using a roaming connection. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSyncProviderPing -Indicates that the cmdlet enables the synchronization provider to ping for network accessibility. -If you specify this parameter, uev_tla attempts to synchronize settings only if the network is available. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableSyncUnlistedWindows8Apps -Indicates that the cmdlet enables the synchronization of unlisted Windows 8 apps. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTrayIcon -Indicates that the cmdlet enables the icon in the notification area. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableWaitForSyncOnApplicationStart -For internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableWaitForSyncOnLogon -For internal use only. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPackageSizeInBytes -Specifies the maximum package size, in bytes. -If the size of a package exceeds the value that you specify, uev_tla logs a warning. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsImportNotifyDelayInSeconds -Specifies the time, in seconds, before uev_tla notifies the user about the settings import. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsStoragePath -Specifies the path of the location where uev_tla stores the user settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SettingsTemplateCatalogPath -Specifies the path of the location where uev_tla stores the settings template catalog. - -```yaml -Type: String -Parameter Sets: ParameterSetComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncMethod -Specifies the method for the synchronization of settings. -Valid values are: - -- SyncProvider -- None - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SyncTimeoutInMilliseconds -Specifies the time, in milliseconds, before uev_tla synchronizes settings from the settings repository. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VdiCollectionName -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForSyncTimeoutInMilliseconds -For internal use only. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-UevConfiguration](./Get-UevConfiguration.md) - -[Clear-UevConfiguration](./Clear-UevConfiguration.md) - -[Import-UevConfiguration](./Import-UevConfiguration.md) - -[Export-UevConfiguration](./Export-UevConfiguration.md) - - diff --git a/docset/mdop/uev/set-uevtemplateprofile.md b/docset/mdop/uev/set-uevtemplateprofile.md deleted file mode 100644 index 877318bee7..0000000000 --- a/docset/mdop/uev/set-uevtemplateprofile.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Set-UevTemplateProfile ---- - -# Set-UevTemplateProfile - -## SYNOPSIS -Modifies which profile to associate with an individual template. - -## SYNTAX - -``` -Set-UevTemplateProfile -ID -Profile [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-UevTemplateProfile** cmdlet modifies which profile to associate with an individual template. -You can associate a template with the roaming profile or with the backup profile. -If you have not specified the profile for a template, the template associates to the roaming profile. - -## EXAMPLES - -### Example 1: Associate a template with the Backup profile -``` -PS C:\>Set-UevTemplateProfile -ID "MicrosoftCalculator6" -Profile "Backup" -``` - -This command associates a template with the backup profile. -Settings for the application back-up, instead of synchronizing between computers. - -### Example 2: Associate a template with the Roaming profile -``` -PS C:\>Set-UevTemplateProfile -ID "MicrosoftCalculator6" -Profile "Roaming" -``` - -This command associates a template with the roaming profile. -Settings for the application synchronize between computers. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ID -Specifies the ID of a settings location template. -If you specify an ID for a template that is not registered, this cmdlet returns an error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TemplateID - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Profile -Specifies the name of a profile. -The cmdlet associates the template with the specified profile. -Valid values are: - -- Roaming -- Backup - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Roaming, Backup, Vdi - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Restore-UevBackup](./Restore-UevBackup.md) - - diff --git a/docset/mdop/uev/test-uevtemplate.md b/docset/mdop/uev/test-uevtemplate.md deleted file mode 100644 index f2cef5572b..0000000000 --- a/docset/mdop/uev/test-uevtemplate.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Test-UevTemplate ---- - -# Test-UevTemplate - -## SYNOPSIS -Verifies whether a template complies with the schema for uev_tla. - -## SYNTAX - -### Path (Default) -``` -Test-UevTemplate [-Path] [] -``` - -### LiteralPath -``` -Test-UevTemplate -LiteralPath [] -``` - -## DESCRIPTION -The **Test-UevTemplate** cmdlet verifies whether a settings location template complies with the XML schema for uev_1. - -## EXAMPLES - -### Example 1: Test a file -``` -PS C:\> Test-UevTemplate -Path "MicrosoftWordpad.xml" | Format-Table -AutoSize -Path Status Message ----- ------ ------- -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftWordpad.xml Valid The template is valid. -``` - -This command tests whether the specified file is a valid settings location template. -The command passes the results to the **Format-Table** cmdlet by using the pipeline operator. -For more information, type `Get-Help Format-Table`. - -### Example 2: Test several files -``` -PS C:\> Test-UevTemplate -Path "*Microsoft*.xml" | Format-Table -AutoSize -Path Status Message ----- ------ ------- -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftCalculator.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftInternetExplorer9.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftLync2010.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftNotepad.xml Valid The template is valid. -``` - -This command tests whether several files are valid settings location templates. -The command checks all .xml files that have names that contain the specified string. -The command passes the results to **Format-Table** by using the pipeline operator. - -### Example 3: Test a file specified by its literal path -``` -PS C:\> Test-UevTemplate -LiteralPath "MicrosoftWordpad.xml" | Format-Table -AutoSize -Path Status Message ----- ------ ------- -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftWordpad.xml Valid The template is valid. -``` - -This command tests whether the specified file is a valid settings location template file. -The command passes the results to **Format-Table** by using the pipeline operator. - -### Example 4: Test all the files in the current directory by using the pipeline -``` -PS C:\> Test-UevTemplate -Path "*.xml" | Format-Table -AutoSize -Path Status Message ----- ------ ------- -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftCalculator.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftInternetExplorer9.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftLync2010.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftNotepad.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftOffice2010.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftVisualStudio2010.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftWindows7.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftWindows8.xml Valid The template is valid. -C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftWordpad.xml Valid The template is valid. -``` - -This command uses a wildcard to test if each file is a settings location template, and then passes the results to **Format-Table** by using the pipeline operator. - -## PARAMETERS - -### -LiteralPath -Specifies an array of literal file paths. -The cmdlet validates the settings location templates that have the literal paths that you specify. - -```yaml -Type: String[] -Parameter Sets: LiteralPath -Aliases: PSPath - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies an array of file paths. -The cmdlet validates the settings location templates that have the paths that you specify. -Use wildcards to specify multiple files. - -```yaml -Type: String[] -Parameter Sets: Path -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string[] -An array of paths to settings location templates. - -## OUTPUTS - -### Microsoft.UEV.Commands.TestTemplateResult -This cmdlet generates a **TestTemplateResult** object that contains the validation result for a settings location template. - -## NOTES - -## RELATED LINKS - -[Disable-UevTemplate](./Disable-UevTemplate.md) - -[Enable-UevTemplate](./Enable-UevTemplate.md) - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Register-UevTemplate](./Register-UevTemplate.md) - -[Unregister-UevTemplate](./Unregister-UevTemplate.md) - -[Update-UevTemplate](./Update-UevTemplate.md) - - diff --git a/docset/mdop/uev/uev.md b/docset/mdop/uev/uev.md deleted file mode 100644 index 6645d76cd8..0000000000 --- a/docset/mdop/uev/uev.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -Download Help Link: http://go.microsoft.com/fwlink/?LinkId=301255 -Help Version: 4.0.100.0 -Locale: en-US -Module Guid: D22E34C9-0A99-47D7-98F3-C0570257DEB6 -Module Name: UEV -ms.date: 12/05/2016 -ms.devlang: powershell -title: UEV ---- - -# UEV Module -## Description -The following list contains links to the help topics for the cmdlets. - -## UEV Cmdlets -### [Clear-UevAppxPackage](Clear-UevAppxPackage.md) -Clears a setting in the computer or user sections of the registry. - -### [Clear-UevConfiguration](Clear-UevConfiguration.md) -Clears uev_tla configuration settings. - -### [Disable-UevAppxPackage](Disable-UevAppxPackage.md) -Disables uev_tla synchronization of Windows 8 apps. - -### [Disable-UevTemplate](Disable-UevTemplate.md) -Disables a settings location template. - -### [Enable-UevAppxPackage](Enable-UevAppxPackage.md) -Enables uev_tla synchronization of Windows 8 apps. - -### [Enable-UevTemplate](Enable-UevTemplate.md) -Enables a settings location template. - -### [Export-UevConfiguration](Export-UevConfiguration.md) -Exports the uev_tla configuration. - -### [Export-UevPackage](Export-UevPackage.md) -Exports the settings stored in a settings package. - -### [Get-UevAppxPackage](Get-UevAppxPackage.md) -Gets a list of Windows 8 apps and synchronization status. - -### [Get-UevConfiguration](Get-UevConfiguration.md) -Gets the uev_tla configuration settings. - -### [Get-UevTemplate](Get-UevTemplate.md) -Gets settings location templates for uev_tla. - -### [Get-UevTemplateProgram](Get-UevTemplateProgram.md) -Gets the information about programs defined by a settings location template. - -### [Import-UevConfiguration](Import-UevConfiguration.md) -Imports the uev_tla configuration. - -### [Register-UevTemplate](Register-UevTemplate.md) -Registers a settings location template with uev_tla. - -### [Repair-UevTemplateIndex](Repair-UevTemplateIndex.md) -Repairs a corrupted uev_tla template index. - -### [Restore-UevBackup](Restore-UevBackup.md) -Applies backed up settings from another computer to this computer. - -### [Restore-UevUserSetting](Restore-UevUserSetting.md) -Sets a restore flag for the user settings. - -### [Set-UevConfiguration](Set-UevConfiguration.md) -Modifies uev_tla configuration settings. - -### [Set-UevTemplateProfile](Set-UevTemplateProfile.md) -Modifies which profile to associate with an individual template. - -### [Test-UevTemplate](Test-UevTemplate.md) -Verifies whether a template complies with the schema for uev_tla. - -### [Unregister-UevTemplate](Unregister-UevTemplate.md) -Unregisters a settings location template from uev_1. - -### [Update-UevTemplate](Update-UevTemplate.md) -Updates settings location templates in uev_tla. - diff --git a/docset/mdop/uev/unregister-uevtemplate.md b/docset/mdop/uev/unregister-uevtemplate.md deleted file mode 100644 index f65eaae009..0000000000 --- a/docset/mdop/uev/unregister-uevtemplate.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Unregister-UevTemplate ---- - -# Unregister-UevTemplate - -## SYNOPSIS -Unregisters a settings location template from uev_1. - -## SYNTAX - -### ParameterSetTemplateId -``` -Unregister-UevTemplate [-ID] [-WhatIf] [-Confirm] [] -``` - -### ParameterSetAllTemplates -``` -Unregister-UevTemplate [-All] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Unregister-UevTemplate** cmdlet unregisters a settings location template from uev_1. -A template defines settings to synchronize between computers. -After you unregister a template, uev_tla no longer synchronizes those settings. -If you try to unregister a template that is not registered, the cmdlet returns an error. - -You must have administrative credentials to run this cmdlet. - -## EXAMPLES - -### Example 1: Unregister a template -``` -PS C:\> Unregister-UevTemplate -TemplateId "MicrosoftCalculator6" -``` - -This command unregisters a settings location template that has the ID MicrosoftCalculator6. - -### Example 2: Unregister templates for applications that match a specified string -``` -PS C:\> Get-UevTemplate -Application "calc" | Unregister-UevTemplate -``` - -This command uses the **Get-UevTemplate** cmdlet to get all the registered settings location templates whose application name contains the specified string, and then passes them to the current cmdlet by using the pipeline operator. -The cmdlet unregisters all the templates for applications that contain the string calc. - -### Example 3: Unregister all templates -``` -PS C:\> Unregister-UevTemplate -All -``` - -This command unregisters all the settings location templates that are currently registered with uev_tla. - -## PARAMETERS - -### -All -Indicates that the cmdlet unregisters all settings location templates. - -```yaml -Type: SwitchParameter -Parameter Sets: ParameterSetAllTemplates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ID -Specifies the ID of a settings location template. -The cmdlet unregisters the template that you specify. -If you specify an ID for a template that is not registered, the cmdlet returns an error. - -```yaml -Type: String -Parameter Sets: ParameterSetTemplateId -Aliases: TemplateID - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -The settings location template ID. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-UevTemplate](./Disable-UevTemplate.md) - -[Enable-UevTemplate](./Enable-UevTemplate.md) - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Register-UevTemplate](./Register-UevTemplate.md) - -[Test-UevTemplate](./Test-UevTemplate.md) - -[Update-UevTemplate](./Update-UevTemplate.md) - - diff --git a/docset/mdop/uev/update-uevtemplate.md b/docset/mdop/uev/update-uevtemplate.md deleted file mode 100644 index dbedaba537..0000000000 --- a/docset/mdop/uev/update-uevtemplate.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -description: Use this topic to help manage MDOP technologies with Windows PowerShell. -external help file: Microsoft.Uev.Commands.dll-Help.xml -ms.date: 12/05/2016 -ms.devlang: powershell -schema: 2.0.0 -title: Update-UevTemplate ---- - -# Update-UevTemplate - -## SYNOPSIS -Updates settings location templates in uev_tla. - -## SYNTAX - -### Path (Default) -``` -Update-UevTemplate [-Path] [-WhatIf] [-Confirm] [] -``` - -### LiteralPath -``` -Update-UevTemplate -LiteralPath [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Update-UevTemplate** cmdlet updates settings location templates in uev_1. -In order for the cmdlet to update a template, the new template must have a higher value for template version. - -You must have administrative credentials to run this cmdlet. - -## EXAMPLES - -### Example 1: Update a template -``` -PS C:\> Update-UevTemplate -Path "MicrosoftCalculator.xml" -``` - -This command updates the settings location template specified in the current directory. - -### Example 2: Update templates by specifying a path -``` -PS C:\> Update-UevTemplate -Path "Microsoft*.xml" -``` - -This cmdlet updates all settings location templates in the current directory that match the specified string. - -### Example 3: Update a template by specifying a literal path -``` -PS C:\> Update-UevTemplate -LiteralPath "C:\Program Files\Microsoft User Experience Virtualization\Templates\MicrosoftCalculator.xml" -``` - -This command updates a settings location template by specifying a literal path to the template file. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiteralPath -Specifies an array of literal file paths. -The cmdlet updates the settings location templates that have the literal paths that you specify. - -```yaml -Type: String[] -Parameter Sets: LiteralPath -Aliases: PSPath - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies an array of file paths. -The cmdlet updates the settings location templates that have the paths that you specify. -Use wildcards to specify multiple files. - -```yaml -Type: String[] -Parameter Sets: Path -Aliases: Name - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run.Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string[] -An array of paths to settings location templates. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-UevTemplate](./Disable-UevTemplate.md) - -[Enable-UevTemplate](./Enable-UevTemplate.md) - -[Get-UevTemplate](./Get-UevTemplate.md) - -[Register-UevTemplate](./Register-UevTemplate.md) - -[Test-UevTemplate](./Test-UevTemplate.md) - -[Unregister-UevTemplate](./Unregister-UevTemplate.md) - - diff --git a/docset/winserver2012-ps/activedirectory/About/About.md b/docset/winserver2012-ps/activedirectory/About/About.md deleted file mode 100644 index 449df28850..0000000000 --- a/docset/winserver2012-ps/activedirectory/About/About.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: About articles for the ActiveDirectory module. -Help Version: 3.1.0.0 -Locale: en-US -ms.date: 07/03/2024 -title: About articles ---- -# About topics - -## Description - -About topics cover a range of concepts about PowerShell. - -## About Topics - -### [about_ActiveDirectory](about_ActiveDirectory.md) -The Active Directory module is a command line interface for managing Active Directory. - -### [about_ActiveDirectory_Filter](about_ActiveDirectory_Filter.md) -Describes the syntax and behavior of the search filter supported by the Active Directory module for Windows PowerShell. - -### [about_ActiveDirectory_Identity](about_ActiveDirectory_Identity.md) -The Active Directory module for Windows PowerShell objects have a range of identifying attributes that are used for search and retrieval. - -### [about_ActiveDirectory_ObjectModel](about_ActiveDirectory_ObjectModel.md) -Describes the object model of the Active Directory module for Windows PowerShell. diff --git a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory.md b/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory.md deleted file mode 100644 index 1b7183dcd2..0000000000 --- a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -title: about_ActiveDirectory -ms.date: 04/22/2013 -description: The Active Directory module is a command line interface for managing Active Directory. -Locale: en-US -schema: 2.0.0 ---- - -# about_ActiveDirectory - -## SHORT DESCRIPTION - -The Active Directory module is a command line interface for managing Active -Directory. - -## LONG DESCRIPTION - -The Active Directory module for Windows PowerShell is for IT Professionals who -are administering and interfacing with Active Directory. The Active Directory -module provides an efficient way to complete many administrative, -configuration, and diagnostic tasks across Active Directory Domain Services (AD -DS) and Active Directory Lightweight Directory Services (AD LDS) instances in -their environments. The Active Directory module includes a set of Windows -PowerShell cmdlets and a provider. The provider exposes the Active Directory -database through a hierarchical navigation system, which is very similar to the -file system. As with drives in a file system, such as C:, you can connect -Windows PowerShell drives to Active Directory domains and AD LDS, as well as -Active Directory snapshots. - -### Coverage of Active Directory Module Cmdlets - -Create, Read, Update, and Delete actions are supported for Active Directory -objects by cmdlets such as `New-ADUser`, `Get-ADOrganizationalUnit`, -`Set-ADComputer`, and `Remove-ADUser`. - -Account and Password Policy Management are supported by cmdlets such as -`Enable-ADAccount`, `Unlock-ADAccount`, `New-ADServiceAccount`, -`Set-ADAccountControl`, and `Remove-ADFineGrainedPasswordPolicy`. - -Domain and Forest Management is supported by cmdlets such as `Get-ADForest`, -`Set-ADForest`, `Set-ADForestMode`, `Enable-ADOptionalFeature`, -`Get-ADDomainController`, and `Get-ADDomain`. - -### Listing the Active Directory Module Cmdlets - -To get a list of all of the Active Directory module cmdlets, run - -```powershell -Get-Command -Module ActiveDirectory -``` - -### Getting Started - -Getting started with the Active Directory module for Windows PowerShell is as -easy as clicking the following shortcut: - -Run the following command in any Windows PowerShell prompt to import the Active -Directory module: - -```powershell -Import-Module ActiveDirectory -``` - -### Overview and Conceptual Topics - -The first two of these topics offer a high level overview of the Active -Directory module and the Active Directory Provider. - -- For a brief introduction to the Active Directory provider for Windows - PowerShell, see [ActiveDirectory](/powershell/module/activedirectory). -- The following topics are conceptual support topics for the Active Directory - module cmdlets. - - For an introduction to the **Identity** parameter, which is used by the - Active Directory module cmdlets to identify objects in the directory, see - [about_ActiveDirectory_Identity](about_ActiveDirectory_Identity.md). - - For an introduction to the **Filter** parameter which is used by Active - Directory module cmdlets to search for objects in the directory, see - [about_ActiveDirectory_Filter](about_ActiveDirectory_Filter.md). - - For an introduction to the .NET Framework-based object model implemented by - the Active Directory module, see - [about_ActiveDirectory_ObjectModel](about_ActiveDirectory_ObjectModel.md). diff --git a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Filter.md b/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Filter.md deleted file mode 100644 index 23a83c0a0a..0000000000 --- a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Filter.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -title: about_ActiveDirectory_Filter -ms.date: 04/22/2013 -description: Describes the syntax and behavior of the search filter supported by the Active Directory module for Windows PowerShell. -Locale: en-US -schema: 2.0.0 ---- - -# about_ActiveDirectory_Filter - -## SHORT DESCRIPTION - -Describes the syntax and behavior of the search filter supported by the Active -Directory module for Windows PowerShell. - -## LONG DESCRIPTION - -Most get-AD* Active Directory module cmdlets use the Filter parameter to search -for objects. The Filter parameter has been implemented to replace the function -of the LDAP Filter and adds support for PowerShell variables, rich data types, -improved error checking and an Active Directory extended form of the PowerShell -Expression Language. - - -- Support for LDAP Filter Syntax - - The LDAP filter syntax is supported through the **LDAPFilter** parameter. You - will find LDAP filter examples along with the new Active Directory module - filter examples in the Filter Examples section of this topic. - - -- Search Breadth and Depth - - The breadth and depth of your filter-driven search can be modified by two - Active Directory module cmdlet parameters: **SearchBase** and **SearchScope**. - - When within the context of the Active Directory provider, if the - **Searchbase** parameter is not specified, **SearchBase** will default to the - current path. When not running under the Active Directory provider, the - **SearchBase** will default to the server's **DefaultNamingContext**. - - The **SearchScope** parameter defaults to the value `Subtree`, of the - enumerated type **ADSearchScope**. - - For more information, see the **SearchBase** and **SearchScope** parameter - descriptions on any `Get-AD*` cmdlet. - -- Search Result Behavior - - The behavior of the Active Directory module when returning results of a - search is modified by two cmdlet parameters: **ResultPageSize** and - **ResultSetSize**. - - **ResultSetSize** controls the maximum number of returned objects. - - **ResultPageSize** specifies the maximum number of objects for each returned - page of information. - - See the **ResultPageSize** and **ResultSetSize** parameter descriptions on - any `Get-AD*` cmdlet for more information. - - -- Timeout Behavior - - The following statements specify timeout conditions within the Active - Directory module and describe what can be done about a timeout them. - - The default Active Directory module timeout for all operations is 2 - minutes. - - For search operation, the Active Directory module uses paging control - with a 2-minute timeout for each page search. - - > [!NOTE] - > Because a search may involve multiple server page requests the overall - > search time may exceed 2 minutes. - - A **TimeoutException** error indicates that a timeout has occurred. - - For a search operation, you can choose to use a smaller page size, set with - the **ResultPageSize** parameter, if you are getting a **TimeoutException** - error. - - If after trying these changes you are still getting a **TimeoutException** - error, consider optimizing your filter using the guidance in the - Optimizing Filters section of this topic. - - -- Optimizing Filters - - You can enhance the search filter behavior by using these guidelines. - - - Avoid using the **Recursive** parameter as it intensifies resource usage of - the search operation. - - Avoid using bitwise AND operators and bitwise OR operators. For more - information, see the Supported Operators section of this topic. - - Avoid using the logical NOT operator. - - Break down your search into multiple queries with narrower conditions. - - For a full description of filter syntax and usage, see the Filter Syntax - section of this topic. - - -## Filter Examples - -The following section shows many examples of filter use in common queries. - -### Example 1 - Get all entries: - -- LDAP Filter Equivalent: `(objectClass=*)` - -```powershell -Get-ADObject -Filter 'ObjectClass -like "*"' -``` - -### Example 2 - Get entries containing "bob" somewhere in the common name - -- LDAP Filter Equivalent: `(cn=*bob*)` - -```powershell -Get-ADObject -Filter 'CN -like "*bob*"' -``` - -### Example 3 - Get entries with a bad password count greater than five - -- LDAP Filter Equivalent: `(&(!badpwdcount<=5)(badpwdcount=*))` - -```powershell -Get-ADUser -Filter 'badpwdcount -ge 5' -``` - -### Example 4 - Get all users with an e-mail attribute - -- LDAP Filter Equivalent: `(&(objectClass=user)(email=*))` - -```powershell -Get-ADUser -filter 'email -like "*"' -``` - --or- - -```powershell -Get-ADObject -filter 'email -like "*" -and ObjectClass -eq "user"' -``` - -### Example 5 - Get all user entries with an e-mail attribute and a surname equal to "smith": - -- LDAP Filter Equivalent: `(&(sn=smith)(objectClass=user)(email=*))` - -```powershell -Get-ADUser -Filter 'Email -like "*" -and SurName -eq "smith"' -``` - --or- - -```powershell -Get-ADUser -Filter 'Email -like "*" -and sn -eq "smith"' -``` - - -### Example 6 - Get all user entries with a common name that starts with "andy" and users with a common name of "steve" or "margaret" - -- LDAP Filter Equivalent: `(&(objectClass=user) | (cn=andy*)(cn=steve)(cn=margaret))` - -```powershell -Get-ADUser -Filter 'CN -like "andy*" -or CN -eq "steve" -or CN -eq "margaret"' -``` - - -This example demonstrates a more complex logic and the use of precedence -control via parenthesis. - -```powershell -Get-ADObject -Filter 'objectClass -eq "user" -and (CN -like "andy*" -or CN -eq "steve" -or CN -eq "margaret")' -``` - -### Example 7 - Get all entries without an e-mail attribute - -- LDAP Filter Equivalent: `(!(email=*))` - -```powershell -Get-ADUser -Filter '-not Email -like "*"' -``` - --or- - -```powershell -Get-ADUser -Filter 'Email -notlike "*"' -``` - -### Example 8 - Get all users who did not logon since January 1, 2007 - -- LDAP Filter Equivalent: `(&(lastlogon<=X)(objectClass=user))` where X is - number of 100-nanosecond slices since Jan 1st 1601 - -```powershell -$date = new-object System.DateTime -ArgumentList @(2007,1,1,0,0,0) -Get-ADUser -Filter '-not LastLogon -le $date' -``` - -### Example 9 - Get all users who have logged on in the last 5 days - -- LDAP Filter Equivalent: - - ``` - (&(lastLogon>=128812906535515110) - (objectClass=user)(!(objectClass=computer))) - ``` - -```powershell -$date = (get-date) - (new-timespan -days 5) -Get-ADUser -Filter 'lastLogon -gt $date' -``` - -### Example 10 - Search for group objects that have the ADS_GROUP_TYPE_SECURITY_ENABLED flag set - -- LDAP Filter Equivalent: - `(&(objectCategory=group)(groupType:1.2.840.113556.1.4.803:=2147483648))` - -The following example query string searches for group objects that have the -ADS_GROUP_TYPE_SECURITY_ENABLED flag set. Be aware that the decimal value of -ADS_GROUP_TYPE_SECURITY_ENABLED (0x80000000 = 2147483648) is used for the -comparison value. - -```powershell -Get-ADGroup -filter 'groupType -band 0x80000000' -``` - -### Example 11 - Search the ancestry of an object - -- LDAP Filter Equivalent: - `(memberof:1.2.840.113556.1.4.1941:=(cn=Group1,OU=groupsOU,DC=x)))` - -The LDAP_MATCHING_RULE_IN_CHAIN is a matching rule OID that is designed to -provide a method to look up the ancestry of an object. Many applications using -Active Directory and AD LDS usually work with hierarchical data, which is -ordered by parent-child relationships. Previously, applications performed -transitive group expansion to figure out group membership, which used a lot of -network bandwidth. Applications made multiple round-trips to figure out if an -object fell "in the chain" if a link were traversed through to the end. - -An example of such a query is one designed to check if a user, "user1" is a -member of group "group1". "user1" may not be a direct member of group1. It -could be a member of some other group, which is a member of "group1". - -You would set the base to the user DN and the scope to base, and use the query: - -```powershell -Get-ADUser -Filter 'memberOf -RecursiveMatch "CN=Administrators, CN=Builtin,DC=Fabrikam,DC=com"' -SearchBase "CN=Administrator,CN=Users,DC=Fabrikam,DC=com" -``` - -## Filter Syntax - -The following syntax descriptions use Backus-Naur form to show the PowerShell -Expression Language for the Filter parameter. - -```Syntax - ::= "{" "}" - - ::= | - | - - - ::= | - "(" ")" - - ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt" | - "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | - "-notlike" - - ::= "-and" | "-or" - - ::= "-not" - - ::= | - -::= < this value will be compared to the object data for - attribute using the specified filter operator -``` - - -## Supported Operators - -The following table shows frequently used search filter operators. - -| Operator | Description | LDAP Equivalent | -| ----------------- | -------------------------------------- | -------------------------- | -| `-eq` | Equal to. Wildcards not supported. | = | -| `-ne` | Not equal to. Wildcards not supported. | !x = y | -| `-approx` | Approximately equal to | ~= | -| `-le` | Lexicographically less than | <= | -| | or equal to | | -| `-lt` | Lexicographically less than | !x >= y | -| `-ge` | Lexicographically greater | >= | -| | than or equal to | | -| `-gt` | Lexicographically greater than | !x <= y | -| | | | -| `-and` | AND | & | -| `-or` | OR | | -| `-not` | NOT | ! | -| `-bor` | Bitwise OR | :1.2.840.113556.1.4.804:= | -| `-band` | Bitwise AND | :1.2.840.113556.1.4.803:= | -| `-recursivematch` | Use LDAP_MATCHING_RULE_IN_CHAIN | :1.2.840.113556.1.4.1941:= | -| `-like` | Similar to `-eq` and supports | = | -| | wildcard comparison. The only | | -| | wildcard character supported is: `*` | | -| `-notlike` | Not like. Supports wild | !x = y | -| | card comparison. | | - -> [!NOTE] -> PowerShell wildcards, other than "*", such as "?" are not supported by the -> **Filter** parameter syntax. - -### Operator Precedence - -The following listing shows the precedence of operators for filters from -highest to lowest. - -- Highest precedence: `-eq`, `-ge`, `-le`, `-approx`, `-band`, `-bor`, - `-recursivematch`, `-ne`, `-like`, `-not`, `-and` -- Lowest precedence: `-or` - -### Special Characters - -The following escape sequence should be used for specifying special characters -in AD Filter STRING data, that is, data enclosed in double or single quotes. - -| ASCII Character | Escape sequence substitute | -| --------------- | --------------------------------------------------- | -| `"` | `` `" `` (This escape sequence is only required if | -| | STRING data is enclosed in double quotes.) | -| `'` | `''` (This escape sequence is only required if | -| | STRING data is enclosed in single quotes.) | -| NUL | `\00` (This is a standard LDAP escape sequence.) | -| `\` | `\5c` (This is a standard LDAP escape sequence.) | - -### LDAP Special Characters - -ADFilter parser will automatically convert all the below characters found in -STRING data, that is data enclosed in " " or ' ' to their LDAP escape sequence. -End users need not know about these LDAP escape sequence. - -| ASCII Character | Escape sequence substitute | -| --------------- | ----------------------------------------------- | -| `*` | `\2a` (Character `*` will only be converted in | -| | -eq and -ne comparisons Users should use | -| | -like and -notlike operators for wildcard | -| | comparison.) | -| `(` | `\28` | -| `)` | `\29` | -| `/` | `\2f` | diff --git a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Identity.md b/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Identity.md deleted file mode 100644 index c007277b19..0000000000 --- a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_Identity.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -title: about_ActiveDirectory_Identity -ms.date: 04/22/2013 -description: This article lists the identifying attributes that are used for search and retrieval supported by the Active Directory module for Windows PowerShell. -Locale: en-US -schema: 2.0.0 ---- - -# about_ActiveDirectory_Identity - -## SHORT DESCRIPTION - -The Active Directory module for Windows PowerShell objects have a range of -identifying attributes that are used for search and retrieval. - -## LONG DESCRIPTION - -In order to identify the objects in Active Directory, each object has -attributes that can be used as identifiers. In the Active Directory module, the -value of the identity of an object can be passed using the Identity parameter. -Each object type has its own set of possible types and values for use by the -Identity parameter. See the detailed description of the Identity parameter of -the given cmdlet for more information about its usage. - -When searching with the Active Directory module cmdlets, the value of the -Identity parameter, along with the values of the Server and Partition -parameters, is used to uniquely identify a single object. The Server parameter -is used to locate which server to connect with. The Partition parameter further -narrows the search to a specific partition. The Identity parameter then -resolves to a single unique object in the partition. - -Note that using the Security Accounts Manager (SAM) Account Name -(**sAMAccountName**) when targeting a global catalog port, you will not find a -user in a different domain if you are using the Identity parameter - -If more than one object is found using identity resolution, the Active -Directory module throws an error. - -For more information about the Server and Partition parameters, see the help -topics for the individual cmdlets where they are used, such as `Get-ADUser`, by -typing: - -```powershell -Get-Help Get-ADUser -``` - -### Objects and Identities - -Each object has a list of attributes that can be used as an identity for that -object. Additionally, if the object inherits from another object, then the -parent object's identities can also be used as the child object's identities. -For more information on the Active Directory object hierarchy, see -[about_ActiveDirectory_ObjectModel](about_ActiveDirectory_ObjectModel.md). - -> [!NOTE] -> For Active Directory Provider cmdlets, only an object's 'Distinguished Name' -> or 'Relative Distinguished Name' can be used as the identity. For a list of -> Active Directory Provider cmdlets, see ActiveDirectory. - -### Identity Attributes - -The following is a list of identity attributes by object type. - -- ADAccount - - Distinguished Name - - GUID (objectGUID) - - Security Identifier (objectSid) - - SAM Account Name (sAMAccountName) - -- ADComputer - - Distinguished Name - - GUID (objectGUID) - - Security Identifier (objectSid) - - Security Accounts Manager Account Name (sAMAccountName) - -- ADDirectoryServer - - Name of the server object (name) - - For AD LDS instances the syntax of a name is `$` - - For other Active Directory instances, use the value of the name property. - - Distinguished Name of the NTDS Settings object - - Distinguished Name of the server object that represents the directory - server. - - GUID (objectGUID) of server object under the configuration partition. - - GUID (objectGUID) of NTDS settings object under the configuration partition - -- ADDomain - - Distinguished Name - - GUID - - Security Identifier - - DNS domain name - - NetBIOS domain name - -- ADDomainController - - GUID (objectGUID) - - IPV4Address - - Global IPV6Address - - DNS Host Name (dNSHostName) - - Name of the server object - - Distinguished Name of the NTDS Settings object - - Distinguished Name of the server object that represents the domain controller - - GUID of NTDS settings object under the configuration partition - - GUID of server object under the configuration partition - - Distinguished Name of the computer object that represents the domain controller. - -- ADFineGrainedPasswordPolicy - - Distinguished Name - - GUID (objectGUID) - - Name (name) - -- ADForest - - Fully qualified domain name - - DNS host name - - NetBIOS name - -- ADGroup - - Distinguished Name - - GUID (objectGUID) - - Security Identifier (objectSid) - - Security Accounts Manager (SAM) Account Name (sAMAccountName) - -- ADObject - - Distinguished Name - - GUID (objectGUID) - -- ADOptionalFeature - - Distinguished Name - - Name (name) - - Feature GUID (featureGUID) - - GUID (objectGUID) - -- ADOrganizationalUnit - - Distinguished Name - - GUID (objectGUID) - -- ADPrincipal - - Distinguished Name - - GUID (objectGUID) - - Security Identifier (objectSid) - - SAM Account Name (sAMAccountName) - -- ADServiceAccount - - Distinguished Name - - GUID (objectGUID) - - Security Identifier (objectSid) - - SAM Account Name (sAMAccountName) - -- ADUser - - Distinguished Name - - GUID (objectGUID) - - Security Identifier (objectSid) - - SAM User Name (sAMUserName) - - -### Identities Formats - -Active Directory module objects have a range of identity attributes. Below is a -list of these, their types and formats. - -- Distinguished Name - - Example: CN=SaraDavis,CN=Europe,CN=Users, DC=corp,DC=contoso,DC=com - -- DNS domain name - - Example: redmond.corp.contoso.com - -- DNS Host Name (dNSHostName) - - Example: corp-DC01.corp.contoso.com - -- Feature GUID (featureGUID) - - Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -- Fully qualified domain name - - Example: corp.contoso.com - -- Global IPV6Address - - Example: 2001:4898:0:fff:200:5efe:157.59.132.61 - -- GUID (objectGUID) - - Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -- IPV4Address - - Example:157.59.132.61 - -- NetBIOS domain name - - Example: redmond - -- Name of the server object - - Example: corp-DC01$ - -- SAM Account Name (sAMAccountName) - - Example: saradavisreports - -- Security Identifier (objectSid) - - Example: S-1-5-21-3165297888-301567370-576410423-1103 - -- Name - - Example: Recycle Bin Feature diff --git a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_ObjectModel.md b/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_ObjectModel.md deleted file mode 100644 index 8535a97464..0000000000 --- a/docset/winserver2012-ps/activedirectory/About/about_ActiveDirectory_ObjectModel.md +++ /dev/null @@ -1,595 +0,0 @@ ---- -title: about_ActiveDirectory_ObjectModel -ms.date: 04/22/2013 -description: Describes the object model of the Active Directory module for Windows PowerShell. -Locale: en-US -schema: 2.0.0 ---- - -# about_ActiveDirectory_ObjectModel - -## SHORT DESCRIPTION -Describes the object model of the Active Directory module for Windows -PowerShell. - -## LONG DESCRIPTION - -This topic explains the Active Directory module classes and their properties -used to model actual Active Directory attributes. It also outlines the class -hierarchy constructed from its Active Directory counterpart. The object model -establishes a data foundation for all the operations supported by Active -Directory module cmdlets. - -### Class Hierarchy - -The following list shows the class hierarchy defined in the Active Directory -module object model, with class inheritance implied by indentation. This -inheritance model allows for Active Directory cmdlets to accept a range of -object types as input. This means, for example, that the cmdlet -Get-ADPrincipalGroupMembership can accept as input any of the following -objects: ADGroup, ADAccount, ADComputer, ADServiceAccount or ADUser. This works -because of the inheritance model and guarantees that an ADUser object has all -of the properties of an ADPrincipal object. - -``` -ADEntity - ADRootDSE - ADObject - ADFineGrainedPasswordPolicy - ADOptionalFeature - ADOrganizationalUnit - ADPartition - ADDomain - ADPrincipal - ADAccount - ADComputer - ADServiceAccount - ADUser - ADGroup - ADDefaultDomainPasswordPolicy - ADForest - ADDirectoryServer - ADDomainController -``` - -### Active Directory Module Classes - -The following listing shows every Active Directory module class from the class -hierarchy listing. Each class defines a set of properties, some of which are -LDAP attributes that are retrieved by default and some are new properties -created specifically for the Active Directory module. These new properties are -derived from one or more LDAP attributes as outlined in the class listings. - - -- ADEntity - The base level class from which all other classes are derived. - - ADRootDSE - Represents the rootDSE and is derived from ADEntity. An - ADRootDSE may contain the following properties in addition to those - inherited from its parent. - - ConfigurationNamingContext - A property of type System.String, derived - from the directory attribute ConfigurationNamingContext - - CurrentTime - A property of type System.DateTime, derived from the - directory attribute CurrentTime - - DefaultNamingContext - A property of type System.String, derived from the - directory attribute DefaultNamingContext - - DnsHostName - A property of type System.String, derived from the - directory attribute DnsHostName - - DomainControllerFunctionality - A property of type - ADDomainControllerMode, derived from the directory attribute - DomainControllerFunctionality - - DomainFunctionality - A property of type ADDomainMode, derived from the - directory attribute DomainFunctionality - - DsServiceName - A property of type System.String, derived from the - directory attribute DsServiceName - - ForestFunctionality - A property of type ADForestMode, derived from the - directory attribute ForestFunctionality - - GlobalCatalogReady - A property of type System.Boolean, derived from the - directory attribute GlobalCatalogReady - - HighestCommittedUSN - A property of type System.Long, derived from the - directory attribute HighestCommittedUSN - - LdapServiceName - A property of type System.String, derived from the - directory attribute LdapServiceName - - NamingContexts - A property of type System.String, derived from the - directory attribute NamingContexts - - RootDomainNamingContext - A property of type System.String, derived from - the directory attribute RootDomainNamingContext - - SchemaNamingContext - A property of type System.String, derived from the - directory attribute SchemaNamingContext - - ServerName - A property of type System.String, derived from the directory - attribute ServerName - - SubschemaSubentry - A property of type ADObject, derived from the - directory attribute SubschemaSubentry - - SupportedCapabilities - A property of type ADObjectIdentifier, derived - from the directory attribute SupportedCapabilities - - SupportedControl - A property of type ADObjectIdentifier, derived from - the directory attribute SupportedControl - - SupportedLDAPPolicies - A property of type System.String, derived from - the directory attribute SupportedLDAPPolicies - - SupportedLDAPVersion - A property of type System.Int, derived from the - directory attribute SupportedLDAPVersion - - SupportedRootDSEOperations - A property of type - ADPropertyValueCollection, derived from the directory attribute - SupportedRootDSEOperations - - SupportedSASLMechanisms - A property of type System.String, derived from - the directory attribute SupportedSASLMechanisms - - Syncronized - A property of type System.Boolean, derived from the - directory attribute IsSynchronized. - - ADObject - Represents any object in Active Directory and is derived from - ADEntity. An ADObject may contain the following properties in addition to - those inherited from its parent. - - CanonicalName - A property of type System.String, derived from the - directory attribute: canonicalName - - CN - A property of type System.String, derived from the directory - attribute: cn - - Created - A property of type System.DateTime, derived from the directory - attribute: createTimeStamp - - Deleted - A property of type System.Boolean, derived from the directory - attribute: isDeleted - - Description - A property of type System.String, derived from the - directory attribute: description - - DisplayName - A property of type System.String, derived from the - directory attribute: displayName - - DistinguishedName - A property of type System.String, derived from the - directory attribute: distinguishedName - - LastKnownParent - A property of type System.String, derived from the - directory attribute: lastKnownParent - - Modified - A property of type System.DateTime, derived from the directory - attribute: modifyTimeStamp - - Name - A property of type System.String, derived from the directory - attribute: name - - ObjectCategory - A property of type System.String, derived from the - directory attribute: objectCategory - - ObjectClass - A property of type System.String, derived from the - directory attribute: objectClass - - ObjectGUID - A property of type System.Guid, derived from the directory - attribute: objectGUID - - ProtectedFromAccidentalDeletion - A property of type System.Boolean, - derived from the directory attributes: nTSecurityDescriptor, - sdRightsEffective, instanceType, isDeleted - - ADFineGrainedPasswordPolicy Represents a fine grained password policy - object; that is, an AD object of type msDS-PasswordSettings in AD DS and - is derived from ADObject. This class is not supported by AD LDS. An - ADFineGrainedPasswordPolicy may contain the following properties in - addition to those inherited from its parent. - - AppliesTo - A property of type System.String, derived from the - directory attribute: msDS-PSOAppliesTo - - ComplexityEnabled - A property of type System.Boolean, derived from the - directory attribute: msDS-PasswordComplexityEnabled - - LockoutDuration - A property of type System.TimeSpan, derived from the - directory attribute: msDS-LockoutDuration - - LockoutObservationWindow - A property of type System.TimeSpan, derived - from the directory attribute: msDS-LockoutObservationWindow - - LockoutThreshold - A property of type System.Int32, derived from the - directory attribute: msDS-LockoutThreshold - - MaxPasswordAge - A property of type System.TimeSpan, derived from the - directory attribute: msDS-MaximumPasswordAge - - MinPasswordAge - A property of type System.TimeSpan, derived from the - directory attribute: msDS-MinimumPasswordAge - - MinPasswordLength - A property of type System.Int32, derived from the - directory attribute: msDS-MinimumPasswordLength - - PasswordHistoryCount - A property of type System.Int32, derived from - the directory attribute: msDS-PasswordHistoryLength - - Precedence - A property of type System.Int32, derived from the - directory attribute: msDS-PasswordSettingsPrecedence - - ReversibleEncryptionEnabled - A property of type System.Boolean, - derived from the directory attribute: - msDS-PasswordReversibleEncryptionEnabled - - ADOptionalFeature Represents an optional feature, an Active Directory - object of type msDS-OptionalFeature, and is derived from ADObject. An - ADOptionalFeaturemay contain the following properties in addition to - those inherited from its parent. - - EnabledScopes - A property of type System.String, derived from the - directory attribute: msDS-EnabledFeatureBL - - FeatureGUID - A property of type System.Guid, derived from the - directory attribute: msDS-OptionalFeatureGUID - - FeatureScope - A property of type System.Int32, derived from the - directory attribute: msDS-OptionalFeatureFlags - - IsDisableable - A property of type System.Boolean, derived from the - directory attribute: msDS-OptionalFeatureFlags - - RequiredDomainMode - A property of type - Microsoft.ActiveDirectory.Management.ADDomainMode, derived from the - directory attribute: msDS-RequiredDomainBehaviorVersion - - RequiredForestMode - A property of type - Microsoft.ActiveDirectory.Management.ADForestMode, derived from the - directory attribute: msDS-RequiredForestBehaviorVersion - - ADOrganizationalUnit Represents an organizationalUnit (OU) object and is - derived from ADObject. An ADOrganizationalUnit may contain the following - properties in addition to those inherited from its parent. - - City - A property of type System.String, derived from the directory - attribute: l - - Country - A property of type System.String, derived from the directory - attribute: c - - LinkedGroupPolicyObjects - A property of type System.String, derived - from the directory attribute: gpLink. This property is not supported on - AD LDS. - - ManagedBy - A property of type System.String, derived from the - directory attribute: managedBy - - PostalCode - A property of type System.String, derived from the - directory attribute: postalCode - - State - A property of type System.String, derived from the directory - attribute: st - - StreetAddress - A property of type System.String, derived from the - directory attribute: street - - ADPartition - Represents a naming context, Configuration, Schema, Domain - or Application Partition(ND NC) and is derived from ADObject. This class - is not supported by AD LDS. An ADPartition may contain the following - properties in addition to those inherited from its parent. - - DeletedObjectsContainer - A property of type System.String, derived - from the directory attribute: DeletedObjectsContainer - - DNSRoot - A property of type System.String, derived from the directory - attribute: DNSRoot - - LostAndFoundContainer - A property of type System.String, derived from - the directory attribute: LostAndFoundContainer - - QuotasContainer - A property of type System.String, derived from the - directory attribute: QuotasContainer - - ReadOnlyReplicaDirectoryServers - A property of type System.String, - derived from the directory attribute: ReadOnlyReplicaDirectoryServers - - ReplicaDirectoryServers - A property of type System.String, derived - from the directory attribute: ReplicaDirectoryServers - - SubordinateReferences - A property of type System.String, derived from - the directory attribute: SubordinateReferences - - ADDomain - Represents a domain in AD DS or an instance in AD LDS; for - example, an Active Directory object of type domainDNS and is derived - from ADPartition. This class is not supported by AD LDS. An ADDomain - may contain the following properties in addition to those inherited - from its parent. - - AllowedDNSSuffixes - A property of type System.String, derived from - the directory attribute: msDS-AllowedDNSSuffixes - - ChildDomains - A property of type System.String, derived from the - directory attribute: ChildDomains - - ComputersContainer - A property of type System.String, derived from - the directory attribute: ComputersContainer - - DomainControllersContainer - A property of type System.String, - derived from the directory attribute: DomainControllersContainer - - DomainMode - A property of type System.Int32, derived from the - directory attribute: msDS-Behavior-Version - - DomainSID - A property of type - System.Security.Principal.SecurityIdentifier, derived from the - directory attribute: objectSid - - ForeignSecurityPrincipalsContainer - A property of type - System.String, derived from the directory attribute: - ForeignSecurityPrincipalsContainer - - Forest - A property of type System.String, derived from the directory - attribute: Forest - - InfrastructureMaster - A property of type System.String, derived from - the directory attribute: InfrastructureMaster - - LastLogonReplicationInterval - A property of type System.TimeSpan, - derived from the directory attribute: msDS-LogonTimeSyncInterval - - LinkedGroupPolicyObjects - A property of type System.String, derived - from the directory attribute: LinkedGroupPolicyObjects - - ManagedBy - A property of type System.String, derived from the - directory attribute: managedBy - - NetBIOSName - A property of type System.String, derived from the - directory attribute: NetBIOSName - - ParentDomain - A property of type System.String, derived from the - directory attribute: ParentDomain - - PDCEmulator - A property of type System.String, derived from the - directory attribute: PDCEmulator - - RIDMaster - A property of type System.String, derived from the - directory attribute: RIDMaster - - SystemsContainer - A property of type System.String, derived from the - directory attribute: SystemsContainer - - UsersContainer - A property of type System.String, derived from the - directory attribute: UsersContainer - - ADPrincipal - Represents a security principal, which is an Active - Directory object of type user, computer, group or iNetOrgPerson and is - derived from ADObject. An ADPrincipal may contain the following - properties in addition to those inherited from its parent. - - HomePage - A property of type System.String, derived from the - directory attribute: wWWHomePage - - MemberOf - A property of type System.String, derived from the - directory attribute: memberOf - - SamAccountName - A property of type System.String, derived from the - directory attribute: sAMAccountName. This property is not supported - for AD LDS. - - SID - A property of type - System.Security.Principal.SecurityIdentifier, derived from the - directory attribute: objectSid - - SIDHistory - A property of type - System.Security.Principal.SecurityIdentifier, derived from the - directory attribute: sIDHistory. This property is not supported for - AD LDS. - - ADAccount - Represents a security account; that is, an Active - Directory object of type user, computer or iNetOrgPerson and is - derived from ADPrincipal. An ADAccount may contain the following - properties in addition to those inherited from its parent. - - AccountExpirationDate - A property of type System.DateTime, derived - from the directory attribute: accountExpires - - AccountLockoutTime - A property of type System.DateTime, derived - from the directory attribute: lockoutTime - - AccountNotDelegated - A property of type System.Boolean, derived - from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - AllowReversiblePasswordEncryption - A property of type - System.Boolean, for AD DS it is derived from the directory - attribute: userAccountControl; for AD LDS it is derived from the - directory attribute: ms-DS-UserEncryptedTextPasswordAllowed - - BadLogonCount - A property of type System.Int32, derived from the - directory attribute: badPwdCount - - CannotChangePassword - A property of type System.Boolean, derived - from the directory attribute: nTSecurityDescriptor - - Certificates - A property of type - System.Security.Cryptography.X509Certificates.X509Certificate, - derived from the directory attribute: userCertificate - - DoesNotRequirePreAuth - A property of type System.Boolean, derived - from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - Enabled - A property of type System.Boolean, for AD DS it is - derived from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed; for AD LDS it is derived from - the directory attribute msDS-UserAccountDisabled - - HomedirRequired - A property of type System.Boolean, derived from - the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - LastBadPasswordAttempt - A property of type System.DateTime, - derived from the directory attribute: badPasswordTime - - LastLogonDate - A property of type System.DateTime, derived from - the directory attribute: lastLogonTimestamp - - LockedOut - A property of type System.Boolean, for AD DS it is - derived from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed, lockoutTime; for AD LDS it is - derived from the directory attribute msDS-UserAccountDisabled - - MNSLogonAccount - A property of type System.Boolean, derived from - the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - PasswordExpired - A property of type System.Boolean, for AD DS it - is derived from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed; for AD LDS it is derived from - the directory attribute msDS-UserPasswordExpired - - PasswordLastSet - A property of type System.DateTime, derived from - the directory attribute: pwdLastSet - - PasswordNeverExpires - A property of type System.Boolean, for AD - LDS it is derived from the directory attributes: - userAccountControl, msDS-User-Account-Control-Computed; for AD LDS - it is derived from the directory attribute: - msDS-UserDontExpirePassword - - PasswordNotRequired - A property of type System.Boolean, for AD DS - it is derived from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed; for AD LDS it is derived from - the directory attribute: ms-DS-UserPasswordNotRequired - - PrimaryGroup - A property of type System.String, derived from the - directory attributes: primaryGroupID, objectSid. This property is - not supported by AD LDS. - - ServicePrincipalNames - A property of type System.String, derived - from the directory attribute: servicePrincipalName. This property - is not supported by AD LDS. - - TrustedForDelegation - A property of type System.Boolean, derived - from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - TrustedToAuthForDelegation - A property of type System.Boolean, - derived from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - UseDESKeyOnly - A property of type System.Boolean, derived from the - directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not supported - by AD LDS. - - UserPrincipalName - A property of type System.String, derived from - the directory attribute: userPrincipalName - - ADComputer - Represents a computer and is derived from ADAccount. - An ADComputer may contain the following properties in addition to - those inherited from its parent. - - DNSHostName - A property of type System.String, derived from the - directory attribute: dNSHostName - - IPv4Address - A property of type System.String, derived from the - directory attribute: dNSHostName - - IPv6Address - A property of type System.String, derived from the - directory attribute: dNSHostName - - Location - A property of type System.String, derived from the - directory attribute: location - - ManagedBy - A property of type System.String, derived from the - directory attribute: managedBy - - OperatingSystem - A property of type System.String, derived from - the directory attribute: operatingSystem - - OperatingSystemHotfix - A property of type System.String, derived - from the directory attribute: operatingSystemHotfix - - OperatingSystemServicePack - A property of type System.String, - derived from the directory attribute: operatingSystemServicePack - - OperatingSystemVersion - A property of type System.String, - derived from the directory attribute: operatingSystemVersion - - ServiceAccount - A property of type System.String, derived from - the directory attribute: msDS-HostServiceAccount - - ADServiceAccount - Represents a managed service account; that is, - an Active Directory object of type msDS-ManagerdServiceAccount and - is derived from ADAccount. This class is not supported by AD LDS. - An ADServiceAccount may contain the following properties in - addition to those inherited from its parent. - - HostComputers - A property of type System.String, derived from - the directory attribute: msDS-HostServiceAccountBL - - ADUser - Represents a user (or iNetOrgPerson) and is derived from - ADAccount. An ADUser may contain the following properties in - addition to those inherited from its parent. - - City - A property of type System.String, derived from the - directory attribute: l - - Company - A property of type System.String, derived from the - directory attribute: company - - Country - A property of type System.String, derived from the - directory attribute: c - - Department - A property of type System.String, derived from the - directory attribute: department - - Division - A property of type System.String, derived from the - directory attribute: division - - EmailAddress - A property of type System.String, derived from the - directory attribute: mail - - EmployeeID - A property of type System.String, derived from the - directory attribute: employeeID - - EmployeeNumber - A property of type System.String, derived from - the directory attribute: employeeNumber - - Fax - A property of type System.String, derived from the - directory attribute: facsimileTelephoneNumber - - GivenName - A property of type System.String, derived from the - directory attribute: givenName - - HomeDirectory - A property of type System.String, derived from - the directory attribute: homeDirectory. This property is not - supported by AD LDS. - - HomeDrive - A property of type System.String, derived from the - directory attribute: homeDrive. This property is not supported by - AD LDS. - - HomePhone - A property of type System.String, derived from the - directory attribute: homePhone - - Initials - A property of type System.String, derived from the - directory attribute: initials - - LogonWorkstations - A property of type System.String, derived - from the directory attribute: userWorkstations. This property is - not supported by AD LDS. - - Manager - A property of type System.String, derived from the - directory attribute: manager - - MobilePhone - A property of type System.String, derived from the - directory attribute: mobile - - Office - A property of type System.String, derived from the - directory attribute: physicalDeliveryOfficeName - - OfficePhone - A property of type System.String, derived from the - directory attribute: telephoneNumber - - Organization - A property of type System.String, derived from the - directory attribute: o - - OtherName - A property of type System.String, derived from the - directory attribute: middleName - - POBox - A property of type System.String, derived from the - directory attribute: postOfficeBox - - PostalCode - A property of type System.String, derived from the - directory attribute: postalCode - - ProfilePath - A property of type System.String, derived from the - directory attribute: profilePath. This property is not supported - by AD LDS. - - ScriptPath - A property of type System.String, derived from the - directory attribute: scriptPath. This property is not supported - by AD LDS. - - SmartcardLogonRequired - A property of type System.Boolean, - derived from the directory attributes: userAccountControl, - msDS-User-Account-Control-Computed. This property is not - supported by AD LDS. - - State - A property of type System.String, derived from the - directory attribute: st - - StreetAddress - A property of type System.String, derived from - the directory attribute: streetAddress - - Surname - A property of type System.String, derived from the - directory attribute: sn - - Title - A property of type System.String, derived from the - directory attribute: title - - ADGroup -Represents a group and is derived from ADPrincipal. An - ADGroup may contain the following properties in addition to those - inherited from its parent. - - GroupCategory - A property of type - Microsoft.ActiveDirectory.Management.ADGroupCategory, derived from - the directory attribute: groupType - - GroupScope - A property of type - Microsoft.ActiveDirectory.Management.ADGroupScope, derived from the - directory attribute: groupType - - ManagedBy - A property of type System.String, derived from the - directory attribute: managedBy - - Members - A property of type System.String, derived from the - directory attribute: member - - ADDefaultDomainPasswordPolicy - Represents the domain-wide password policy - of an Active Directory domain and is derived from ADEntity. This class is - not supported by AD LDS. An ADDefaultDomainPasswordPolicy may contain the - following properties in addition to those inherited from its parent. - - ComplexityEnabled - A property of type System.Boolean, derived from the - directory attribute: pwdProperties - - DistinguishedName - A property of type System.String, derived from the - directory attribute: distinguishedName - - LockoutDuration - A property of type System.TimeSpan, derived from the - directory attribute: lockoutDuration - - LockoutObservationWindow - A property of type System.TimeSpan, derived - from the directory attribute: lockoutObservationWindow - - LockoutThreshold - A property of type System.Int32, derived from the - directory attribute: lockoutThreshold - - MaxPasswordAge - A property of type System.TimeSpan, derived from the - directory attribute: maxPwdAge - - MinPasswordAge - A property of type System.TimeSpan, derived from the - directory attribute: minPwdAge - - MinPasswordLength - A property of type System.Int32, derived from the - directory attribute: minPwdLength - - PasswordHistoryCount - A property of type System.Int32, derived from the - directory attribute: pwdHistoryLength - - ReversibleEncryptionEnabled - A property of type System.Boolean, derived - from the directory attribute: pwdProperties - - ADForest - Represents a Active Directory forest in AD DS or a Configuration - Set in AD LDS and is derived from ADEntity. This class is not supported by - AD LDS. An ADForest may contain the following properties in addition to - those inherited from its parent. - - ApplicationPartitions - A property of type System.String, derived from - the directory attribute: ApplicationPartitions - - CrossForestReferences - A property of type System.String, derived from - the directory attribute: CrossForestReferences - - DomainNamingMaster - A property of type System.String, derived from the - directory attribute: DomainNamingMaster - - Domains - A property of type System.String, derived from the directory - attribute: Domains - - ForestMode - A property of type System.Int32, derived from the directory - attribute: msDS-Behavior-Version - - GlobalCatalogs - A property of type System.String, derived from the - directory attribute: GlobalCatalogs - - Name - A property of type System.String, derived from the directory - attribute: name - - PartitionContainerName - A property of type System.String, derived from - the directory attribute: distinguishedName - - RootDomain - A property of type System.String, derived from the directory - attribute: RootDomain - - SchemaMaster - A property of type System.String, derived from the - directory attribute: SchemaMaster - - Sites - A property of type System.String, derived from the directory - attribute: Sites - - SPNSuffixes - A property of type System.String, derived from the - directory attribute: msDS-SPNSuffixes - - UPNSuffixes - A property of type System.String, derived from the - directory attribute: uPNSuffixes - - ADDirectoryServer - Represents a directory server used as either a domain - controller or an AD LDS instance and is derived from ADEntity. An - ADDirectoryServer may contain the following properties in addition to those - inherited from its parent. - - DefaultPartition - A property of type System.String, derived from the - directory attribute: DefaultPartition - - HostName - A property of type System.String, derived from the directory - attribute: HostName - - InvocationId - A property of type System.Guid, derived from the directory - attribute: InvocationId - - IPv4Address - A property of type System.String, derived from the - directory attribute: HostName - - IPv6Address - A property of type System.String, derived from the - directory attribute: HostName - - LdapPort - A property of type System.Int32, derived from the directory - attribute: LdapPort - - Name - A property of type System.String, derived from the directory - attribute: Name - - NTDSSettingsObjectDN - A property of type System.String, derived from the - directory attribute: NTDSSettingsObjectDN - - OperationMasterRoles - A property of type - Microsoft.ActiveDirectory.Management.ADOperationMasterRole, derived from - the directory attribute: OperationMasterRole - - Partitions - A property of type System.String, derived from the directory - attribute: Partitions - - ServerObjectDN - A property of type System.String, derived from the - directory attribute: ServerObjectDN - - ServerObjectGuid - A property of type System.Guid, derived from the - directory attribute: ServerObjectGuid - - Site - A property of type System.String, derived from the directory - attribute: Site - - SslPort - A property of type System.Int32, derived from the directory - attribute: SslPort - - ADDomainController - Represents a domain controller in AD DS and is - derived from ADDirectoryServer. An ADDomainController may contain the - following properties in addition to those inherited from its parent. - - ComputerObjectDN - A property of type System.String, derived from the - directory attribute: ComputerDN - - Domain - A property of type System.String, derived from the directory - attribute: Domain - - Enabled - A property of type System.Boolean, derived from the directory - attribute: Enabled - - Forest - A property of type System.String, derived from the directory - attribute: Forest - - IsGlobalCatalog - A property of type System.Boolean, derived from the - directory attribute: IsGlobalCatalog - - IsReadOnly - A property of type System.Boolean, derived from the - directory attribute: IsReadOnly - - OperatingSystem - A property of type System.String, derived from the - directory attribute: OSName - - OperatingSystemHotfix - A property of type System.String, derived from - the directory attribute: OSHotFix - - OperatingSystemServicePack - A property of type System.String, derived - from the directory attribute: OSServicepack - - OperatingSystemVersion - A property of type System.String, derived from - the directory attribute: OSVersion diff --git a/docset/winserver2012-ps/activedirectory/ActiveDirectory.md b/docset/winserver2012-ps/activedirectory/ActiveDirectory.md deleted file mode 100644 index 0c2c7fdc01..0000000000 --- a/docset/winserver2012-ps/activedirectory/ActiveDirectory.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 43c15630-959c-49e4-a977-758c5cc93408 -Module Name: ActiveDirectory ---- - -# ActiveDirectory Module -## Description -The Active Directory module for Windows PowerShell is a PowerShell module that consolidates a group of cmdlets. You can use these cmdlets to manage your Active Directory domains, Active Directory Lightweight Directory Services (AD LDS) configuration sets, and Active Directory Database Mounting Tool instances in a single, self-contained package. - -## ActiveDirectory Cmdlets -### [Add-ADCentralAccessPolicyMember](./Add-ADCentralAccessPolicyMember.md) -Adds central access rules to a central access policy in Active Directory. - -### [Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) -Adds one or more service accounts to an Active Directory computer. - -### [Add-ADDomainControllerPasswordReplicationPolicy](./Add-ADDomainControllerPasswordReplicationPolicy.md) -Adds users, computers, and groups to the allowed or denied list of a read-only domain controller password replication policy. - -### [Add-ADFineGrainedPasswordPolicySubject](./Add-ADFineGrainedPasswordPolicySubject.md) -Applies a fine-grained password policy to one more users and groups. - -### [Add-ADGroupMember](./Add-ADGroupMember.md) -Adds one or more members to an Active Directory group. - -### [Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) -Adds a member to one or more Active Directory groups. - -### [Add-ADResourcePropertyListMember](./Add-ADResourcePropertyListMember.md) -Adds one or more resource properties to a resource property list in Active Directory. - -### [Clear-ADAccountExpiration](./Clear-ADAccountExpiration.md) -Clears the expiration date for an Active Directory account. - -### [Clear-ADClaimTransformLink](./Clear-ADClaimTransformLink.md) -Removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory. - -### [Disable-ADAccount](./Disable-ADAccount.md) -Disables an Active Directory account. - -### [Disable-ADOptionalFeature](./Disable-ADOptionalFeature.md) -Disables an Active Directory optional feature. - -### [Enable-ADAccount](./Enable-ADAccount.md) -Enables an Active Directory account. - -### [Enable-ADOptionalFeature](./Enable-ADOptionalFeature.md) -Enables an Active Directory optional feature. - -### [Get-ADAccountAuthorizationGroup](./Get-ADAccountAuthorizationGroup.md) -Gets the accounts token group information. - -### [Get-ADAccountResultantPasswordReplicationPolicy](./Get-ADAccountResultantPasswordReplicationPolicy.md) -Gets the resultant password replication policy for an Active Directory account. - -### [Get-ADCentralAccessPolicy](./Get-ADCentralAccessPolicy.md) -Retrieves central access policies from Active Directory. - -### [Get-ADCentralAccessRule](./Get-ADCentralAccessRule.md) -Retrieves central access rules from Active Directory. - -### [Get-ADClaimTransformPolicy](./Get-ADClaimTransformPolicy.md) -Returns one or more Active Directory claim transform objects based on a specified filter. - -### [Get-ADClaimType](./Get-ADClaimType.md) -Returns a claim type from Active Directory. - -### [Get-ADComputer](./Get-ADComputer.md) -Gets one or more Active Directory computers. - -### [Get-ADComputerServiceAccount](./Get-ADComputerServiceAccount.md) -Gets the service accounts hosted by a computer. - -### [Get-ADDCCloningExcludedApplicationList](./Get-ADDCCloningExcludedApplicationList.md) -Returns the list of installed programs and services present on this domain controller that are not in the default or user defined inclusion list. - -### [Get-ADDefaultDomainPasswordPolicy](./Get-ADDefaultDomainPasswordPolicy.md) -Gets the default password policy for an Active Directory domain. - -### [Get-ADDomain](./Get-ADDomain.md) -Gets an Active Directory domain. - -### [Get-ADDomainController](./Get-ADDomainController.md) -Gets one or more Active Directory domain controllers based on discoverable services criteria, search parameters or by providing a domain controller identifier, such as the NetBIOS name. - -### [Get-ADDomainControllerPasswordReplicationPolicy](./Get-ADDomainControllerPasswordReplicationPolicy.md) -Gets the members of the allowed list or denied list of a read-only domain controller's password replication policy. - -### [Get-ADDomainControllerPasswordReplicationPolicyUsage](./Get-ADDomainControllerPasswordReplicationPolicyUsage.md) -Gets the Active Directory accounts that are authenticated by a read-only domain controller or that are in the revealed list of the domain controller. - -### [Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) -Gets one or more Active Directory fine grained password policies. - -### [Get-ADFineGrainedPasswordPolicySubject](./Get-ADFineGrainedPasswordPolicySubject.md) -Gets the users and groups to which a fine grained password policy is applied. - -### [Get-ADForest](./Get-ADForest.md) -Gets an Active Directory forest. - -### [Get-ADGroup](./Get-ADGroup.md) -Gets one or more Active Directory groups. - -### [Get-ADGroupMember](./Get-ADGroupMember.md) -Gets the members of an Active Directory group. - -### [Get-ADObject](./Get-ADObject.md) -Gets one or more Active Directory objects. - -### [Get-ADOptionalFeature](./Get-ADOptionalFeature.md) -Gets one or more Active Directory optional features. - -### [Get-ADOrganizationalUnit](./Get-ADOrganizationalUnit.md) -Gets one or more Active Directory organizational units. - -### [Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) -Gets the Active Directory groups that have a specified user, computer, group, or service account. - -### [Get-ADReplicationAttributeMetadata](./Get-ADReplicationAttributeMetadata.md) -Returns the replication metadata for one or more Active Directory replication partners. - -### [Get-ADReplicationConnection](./Get-ADReplicationConnection.md) -Returns a specific Active Directory replication connection or a set of AD replication connection objects based on a specified filter. - -### [Get-ADReplicationFailure](./Get-ADReplicationFailure.md) -Returns a collection of data describing an Active Directory replication failure. - -### [Get-ADReplicationPartnerMetadata](./Get-ADReplicationPartnerMetadata.md) -Returns the replication metadata for a set of one or more replication partners. - -### [Get-ADReplicationQueueOperation](./Get-ADReplicationQueueOperation.md) -Returns the contents of the replication queue for a specified server. - -### [Get-ADReplicationSite](./Get-ADReplicationSite.md) -Returns a specific Active Directory replication site or a set of replication site objects based on a specified filter. - -### [Get-ADReplicationSiteLink](./Get-ADReplicationSiteLink.md) -Returns a specific Active Directory site link or a set of site links based on a specified filter. - -### [Get-ADReplicationSiteLinkBridge](./Get-ADReplicationSiteLinkBridge.md) -Returns a specific Active Directory site link bridge or a set of site link bridge objects based on a specified filter. - -### [Get-ADReplicationSubnet](./Get-ADReplicationSubnet.md) -Returns a specific Active Directory subnet or a set of AD subnets based on a specified filter. - -### [Get-ADReplicationUpToDatenessVectorTable](./Get-ADReplicationUpToDatenessVectorTable.md) -Displays the highest Update Sequence Number (USN) for the specified domain controller. - -### [Get-ADResourceProperty](./Get-ADResourceProperty.md) -Gets one or more resource properties. - -### [Get-ADResourcePropertyList](./Get-ADResourcePropertyList.md) -Retrieves resource property lists from Active Directory. - -### [Get-ADResourcePropertyValueType](./Get-ADResourcePropertyValueType.md) -Retrieves a resource property value type from Active Directory. - -### [Get-ADRootDSE](./Get-ADRootDSE.md) -Gets the root of a Directory Server information tree. - -### [Get-ADServiceAccount](./Get-ADServiceAccount.md) -Gets one or more Active Directory managed service accounts or group managed service accounts. - -### [Get-ADTrust](./Get-ADTrust.md) -Returns all trusted domain objects in the directory. - -### [Get-ADUser](./Get-ADUser.md) -Gets one or more Active Directory users. - -### [Get-ADUserResultantPasswordPolicy](./Get-ADUserResultantPasswordPolicy.md) -Gets the resultant password policy for a user. - -### [Install-ADServiceAccount](./Install-ADServiceAccount.md) -Installs an Active Directory managed service account on a computer or caches a group managed service account on a computer. - -### [Move-ADDirectoryServer](./Move-ADDirectoryServer.md) -Moves a directory server in Active Directory to a new site. - -### [Move-ADDirectoryServerOperationMasterRole](./Move-ADDirectoryServerOperationMasterRole.md) -Moves operation master roles to an Active Directory directory server. - -### [Move-ADObject](./Move-ADObject.md) -Moves an Active Directory object or a container of objects to a different container or domain. - -### [New-ADCentralAccessPolicy](./New-ADCentralAccessPolicy.md) -Creates a new central access policy in Active Directory containing a set of central access rules. - -### [New-ADCentralAccessRule](./New-ADCentralAccessRule.md) -Creates a new central access rule in Active Directory. - -### [New-ADClaimTransformPolicy](./New-ADClaimTransformPolicy.md) -Creates a new claim transformation policy object in Active Directory. - -### [New-ADClaimType](./New-ADClaimType.md) -Creates a new claim type in Active Directory. - -### [New-ADComputer](./New-ADComputer.md) -Creates a new Active Directory computer. - -### [New-ADDCCloneConfigFile](./New-ADDCCloneConfigFile.md) -Performs prerequisite checks for cloning a domain controller and generates a clone configuration file if all checks succeed. - -### [New-ADFineGrainedPasswordPolicy](./New-ADFineGrainedPasswordPolicy.md) -Creates a new Active Directory fine grained password policy. - -### [New-ADGroup](./New-ADGroup.md) -Creates an Active Directory group. - -### [New-ADObject](./New-ADObject.md) -Creates an Active Directory object. - -### [New-ADOrganizationalUnit](./New-ADOrganizationalUnit.md) -Creates a new Active Directory organizational unit. - -### [New-ADReplicationSite](./New-ADReplicationSite.md) -Creates a new Active Directory replication site in the directory. - -### [New-ADReplicationSiteLink](./New-ADReplicationSiteLink.md) -Creates a new Active Directory site link for in managing replication. - -### [New-ADReplicationSiteLinkBridge](./New-ADReplicationSiteLinkBridge.md) -Creates a new site link bridge in Active Directory for replication. - -### [New-ADReplicationSubnet](./New-ADReplicationSubnet.md) -Creates a new Active Directory replication subnet object. - -### [New-ADResourceProperty](./New-ADResourceProperty.md) -Creates a new resource property in Active Directory. - -### [New-ADResourcePropertyList](./New-ADResourcePropertyList.md) -Creates a new resource property list in Active Directory. - -### [New-ADServiceAccount](./New-ADServiceAccount.md) -Creates a new Active Directory managed service account or group managed service account object. - -### [New-ADUser](./New-ADUser.md) -Creates a new Active Directory user. - -### [Remove-ADCentralAccessPolicy](./Remove-ADCentralAccessPolicy.md) -Removes a central access policy from Active Directory. - -### [Remove-ADCentralAccessPolicyMember](./Remove-ADCentralAccessPolicyMember.md) -Removes central access rules from a central access policy in Active Directory. - -### [Remove-ADCentralAccessRule](./Remove-ADCentralAccessRule.md) -Removes a central access rule from Active Directory. - -### [Remove-ADClaimTransformPolicy](./Remove-ADClaimTransformPolicy.md) -Removes a claim transformation policy object from Active Directory. - -### [Remove-ADClaimType](./Remove-ADClaimType.md) -Removes a claim type from Active Directory. - -### [Remove-ADComputer](./Remove-ADComputer.md) -Removes an Active Directory computer. - -### [Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) -Removes one or more service accounts from a computer. - -### [Remove-ADDomainControllerPasswordReplicationPolicy](./Remove-ADDomainControllerPasswordReplicationPolicy.md) -Removes users, computers and groups from the allowed or denied list of a read-only domain controller password replication policy. - -### [Remove-ADFineGrainedPasswordPolicy](./Remove-ADFineGrainedPasswordPolicy.md) -Removes an Active Directory fine grained password policy. - -### [Remove-ADFineGrainedPasswordPolicySubject](./Remove-ADFineGrainedPasswordPolicySubject.md) -Removes one or more users from a fine grained password policy. - -### [Remove-ADGroup](./Remove-ADGroup.md) -Removes an Active Directory group. - -### [Remove-ADGroupMember](./Remove-ADGroupMember.md) -Removes one or more members from an Active Directory group. - -### [Remove-ADObject](./Remove-ADObject.md) -Removes an Active Directory object. - -### [Remove-ADOrganizationalUnit](./Remove-ADOrganizationalUnit.md) -Removes an Active Directory organizational unit. - -### [Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) -Removes a member from one or more Active Directory groups. - -### [Remove-ADReplicationSite](./Remove-ADReplicationSite.md) -Deletes the specified replication site object from Active Directory. - -### [Remove-ADReplicationSiteLink](./Remove-ADReplicationSiteLink.md) -Deletes an Active Directory site link used to manage replication. - -### [Remove-ADReplicationSiteLinkBridge](./Remove-ADReplicationSiteLinkBridge.md) -Deletes the specified replication site link bridge from Active Directory. - -### [Remove-ADReplicationSubnet](./Remove-ADReplicationSubnet.md) -Deletes the specified Active Directory replication subnet object from the directory. - -### [Remove-ADResourceProperty](./Remove-ADResourceProperty.md) -Removes a resource property from Active Directory. - -### [Remove-ADResourcePropertyList](./Remove-ADResourcePropertyList.md) -Removes one or more resource property lists from Active Directory. - -### [Remove-ADResourcePropertyListMember](./Remove-ADResourcePropertyListMember.md) -Removes one or more resource properties from a resource property list in Active Directory. - -### [Remove-ADServiceAccount](./Remove-ADServiceAccount.md) -Remove an Active Directory managed service account or group managed service account object. - -### [Remove-ADUser](./Remove-ADUser.md) -Removes an Active Directory user. - -### [Rename-ADObject](./Rename-ADObject.md) -Changes the name of an Active Directory object. - -### [Reset-ADServiceAccountPassword](./Reset-ADServiceAccountPassword.md) -Resets the password for a standalone managed service account. - -### [Restore-ADObject](./Restore-ADObject.md) -Restores an Active Directory object. - -### [Search-ADAccount](./Search-ADAccount.md) -Gets Active Directory user, computer, or service accounts. - -### [Set-ADAccountControl](./Set-ADAccountControl.md) -Modifies user account control (UAC) values for an Active Directory account. - -### [Set-ADAccountExpiration](./Set-ADAccountExpiration.md) -Sets the expiration date for an Active Directory account. - -### [Set-ADAccountPassword](./Set-ADAccountPassword.md) -Modifies the password of an Active Directory account. - -### [Set-ADCentralAccessPolicy](./Set-ADCentralAccessPolicy.md) -Modifies a central access policy in Active Directory. - -### [Set-ADCentralAccessRule](./Set-ADCentralAccessRule.md) -Modifies a central access rule in Active Directory. - -### [Set-ADClaimTransformLink](./Set-ADClaimTransformLink.md) -Applies a claims transformation to one or more cross-forest trust relationships in Active Directory. - -### [Set-ADClaimTransformPolicy](./Set-ADClaimTransformPolicy.md) -Sets the properties of a claims transformation policy in Active Directory. - -### [Set-ADClaimType](./Set-ADClaimType.md) -Modify a claim type in Active Directory. - -### [Set-ADComputer](./Set-ADComputer.md) -Modifies an Active Directory computer object. - -### [Set-ADDefaultDomainPasswordPolicy](./Set-ADDefaultDomainPasswordPolicy.md) -Modifies the default password policy for an Active Directory domain. - -### [Set-ADDomain](./Set-ADDomain.md) -Modifies an Active Directory domain. - -### [Set-ADDomainMode](./Set-ADDomainMode.md) -Sets the domain mode for an Active Directory domain. - -### [Set-ADFineGrainedPasswordPolicy](./Set-ADFineGrainedPasswordPolicy.md) -Modifies an Active Directory fine grained password policy. - -### [Set-ADForest](./Set-ADForest.md) -Modifies an Active Directory forest. - -### [Set-ADForestMode](./Set-ADForestMode.md) -Sets the forest mode for an Active Directory forest. - -### [Set-ADGroup](./Set-ADGroup.md) -Modifies an Active Directory group. - -### [Set-ADObject](./Set-ADObject.md) -Modifies an Active Directory object. - -### [Set-ADOrganizationalUnit](./Set-ADOrganizationalUnit.md) -Modifies an Active Directory organizational unit. - -### [Set-ADReplicationConnection](./Set-ADReplicationConnection.md) -Sets properties on Active Directory replication connections. - -### [Set-ADReplicationSite](./Set-ADReplicationSite.md) -Sets the replication properties for an Active Directory site. - -### [Set-ADReplicationSiteLink](./Set-ADReplicationSiteLink.md) -Sets the properties for an Active Directory site link. - -### [Set-ADReplicationSiteLinkBridge](./Set-ADReplicationSiteLinkBridge.md) -Sets the properties of a replication site link bridge in Active Directory. - -### [Set-ADReplicationSubnet](./Set-ADReplicationSubnet.md) -Sets the properties of an Active Directory replication subnet object. - -### [Set-ADResourceProperty](./Set-ADResourceProperty.md) -Modifies a resource property in Active Directory. - -### [Set-ADResourcePropertyList](./Set-ADResourcePropertyList.md) -Modifies a resource property list in Active Directory. - -### [Set-ADServiceAccount](./Set-ADServiceAccount.md) -Modifies an Active Directory managed service account or group managed service account object. - -### [Set-ADUser](./Set-ADUser.md) -Modifies an Active Directory user. - -### [Sync-ADObject](./Sync-ADObject.md) -Replicates a single object between any two domain controllers that have partitions in common. - -### [Test-ADServiceAccount](./Test-ADServiceAccount.md) -Tests a managed service account from a computer. - -### [Uninstall-ADServiceAccount](./Uninstall-ADServiceAccount.md) -Uninstalls an Active Directory managed service account from a computer or removes a cached group managed service account from a computer. - -### [Unlock-ADAccount](./Unlock-ADAccount.md) -Unlocks an Active Directory account. - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADCentralAccessPolicyMember.md b/docset/winserver2012-ps/activedirectory/Add-ADCentralAccessPolicyMember.md deleted file mode 100644 index 086f02df51..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADCentralAccessPolicyMember.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-adcentralaccesspolicymember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADCentralAccessPolicyMember - -## SYNOPSIS -Adds central access rules to a central access policy in Active Directory. - -## SYNTAX - -``` -Add-ADCentralAccessPolicyMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Add-ADCentralAccessPolicyMember cmdlet adds central access rules to a central access policy in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADCentralAccessPolicyMember "Finance Policy" -Member "Finance Documents Rule","Corporate Documents Rule" -``` - -Description - ------------ - -Adds the central access rules 'Finance Documents Rule' and 'Corporate Documents Rule' to the central access policy 'Finance Policy'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Add-ADCentralAccessPolicyMember - -cmdlet Add-ADCentralAccessPolicyMember at command pipeline position 1 -Supply values for the following parameters: -Identity: Finance Policy -Members[0]: Finance Documents Rule -Members[1]: Corporate Documents Rule -Members[2]: -``` - -Description - ------------ - -Demonstrates default behavior for this cmdlet (no parameters specified). -Adds central access rules 'Finance Documents Rule' and 'Corporate Documents Rule' to the central access policy 'Finance Policy'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy -Filter "Name -like 'Corporate*'" | Add-ADCentralAccessPolicyMember -Members "Corporate Documents Rule" -``` - -Description - ------------ - -Gets all central access policies that have a name that starts with "Corporate" and then pipes it to Add-ADCentralAccessPolicyMember, which then adds the central access rule with the name 'Corporate Documents Rule' to it. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Documents Policy,CN=Central Access Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Members -Specifies a set of central access rule (CAR) objects in a comma-separated list to add to a central access policy (CAP). -To identify each object, use one of the following property values. -Note: The identifier in parentheses is the LDAP display name. - -Name - -Example: Finance Documents Rule - -Distinguished Name - -Example: CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -You can also provide objects to this parameter directly. - -The following examples show how to specify this parameter. - -This example specifies two CARs to add by specifying the distinguished name and the name properties. - --Members "CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com", "Corporate Documents Rule" - -This example specifies two CARs that are defined in the current Windows PowerShell session as input for the parameter. - --Members $carObject, $carObject2 - -You cannot pass objects through the pipeline to this parameter. - -```yaml -Type: ADCentralAccessRule[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -A ADCentralAccessPolicy object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.ADCentralAccessPolicy -Returns the modified ADCentralAccessPolicy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADComputerServiceAccount.md b/docset/winserver2012-ps/activedirectory/Add-ADComputerServiceAccount.md deleted file mode 100644 index ebd12d7b49..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADComputerServiceAccount.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-adcomputerserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADComputerServiceAccount - -## SYNOPSIS -Adds one or more service accounts to an Active Directory computer. - -## SYNTAX - -``` -Add-ADComputerServiceAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] - [-ServiceAccount] [] -``` - -## DESCRIPTION -The Add-ADComputerServiceAccount cmdlet adds one or more computer service accounts to an Active Directory computer. - -The Computer parameter specifies the Active Directory computer that will host the new service accounts. -You can identify a computer by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the Computer parameter to a computer object variable, such as $\, or pass a computer object through the pipeline to the Computer parameter. -For example, you can use the Get-ADComputer cmdlet to retrieve a computer object and then pass the object through the pipeline to the Add-ADComputerServiceAccount cmdlet. - -The ServiceAccount parameter specifies the service accounts to add. -You can identify a service account by its distinguished name (DN), GUID, Security Identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify service account object variables, such as $\. -If you are specifying more than one account, use a comma-separated list. - -Note: Adding a service account is a different operation than installing the service account locally. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADComputerServiceAccount -Computer ComputerAcct1 -serviceAccount SvcAcct1 -``` - -Description - ------------ - -Add the service account 'SvcAcct1' to a Computer Account 'ComputerAcct1' - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Add-ADComputerServiceAccount -Computer ComputerAcct1 -serviceAccount SvcAcct1,SvcAcct2 -``` - -Description - ------------ - -Add 2 service accounts 'SvcAcct1,SvcAcct2' to a Computer Account 'ComputerAcct1'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager Account Name (sAMAccountName) - -Example: SaraDavisDesktop - -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a DN, the partition to search will be computed from that DN. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a computer object instance named "computerInstance". - --Identity $computerInstance - -```yaml -Type: ADComputer -Parameter Sets: (All) -Aliases: Computer - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccount -Specifies one or more Active Directory service accounts. -You can identify a service account by using one of the following property values: - -Distinguished Name - -Example: CN=serviceadmin,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: serviceadmin - -The following example shows how to specify a service account for this parameter using the SAM Account Name. - --ServiceAccount "serviceAdminEurope" - -```yaml -Type: ADServiceAccount[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the Computer parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -Returns the modified computer object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADComputerServiceAccount](./Get-ADComputerServiceAccount.md) - -[Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md b/docset/winserver2012-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md deleted file mode 100644 index a028f9d161..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADDomainControllerPasswordReplicationPolicy.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-addomaincontrollerpasswordreplicationpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADDomainControllerPasswordReplicationPolicy - -## SYNOPSIS -Adds users, computers, and groups to the allowed or denied list of a read-only domain controller password replication policy. - -## SYNTAX - -### AllowedPRP -``` -Add-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] -AllowedList - [-AuthType ] [-Credential ] [[-Identity] ] [-Server ] - [] -``` - -### DeniedPRP -``` -Add-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] -DeniedList [[-Identity] ] [-Server ] - [] -``` - -## DESCRIPTION -The **Add-ADDomainControllerPasswordReplicationPolicy** cmdlet adds one or more users, computers, and groups to the allowed or denied list of a read-only domain controller (RODC) password replication policy. - -The *Identity* parameter specifies the read-only domain controller (RODC) that uses the allowed and denied lists to apply the password replication policy. -You can identify a domain controller by its GUID, IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the name of the server object that represents the domain controller, the distinguished name of the NTDS settings object of the server object, the GUID of the NTDS settings object of the server object under the configuration partition, or the distinguished name of the computer object that represents the domain controller. -You can also set the *Identity* parameter to a domain controller object variable, such as `$`, or pass a domain controller object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADDomainController** cmdlet to get a domain controller object and then pass the object through the pipeline to the **Add-ADDomainControllerPasswordReplicationPolicy** cmdlet. -You must specify a read-only domain controller. -If you specify a writeable domain controller for this parameter, the cmdlet returns a non-terminating error. - -The *AllowedList* parameter specifies the users, computers, and groups to add to the allowed list. -Similarly, the *DeniedList* parameter specifies the users, computers, and groups to add to the denied list. -You must specify either one or both of the *AllowedList* and *DeniedList* parameters. -You can identify a user, computer, or group by distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify user, computer, or group variables, such as `$`. -If you are specifying more than one item, use a comma-separated list. -If a specified user, computer, or group is not on the allowed or denied list, the cmdlet does not return an error. - -## EXAMPLES - -### Example 1: Add user accounts with specified SamAccountNames to the allowed list- -``` -C:\PS>Add-ADDomainControllerPasswordReplicationPolicy -Identity "FABRIKAM-RODC1" -AllowedList "JesperAaberg", "AdrianaAdams" -``` - -This command adds user accounts with the specified SamAccountNames to the Allowed list on the RODC specified by the *Identity* parameter. - -### Example 2: Add user accounts with specified SamAccountNames to the denied list -``` -C:\PS>Add-ADDomainControllerPasswordReplicationPolicy -Identity "FABRIKAM-RODC1" -DeniedList "MichaelAllen", "ElizabethAndersen" -``` - -This command adds user accounts with the specified SamAccountNames to the Denied list on the RODC specified by the *Identity* parameter. - -## PARAMETERS - -### -AllowedList -Specifies the users, computers, groups or other accounts to add to the list of accounts allowed to replicate their passwords to this RODC. -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Accounts Manager (SAM) account name (sAMAccountName) - -```yaml -Type: ADPrincipal[] -Parameter Sets: AllowedPRP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -Specifies the credentials for the security context under which the task is performed. -If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory. -If running under the context of an Active Directory module for Window PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the currently logged on user security context is used. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeniedList -Specifies the users, computers, groups or other accounts to add to the list of accounts that are denied the right to replicate their passwords to this RODC. -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -```yaml -Type: ADPrincipal[] -Parameter Sets: DeniedPRP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain controller object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: - -- A GUID (objectGUID) -- An IPV4Address -- A Global IPV6Address -- A DNS Host Name (dNSHostName) -- A name of the server object -- A distinguished name of the NTDS Settings object -- A distinguished name of the server object that represents the domain controller -- A GUID of NTDS settings object under the configuration partition -- A GUID of server object under the configuration partition -- A distinguished name of the computer object that represents the domain controller - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADDomainController -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer that runs Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDomainController -An RODC object is received by the *Identity* parameter. - -## OUTPUTS - -### None. - -## NOTES -* This cmdlet does not work with Active Directory Lightweight Directory Services. -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. - -## RELATED LINKS - -[Get-ADDomainController](./Get-ADDomainController.md) - -[Get-ADDomainControllerPasswordReplicationPolicy](./Get-ADDomainControllerPasswordReplicationPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md b/docset/winserver2012-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md deleted file mode 100644 index 391ec0f8cf..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADFineGrainedPasswordPolicySubject.md +++ /dev/null @@ -1,394 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-adfinegrainedpasswordpolicysubject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADFineGrainedPasswordPolicySubject - -## SYNOPSIS -Applies a fine-grained password policy to one more users and groups. - -## SYNTAX - -``` -Add-ADFineGrainedPasswordPolicySubject [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] [-Identity] [-Partition ] [-PassThru] - [-Server ] [-Subjects] [] -``` - -## DESCRIPTION -The Add-ADFineGrainedPasswordPolicySubject cmdlet applies a fine-grained password policy to one or more global security groups and users. - -The Identity parameter specifies the fine-grained password policy to apply. -You can identify a fine-grained password policy by its distinguished name, GUID or name. -You can also set the Identity parameter to a fine-grained password policy object variable, such as $\, or pass a fine-grained password policy object through the pipeline to the Identity parameter. -For example, you can use the Get-ADFineGrainedPasswordPolicy cmdlet to get a fine-grained password policy object and then pass the object through the pipeline to the Add-ADFineGrainedPasswordPolicySubject cmdlet. - -The Subjects parameter specifies the users and global security groups. -You can identify a user or global security group by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify user and global security group object variables, such as $\. -If you are specifying more than one user or group, use a comma-separated list. -To pass user and global security group objects through the pipeline to the Subjects parameter, use the Get-ADUser or the Get-ADGroup cmdlets to retrieve the user or group objects, and then pass these objects through the pipeline to the Add-ADFineGrainedPasswordPolicySubject cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADFineGrainedPasswordPolicySubject DomainUsersPSO -Subjects 'Domain Users' -``` - -Description - ------------ - -Apply the Fine-Grained Password Policy named DomainUsersPSO to a Global Security Group 'Domain Users'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Add-ADFineGrainedPasswordPolicySubject DlgtdAdminsPSO -Subjects BobKe,KimAb -``` - -Description - ------------ - -Apply the Fine-Grained Password Policy named DlgtdAdminsPSO to two users, with SamAccountNames BobKe and KimAb. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Add-ADFineGrainedPasswordPolicySubject DlgtdAdminsPSO -Subjects DlgtdAdminGroup -``` - -Description - ------------ - -Apply the Fine-Grained Password Policy named DlgtdAdminsPSO to the group DlgtdAdminGroup. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADGroup -Filter "lastname -eq 'John'" | Add-ADFineGrainedPasswordPolicySubject DlgtdAdminsPSO -``` - -Description - ------------ - -Apply the Fine-Grained Password Policy named DlgtdAdminsPSO to any users whose last names is John. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name (distinguishedName) - -Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: PasswordPolicyLevel1 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a fine-grained password policy object instance named "fineGrainedPasswordPolicyInstance". - --Identity $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subjects -Specifies one or more users or groups. -To specify more than one user or group, use a comma-separated list. -You can identify a user or group by one of the following property values. - -Distinguished Name (DN) - -Example: CN=SaraDavis,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -Note: The identifier in parentheses is the LDAP display name for the attribute. - -You can also provide objects to this parameter directly. - -The following example shows how to set this parameter to a list of users and groups by using a distinguished name and SAM account names. - --Subjects "CN=SaraDavis, CN=Users,DC=corp,DC=contoso,DC=com","donhall","saradavisreports" - -```yaml -Type: ADPrincipal[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy, Microsoft.ActiveDirectory.Management.ADPrincipal -A fine-grained password policy object is received by the Identity parameter. -One or more principal objects that represent users and security group objects are received by the Subjects parameter. -Derived principal types, such as the following are also accepted by the Subjects parameter: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -Returns the modified fine-grained password policy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADGroupMember.md b/docset/winserver2012-ps/activedirectory/Add-ADGroupMember.md deleted file mode 100644 index 9338b1a427..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADGroupMember.md +++ /dev/null @@ -1,435 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-adgroupmember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADGroupMember - -## SYNOPSIS -Adds one or more members to an Active Directory group. - -## SYNTAX - -``` -Add-ADGroupMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-Partition ] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Add-ADGroupMember cmdlet adds one or more users, groups, service accounts, or computers as new members of an Active Directory group. - -The Identity parameter specifies the Active Directory group that receives the new members. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify group object variable, such as $\, or pass a group object through the pipeline to the Identity parameter. -For example, you can use the Get-ADGroup cmdlet to get a group object and then pass the object through the pipeline to the Add-ADGroupMember cmdlet. - -The Members parameter specifies the new members to add to a group. -You can identify a new member by its distinguished name (DN), GUID, security identifier (SID) or SAM account name. -You can also specify user, computer, and group object variables, such as $\. -If you are specifying more than one new member, use a comma-separated list. -You cannot pass user, computer, or group objects through the pipeline to this cmdlet. -To add user, computer, or group objects to a group by using the pipeline, use the Add-ADPrincipalGroupMembership cmdlet. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADGroupMember SvcAccPSOGroup SQL01,SQL02 -``` - -Description - ------------ - -Adds the user accounts with SamAccountNames SQL01,SQL02 to the group SvcAccPSOGroup. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Add-ADGroupMember - -cmdlet Add-ADGroupMember at command pipeline position 1 -Supply values for the following parameters: -Identity: RodcAdmins -Members[0]: JohnSmith -Members[1]: JeffPrice -Members[2]: -``` - -Description - ------------ - -Demonstrates default behavior for this cmdlet (no parameters specified). -Adds user accounts with SamAccountNames JohnSmith and JeffPrice to the group RodcAdmins. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADGroup -Server localhost:60000 -SearchBase "OU=AccountDeptOU,DC=AppNC" -filter "name -like 'AccountLeads'" | Add-ADGroupMember -Members "CN=SanjayPatel,OU=AccountDeptOU,DC=AppNC" -``` - -Description - ------------ - -Gets a group from the Organizational Unit "OU=AccountDeptOU,DC=AppNC" in the AD LDS instance localhost:60000 that has the name "AccountLeads" and then pipes it to Add-ADGroupMember, which then adds the user account with DistinguishedName "CN=SanjayPatel,OU=AccountDeptOU,DC=AppNC" to it. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$user = Get-ADUser "CN=Glen John,OU=UserAccounts,DC=NORTHAMERICA,DC=FABRIKAM,DC=COM" -Server "northamerica.fabrikam.com"; -$group = Get-ADGroup "CN=AccountLeads,OU=UserAccounts,DC=EUROPE,DC=FABRIKAM,DC=COM" -Server "europe.fabrikam.com"; -Add-ADGroupMember $group -Members $user -Server "europe.fabrikam.com" -``` - -Description - ------------ - -Adds the user "CN=Glen John,OU=UserAccounts" from the North America domain to the group "CN=AccountLeads,OU=UserAccounts" in the Europe domain. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a group object instance named "ADGroupInstance". - --Identity $ADGroupInstance - -```yaml -Type: ADGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Members -Specifies a set of user, group, and computer objects in a comma-separated list to add to a group. -To identify each object, use one of the following property values. -Note: The identifier in parentheses is the LDAP display name. - -Distinguished Name - -Example: CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -You can also provide objects to this parameter directly. - -The following examples show how to specify this parameter. - -This example specifies a user and group to add by specifying the distinguished name and the SAM Account Name properties. - --Members "CN=SaraDavis,CN=employees,CN=Users,DC=contoso,DC=com", "saradavisreports" - -This example specifies a user and a group object that are defined in the current Windows PowerShell session as input for the parameter. - --Members $userObject, $groupObject - -The objects specified for this parameter are processed as Microsoft.ActiveDirectory.Management.ADPrincipal objects. -Derived types, such as the following are also received by this parameter. - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADGroup - -You cannot pass objects through the pipeline to this parameter. - -```yaml -Type: ADPrincipal[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -Returns the modified group object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet will allow you to add a group as a member of itself which could lead to unstable behavior. - -## RELATED LINKS - -[Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - -[Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADPrincipalGroupMembership.md b/docset/winserver2012-ps/activedirectory/Add-ADPrincipalGroupMembership.md deleted file mode 100644 index e8e37255b5..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADPrincipalGroupMembership.md +++ /dev/null @@ -1,436 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-adprincipalgroupmembership?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADPrincipalGroupMembership - -## SYNOPSIS -Adds a member to one or more Active Directory groups. - -## SYNTAX - -``` -Add-ADPrincipalGroupMembership [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-MemberOf] [-Partition ] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Add-ADPrincipalGroupMembership cmdlet adds a user, group, service account, or computer as a new member to one or more Active Directory groups. - -The Identity parameter specifies the new user, computer, or group to add. -You can identify the user, group, or computer by its distinguished name (DN), GUID, security identifier (SID), or SAM account name. -You can also specify a user, group, or computer object variable, such as $\, or pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADGroup cmdlet to get a group object and then pass the object through the pipeline to the Add-ADPrincipalGroupMembership cmdlet. -Similarly, you can use Get-ADUser or Get-ADComputer to get user and computer objects to pass through the pipeline. - -This cmdlet collects all of the user, computer and group objects from the pipeline, and then adds these objects to the specified group by using one Active Directory operation. - -The MemberOf parameter specifies the groups that receive the new member. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also specify group object variable, such as $\. -To specify more than one group, use a comma-separated list. -You cannot pass group objects through the pipeline to the MemberOf parameter. -To add to a group by passing the group through the pipeline, use the Add-ADGroupMember cmdlet. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADPrincipalGroupMembership -Identity SQLAdmin1 -MemberOf DlgtdAdminsPSOGroup -``` - -Description - ------------ - -Adds the user with SamAccountName "SQLAdmin1" to the group "DlgtdAdminsPSOGroup". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADUser -Filter 'Name -like "*SvcAccount*"' | Add-ADPrincipalGroupMembership -MemberOf SvcAccPSOGroup -``` - -Description - ------------ - -Gets all users with "SvcAccount" in their name and adds it to the group "SvcAccPSOGroup". - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Add-ADPrincipalGroupMembership - -cmdlet Add-ADPrincipalGroupMembership at command pipeline position 1 -Supply values for the following parameters: -Identity: JeffPrice -MemberOf[0]: RodcAdmins -MemberOf[1]: Allowed RODC Password Replication Group -MemberOf[2]: -``` - -Description - ------------ - -Demonstrates the default behavior of this cmdlet (no parameters specified). - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADUser -Server localhost:60000 -SearchBase "DC=AppNC" -filter "Title -eq 'Account Lead' -and Office -eq 'Branch1'" | Add-ADPrincipalGroupMembership -MemberOf "CN=AccountLeads,OU=AccountDeptOU,DC=AppNC" -``` - -Description - ------------ - -Adds all employees in "Branch1" in the AD LDS instance "localhost:60000" whose title is "Account Lead" to the group with the DistinguishedName "CN=AccountLeads,OU=AccountDeptOU,DC=AppNC". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory principal object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -- Microsoft.ActiveDirectory.Management.ADGroup -- Microsoft.ActiveDirectory.Management.ADUser -- Microsoft.ActiveDirectory.Management.ADComputer -- Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a principal object instance named "principalInstance". - --Identity $principalInstance - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MemberOf -Specifies the Active Directory groups to add a user, computer, or group to as a member. -You can identify a group by providing one of the following values. -Note: The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,CN=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -If you are specifying more than one group, use commas to separate the groups in the list. - -The following example shows how to specify this parameter by using SAM account name values. - --MemberOf "SaraDavisGroup", "JohnSmithGroup" - -```yaml -Type: ADGroup[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADPrincipal -A principal object (Microsoft.ActiveDirectory.Management.ADPrincipal) that represents a user, computer or group is received by the Identity parameter. -Derived types, such as the following are also received by this parameter. - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADGroup - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADPrincipal -Returns a principal object that represents the modified user, computer or group object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) - -[Get-ADUser](./Get-ADUser.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - -[Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - diff --git a/docset/winserver2012-ps/activedirectory/Add-ADResourcePropertyListMember.md b/docset/winserver2012-ps/activedirectory/Add-ADResourcePropertyListMember.md deleted file mode 100644 index 21a24ab122..0000000000 --- a/docset/winserver2012-ps/activedirectory/Add-ADResourcePropertyListMember.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/add-adresourcepropertylistmember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADResourcePropertyListMember - -## SYNOPSIS -Adds one or more resource properties to a resource property list in Active Directory. - -## SYNTAX - -``` -Add-ADResourcePropertyListMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Add-ADResourcePropertyListMember adds one or more resource properties to a resource property list in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADResourcePropertyListMember "Global Resource Property List" -Members Country,Authors -``` - -Description - ------------ - -Adds the resource properties named "Country" and "Authors" to the global resource property list. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Add-ADResourcePropertyListMember - -cmdlet Add-ADResourcePropertyListMember at command pipeline position 1 -Supply values for the following parameters: -Identity: Corporate Resource Property List -Members[0]: Country -Members[1]: Authors -Members[2]: -``` - -Description - ------------ - -Demonstrates default behavior for this cmdlet (no parameters specified). -Adds the resource properties named "Country" and "Authors" to the resource property list named "Corporate Resource Property List". - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList -Filter "Name -like 'Corporate*'" | Add-ADResourcePropertyListMember -Members Country,Authors -``` - -Description - ------------ - -Gets any resource property list that has a name that begins with "Corporate" and then pipes it to Add-ADResourcePropertyListMember, which then adds the resource properties with the name 'Country' and 'Authors' to it. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourcePropertyList -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Members -Specifies a set of ADResourceProperty objects in a comma-separated list to add to a resource property list. -To identify each object, use one of the following property values. -Note: The identifier in parentheses is the LDAP display name. - -Name - -Example: Country - -Distinguished Name - -Example: CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -You can also provide objects to this parameter directly. - -The following examples show how to specify this parameter. - -This example specifies two resource properties to add by specifying the distinguished name and the name properties. - --Members "CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com", "Authors" - -This example specifies two resource property objects that are defined in the current Windows PowerShell session as input for the parameter. - --Members $rpObject1, $rpObject2 - -You cannot pass objects through the pipeline to this parameter. - -```yaml -Type: ADResourceProperty[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTypeList -A ADClaimTypeList object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTypeList -Returns the modified ADClaimTypeList object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Clear-ADAccountExpiration.md b/docset/winserver2012-ps/activedirectory/Clear-ADAccountExpiration.md deleted file mode 100644 index 43f879751b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Clear-ADAccountExpiration.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/clear-adaccountexpiration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-ADAccountExpiration - -## SYNOPSIS -Clears the expiration date for an Active Directory account. - -## SYNTAX - -``` -Clear-ADAccountExpiration [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Clear-ADAccountExpiration cmdlet clears the expiration date for an Active Directory user or computer account. -When you clear the expiration date for an account, the account does not expire. - -The Identity parameter specifies the user or computer account to modify. -You can identify a user or group by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to a user or computer object variable, such as $\, or pass a user or computer object through the pipeline to the Identity parameter. -For example, you can use the Get-ADUser, Get-ADComputer or Search-ADAccount cmdlet to retrieve an object and then pass the object through the pipeline to the Clear-ADAccountExpiration cmdlet. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Clear-ADAccountExpiration -Identity JeffPrice -``` - -Description - ------------ - -Clears the account expiration date for the user with SamAccountName: JeffPrice. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Clear-ADAccountExpiration -Identity "CN=JeffPrice,DC=AppNC" -server "FABRIKAM-SVR1:60000" -``` - -Description - ------------ - -Clears the account expiration date for the user with DistinguishedName: "CN=JeffPrice,DC=AppNC" on the AD LDS instance: "FABRIKAM-SVR1:60000". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object (Microsoft.ActiveDirectory.Management.ADAccount) is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Search-ADAccount](./Search-ADAccount.md) - -[Set-ADAccountExpiration](./Set-ADAccountExpiration.md) - -[Get-ADUser](./Get-ADUser.md) - -[Get-ADComputer](./Get-ADComputer.md) - diff --git a/docset/winserver2012-ps/activedirectory/Clear-ADClaimTransformLink.md b/docset/winserver2012-ps/activedirectory/Clear-ADClaimTransformLink.md deleted file mode 100644 index 241745305f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Clear-ADClaimTransformLink.md +++ /dev/null @@ -1,303 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/clear-adclaimtransformlink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-ADClaimTransformLink - -## SYNOPSIS -Removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory. - -## SYNTAX - -``` -Clear-ADClaimTransformLink [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Policy ] [-Server ] - [-TrustRole ] [] -``` - -## DESCRIPTION -The Clear-ADClaimTransformLink cmdlet removes a claims transformation from being applied to one or more cross-forest trust relationships in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Clear-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -``` - -Description - ------------ - -Remove the policy named 'DenyAllPolicy' from the 'corp.contoso.com' trust. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Clear-ADClaimTransformLink "corp.contoso.com" -TrustRole Trusted -``` - -Description - ------------ - -Remove any policies that are applied to where this forest acts as the trusted forest in the "corp.contoso.com" trust. -Effectively, this cmdlet removes any policies that are applied to claims flowing out of this forest towards it trust partner. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Clear-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusting -``` - -Description - ------------ - -Remove "DenyAllPolicy" that is applied to where this forest acts as the trusted domain in the "corp.contoso.com" trust. -Effectively, this cmdlet removes "DenyAllPolicy" from applying to claims coming into this from its trust partner. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory trust object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=fabrikam.com,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to a group object instance named "ADTrustInstance". - --Identity $ADTrustInstance - -```yaml -Type: ADTrust -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Removes the specified claim transformation policy from being applied to the trust relationship. - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustRole -Specifies the role of the current forest in the trust relationship specified by the Identity parameter. -The allowable values for this parameter are as follows: - -- Trusted (specify this value if the current forest is the trusted forest) -- Trusting (specify this value if the current forest is the trusting forest) - -```yaml -Type: ADTrustRole -Parameter Sets: (All) -Aliases: -Accepted values: Trusted, Trusting - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADTrust -An account object (Microsoft.ActiveDirectory.Management.ADTrust) is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Disable-ADAccount.md b/docset/winserver2012-ps/activedirectory/Disable-ADAccount.md deleted file mode 100644 index f9d635fa29..0000000000 --- a/docset/winserver2012-ps/activedirectory/Disable-ADAccount.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/disable-adaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-ADAccount - -## SYNOPSIS -Disables an Active Directory account. - -## SYNTAX - -``` -Disable-ADAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Disable-ADAccount cmdlet disables an Active Directory user, computer, or service account. - -The Identity parameter specifies the Active Directory user, computer service account, or other service account that you want to disable. -You can identify an account by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an account object through the pipeline to the Identity parameter. -For example, you can use the Get-ADUser cmdlet to retrieve a user account object and then pass the object through the pipeline to the Disable-Account cmdlet. -Similarly, you can use Get-ADComputer and Search-ADAccount to retrieve account objects. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Disable-ADAccount -Identity KimAb -``` - -Description - ------------ - -Disables the account with SamAccountName: KimAB. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Disable-ADAccount -Identity "CN=Kim Abercrombie,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Disables the account with DistinguishedName: "CN=Kim Abercrombie,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM". - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADUser -Filter 'Name -like "*"' -SearchBase "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" | Disable-ADAccount -``` - -Description - ------------ - -Disables all accounts in the OU: "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Clear-ADAccountExpiration](./Clear-ADAccountExpiration.md) - -[Enable-ADAccount](./Enable-ADAccount.md) - -[Get-ADAccountAuthorizationGroup](./Get-ADAccountAuthorizationGroup.md) - -[Search-ADAccount](./Search-ADAccount.md) - -[Set-ADAccountControl](./Set-ADAccountControl.md) - -[Set-ADAccountExpiration](./Set-ADAccountExpiration.md) - -[Set-ADAccountPassword](./Set-ADAccountPassword.md) - -[Unlock-ADAccount](./Unlock-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Disable-ADOptionalFeature.md b/docset/winserver2012-ps/activedirectory/Disable-ADOptionalFeature.md deleted file mode 100644 index d90dd54136..0000000000 --- a/docset/winserver2012-ps/activedirectory/Disable-ADOptionalFeature.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/disable-adoptionalfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-ADOptionalFeature - -## SYNOPSIS -Disables an Active Directory optional feature. - -## SYNTAX - -``` -Disable-ADOptionalFeature [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Scope] [-Server ] - [-Target] [] -``` - -## DESCRIPTION -The Disable-ADOptionalFeature disables an Active Directory optional feature that is associated with a particular Domain Mode or Forest Mode. - -The Identity parameter specifies the Active Directory optional feature that you want to disable. -You can identify an optional feature by its distinguished name (DN), feature GUID, or object GUID. -You can also set the parameter to an optional feature object variable, such as $\ or you can pass an optional feature object through the pipeline to the Identity parameter. -For example, you can use the Get-ADOptionalFeature cmdlet to retrieve an optional feature object and then pass the object through the pipeline to the Disable-ADOptionalFeature cmdlet. - -The Scope parameter specifies the scope at which the optional feature is disabled. -Possible values for this parameter are Domain and Forest. - -The Target parameter specifies the domain or forest on which the optional feature is disabled. -You can identify the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or the distinguished name (DN) of the domain naming context (domain NC). - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Disable-ADOptionalFeature 'Feature 1' -Scope ForestOrConfigurationSet -Target 'fabrikam' -Server DC1 -``` - -Description - ------------ - -Disable the optional feature (name 'Feature 1') for the forest (NetBIOS name 'fabrikam'). -This operation should be performed against the DC that holds the naming master FSMO role. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Disable-ADOptionalFeature -Identity 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com' -Scope ForestOrConfigurationSet -Target 'fabrikam.com' -Server DC1 -``` - -Description - ------------ - -Disable the optional feature (dn 'CN=Feature 1,CN=Optional Features,CN=Directory Service,CN=Windows NT,CN=Services,CN=Configuration,DC=fabrikam,DC=com') for the forest (FQDN name 'fabrikam.com'). -This operation should be performed against the DC that holds the naming master FSMO role. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Disable-ADOptionalFeature -Identity '54ec6e43-75a8-445b-aa7b-346a1e096659' -Scope Domain -Target 'DC=fabrikam,DC=com' -Server DC1 -``` - -Description - ------------ - -Disable the optional feature (feature GUID '54ec6e43-75a8-445b-aa7b-346a1e096659') for the domain (dn 'DC=ntdev,DC=fabrikam,DC=com'). -This operation should be performed against the DC that holds the naming master FSMO role. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Disable-ADOptionalFeature 'Feature 1' -Scope ForestOrConfigurationSet -Target 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' -server server1:50000 -``` - -Description - ------------ - -Disable the optional feature (name 'Feature 1') for the AD LDS instance (dn 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}'). -This operation should be performed against the AD LDS instance that holds the naming master FSMO role. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory optional feature object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Fully qualified domain name - -Example: corp.contoso.com - -Feature GUID (featureGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Object GUID (objectGUID) - -Example: 482ab21c-823e-401e-879a-ac7383d64eb9 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an optional feature object instance. - -This example shows how to set the parameter to a fully qualified domain name. - --Identity "corp.contoso.com" - -This example shows how to set this parameter to an optional feature object instance named "optionalFeatureInstance". - --Identity $optionalFeatureInstance - -```yaml -Type: ADOptionalFeature -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the feature is enabled or disabled. -Possible values for this parameter include: - -Domain or 0 - -Forest or 1 - -The following example shows how to set this parameter so that optional features are enabled or disabled within the scope of the forest. - --Scope Forest - -```yaml -Type: ADOptionalFeatureScope -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, ForestOrConfigurationSet, Domain - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the domain or forest in which to modify the optional feature. -You can identify the target domain or forest by providing one of the following values: - -Fully-qualified domain name of the forest or domain - -Example: corp.Fabrikam.com - -NetBIOS name of the forest or domain - -Example: corp - -Distinguished name of the domain naming context (domain NC) - -Example: DC=corp,DC=Fabrikam,DC=com - -The following example shows how to set this parameter to a domain NC. - --Target "DC=corp,DC=Fabrikam,DC=com" - -```yaml -Type: ADEntity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADOptionalFeature -An optional feature object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Enable-ADOptionalFeature](./Enable-ADOptionalFeature.md) - -[Get-ADOptionalFeature](./Get-ADOptionalFeature.md) - diff --git a/docset/winserver2012-ps/activedirectory/Enable-ADAccount.md b/docset/winserver2012-ps/activedirectory/Enable-ADAccount.md deleted file mode 100644 index 107f344c06..0000000000 --- a/docset/winserver2012-ps/activedirectory/Enable-ADAccount.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/enable-adaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-ADAccount - -## SYNOPSIS -Enables an Active Directory account. - -## SYNTAX - -``` -Enable-ADAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Enable-ADAccount** cmdlet enables an Active Directory user, computer, or service account. - -The *Identity* parameter specifies the Active Directory user, computer or service account that you want to enable. -You can identify an account by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an account object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADUser** cmdlet to retrieve an account object and then pass the object through the pipeline to the **Enable-ADAccount** cmdlet. -Similarly, you can use **Get-ADComputer** and **Search-ADAccount** to retrieve account objects. - -## EXAMPLES - -### Example 1: Enable an account by identity -``` -PS C:\>Enable-ADAccount -Identity "PattiFul" -``` - -This command enables the account with identity SamAccountName PattiFul. - -### Example 2: Enable an account by Distinguished Name -``` -PS C:\>Enable-ADAccount -Identity "CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -This command enables the account with DistinguishedName CN=Patti Fuller,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### Example 3: Enable all accounts in an organizational unit using a filter -``` -PS C:\>Get-ADUser -Filter 'Name -like "*"' -SearchBase "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" | Enable-ADAccount -``` - -This command enables all accounts in the organizational unit: OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- A SAM account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -- **Microsoft.ActiveDirectory.Management.ADUser** -- **Microsoft.ActiveDirectory.Management.ADComputer** -- **Microsoft.ActiveDirectory.Management.ADServiceAccount** - - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value will be used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the **Server** value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the *Identity* parameter. - -Derived types, such as the following, are also accepted: - -- **Microsoft.ActiveDirectory.Management.ADUser** -- **Microsoft.ActiveDirectory.Management.ADComputer** -- **Microsoft.ActiveDirectory.Management.ADServiceAccount** - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Clear-ADAccountExpiration](./Clear-ADAccountExpiration.md) - -[Disable-ADAccount](./Disable-ADAccount.md) - -[Get-ADAccountAuthorizationGroup](./Get-ADAccountAuthorizationGroup.md) - -[Search-ADAccount](./Search-ADAccount.md) - -[Set-ADAccountControl](./Set-ADAccountControl.md) - -[Set-ADAccountExpiration](./Set-ADAccountExpiration.md) - -[Set-ADAccountPassword](./Set-ADAccountPassword.md) - -[Unlock-ADAccount](./Unlock-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Enable-ADOptionalFeature.md b/docset/winserver2012-ps/activedirectory/Enable-ADOptionalFeature.md deleted file mode 100644 index e517279c16..0000000000 --- a/docset/winserver2012-ps/activedirectory/Enable-ADOptionalFeature.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/enable-adoptionalfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-ADOptionalFeature - -## SYNOPSIS -Enables an Active Directory optional feature. - -## SYNTAX - -``` -Enable-ADOptionalFeature [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Scope] [-Server ] - [-Target] [] -``` - -## DESCRIPTION -The Enable-ADOptionalFeature enables an Active Directory optional feature that is associated with a particular Domain mode or Forest mode. -Active Directory optional features that depend on a specified domain mode or Forest mode must be explicitly enabled after the domain mode or forest mode is set. - -The Identity parameter specifies the Active Directory optional feature that you want to enable. -You can identify an optional feature by its distinguished name (DN), feature GUID, or object GUID. -You can also set the parameter to an optional feature object variable, such as $\ or you can pass an optional feature object through the pipeline to the Identity parameter. -For example, you can use the Get-ADOptionalFeature cmdlet to retrieve an optional feature object and then pass the object through the pipeline to the Enable-ADOptionalFeature cmdlet. - -The Scope parameter specifies the scope at which the optional feature will be enabled. -Possible values for this parameter are Domain and Forest. - -The Target parameter specifies the domain or forest on which the optional feature will be enabled. -You can identify the domain or forest by its fully-qualified domain name (FQDN), NetBIOS name, or distinguished name (DN) of the domain naming context (domain NC). - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Enable-ADOptionalFeature 'Recycle Bin Feature' -Scope ForestOrConfigurationSet -Target 'fabrikam.com' -Server dc1 -``` - -Description - ------------ - -Enable the optional feature 'Recycle Bin Feature' for the forest 'fabrikam.com'. -This operation must be performed on the Domain Controller that holds the naming master FSMO role. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Enable-ADOptionalFeature 'Recycle Bin Feature' -Scope ForestOrConfigurationSet -Target 'CN=Configuration,CN={0241853A-6BBF-48AA-8AE0-9C35D0C91B7B}' -Server lds.fabrikam.com:50000 -``` - -Description - ------------ - -Enable the optional feature 'Recycle Bin Feature' for the AD LDS instance lds.fabrikam.com. -This operation must be performed on the AD LDS instance that holds the naming master FSMO role. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory optional feature object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Fully qualified domain name - -Example: corp.contoso.com - -Feature GUID (featureGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Object GUID (objectGUID) - -Example: 482ab21c-823e-401e-879a-ac7383d64eb9 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an optional feature object instance. - -This example shows how to set the parameter to a fully qualified domain name. - --Identity "corp.contoso.com" - -This example shows how to set this parameter to an optional feature object instance named "optionalFeatureInstance". - --Identity $optionalFeatureInstance - -```yaml -Type: ADOptionalFeature -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope at which the feature is enabled or disabled. -Possible values for this parameter include: - -Domain or 0 - -Forest or 1 - -The following example shows how to set this parameter so that optional features are enabled or disabled within the scope of the forest. - --Scope Forest - -```yaml -Type: ADOptionalFeatureScope -Parameter Sets: (All) -Aliases: -Accepted values: Unknown, ForestOrConfigurationSet, Domain - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the domain or forest in which to modify the optional feature. -You can identify the target domain or forest by providing one of the following values: - -Fully-qualified domain name of the forest or domain - -Example: corp.Fabrikam.com - -NetBIOS name of the forest or domain - -Example: corp - -You can also where Scope is set to domain (not forest), use the following: - -Distinguished name (DN) of the domain naming context (domain NC) - -Example: DC=corp,DC=Fabrikam,DC=com - -The following example shows how to set this parameter using a DN to a domain NC when the scope of the command is set to forest level. - --Target "DC=corp,DC=Fabrikam,DC=com" - -```yaml -Type: ADEntity -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADOptionalFeature -An optional feature object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - Recycle Bin Feature: Once the Active Directory Recycle Bin is enabled, all objects deleted before the Active Directory Recycle Bin was enabled (tombstone objects) become recycled objects. -They are no longer visible in the Deleted Objects container and they cannot be recovered using Active Directory Recycle Bin. -The only way to restore these objects is though an authoritative restore from an AD DS backup taken before the Active Directory Recycle Bin was enabled. - -## RELATED LINKS - -[Disable-ADOptionalFeature](./Disable-ADOptionalFeature.md) - -[Get-ADOptionalFeature](./Get-ADOptionalFeature.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADAccountAuthorizationGroup.md b/docset/winserver2012-ps/activedirectory/Get-ADAccountAuthorizationGroup.md deleted file mode 100644 index 38b63cb27d..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADAccountAuthorizationGroup.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adaccountauthorizationgroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADAccountAuthorizationGroup - -## SYNOPSIS -Gets the accounts token group information. - -## SYNTAX - -``` -Get-ADAccountAuthorizationGroup [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADAuthorizationGroup cmdlet gets the security groups from the specified user, computer or service accounts token. -This cmdlet requires a global catalog to perform the group search. -If the forest that contains the account does not have a global catalog, the cmdlet returns a non-terminating error. - -The Identity parameter specifies the user, computer, or service account. -You can identify a user, computer, or service account object by its distinguished name (DN), GUID, security identifier (SID), Security Account Manager (SAM) account name or user principal name. -You can also set the Identity parameter to an account object variable, such as $\, or pass an account object through the pipeline to the Identity parameter. -For example, you can use the Get-ADUser, Get-ADComputer, Get-ADServiceAccount or Search-ADAccount cmdlets to retrieve an account object and then pass the object through the pipeline to the Get-ADAccountAuthorizationGroup cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADAccountAuthorizationGroup GlenJohn - - -GroupScope : DomainLocal -objectGUID : 00000000-0000-0000-0000-000000000000 -GroupCategory : Security -SamAccountName : Everyone -name : Everyone -objectClass : -SID : S-1-1-0 -distinguishedName : - -GroupScope : DomainLocal -objectGUID : 00000000-0000-0000-0000-000000000000 -GroupCategory : Security -SamAccountName : Authenticated Users -name : Authenticated Users -objectClass : -SID : S-1-5-11 -distinguishedName : - -GroupScope : Global -objectGUID : 86c0f0d5-8b4d-4f35-a867-85a006b92902 -GroupCategory : Security -SamAccountName : Domain Users -name : Domain Users -objectClass : group -SID : S-1-5-21-41432690-3719764436-1984117282-513 -distinguishedName : CN=Domain Users,CN=Users,DC=Fabrikam,DC=com - -GroupScope : DomainLocal -objectGUID : 869fb7ad-8cf2-4dd0-ac0f-4bd3bf324669 -GroupCategory : Security -SamAccountName : Pre-Windows 2000 Compatible Access -name : Pre-Windows 2000 Compatible Access -objectClass : group -SID : S-1-5-32-554 -distinguishedName : CN=Pre-Windows 2000 Compatible Access,CN=Builtin,DC=Fabrikam,DC=com - -GroupScope : DomainLocal -objectGUID : c1e397c5-1e44-4270-94d1-88d6c4b78ee6 -GroupCategory : Security -SamAccountName : Users -name : Users -objectClass : group -SID : S-1-5-32-545 -distinguishedName : CN=Users,CN=Builtin,DC=Fabrikam,DC=com -``` - -Description - ------------ - -Returns all security groups for the specified account with SamAccountName: GlenJohn. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADAccountAuthorizationGroup "cn=GlenJohn,dc=AppNC" -Server :50000 - -distinguishedName : CN=AdminGroup,DC=AppNC -GroupCategory : Security -GroupScope : Global -name : AdminGroup -objectClass : group -objectGUID : 4d72873f-fe09-4834-9ada-a905636d10df -SamAccountName : -SID : S-1-510474493-936115905-4021890855-1253703389-3958791574-3542197427 -``` - -Description - ------------ - -Returns all security groups for the specified account with DistinguishedName: "cn=GlenJohn,dc=AppNC" in the AD LDS instance: \:50000. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADAccountAuthorizationGroup -Server :50000 -Identity Administrator | where { $_.objectClass -ne $null } | ft name, objectClass - -name objectClass ----- ----------- -Domain Users group -Administrators group -Users group -Pre-Windows 2000 Compatible Access group -Group Policy Creator Owners group -Domain Admins group -Enterprise Admins group -Schema Admins group -Denied RODC Password Replication Group group -``` - -Description - ------------ - -Returns a filtered list of built-in security groups which do not have an empty or null setting for objectclass (such as Everyone or Authenticated Users). -(Note: This type of filtering of groups in output can be useful when piping the output of this cmdlet to be used as input to other Active Directory cmdlets.) - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object that represents the user, computer or service account is received by the Identity parameter. -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADGroup -Returns group objects that represent the security groups for the account. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Get-ADUser](./Get-ADUser.md) - -[Search-ADAccount](./Search-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md deleted file mode 100644 index d4756f861c..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADAccountResultantPasswordReplicationPolicy.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adaccountresultantpasswordreplicationpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADAccountResultantPasswordReplicationPolicy - -## SYNOPSIS -Gets the resultant password replication policy for an Active Directory account. - -## SYNTAX - -``` -Get-ADAccountResultantPasswordReplicationPolicy [-AuthType ] [-Credential ] - [-DomainController] [-Identity] [-Partition ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADAccountResultantPasswordReplicationPolicy gets the resultant password replication policy for a user, computer or service account on the specified read-only domain controller. - -The policy will be one of the following values: - -Allow or 1 - -DenyExplicit or 0 - -DenyImplicit or 2 - -Unknown or -1 - -The Identity parameter specifies the account. -You can identify a user, computer, or service account object by its distinguished name (DN), GUID, security identifier (SID) or Security Account Manager (SAM) account name. -You can also set the Identity parameter to an account object variable, such as $\, or pass an account object through the pipeline to the Identity parameter. -For example, you can use the Get-ADUser, Get-ADComputer, Get-ADServiceAccount or Search-ADAccount cmdlets to retrieve an account object and then pass the object through the pipeline to the Get-ADAccountResultantPasswordReplicationPolicy cmdlet. - -The DomainController parameter specifies the read-only domain controller. -You can identify a domain controller by its IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the Distinguished Name (DN) of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the DN, SamAccountName, GUID, SID of the computer object that represents the domain controller. -You can also set the DomainController parameter to a domain controller object variable, such as $\. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADAccountResultantPasswordReplicationPolicy BradSu "FABRIKAM-RODC1" -``` - -Description - ------------ - -Get the resultant password replication policy on the domain for a given user account. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADAccountResultantPasswordReplicationPolicy BobKe -DomainController "FABRIKAM-RODC1" -``` - -Description - ------------ - -Get the resultant password replication policy on a specific domain controller for a given user account. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADAccountResultantPasswordReplicationPolicy "CN=Jordao Moreno,OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM" "FABRIKAM-RODC1" -``` - -Description - ------------ - -Get the resultant password replication policy on a specific domain controller for a given user account DN. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies a read-only domain controller (RODC). -The cmdlet returns the password replication policy of the account for this RODC. -You can identify the domain controller by providing one of the following values. - -GUID (objectGUID) - -Example: 768c44de-f72d-66e0-8a88-0523ca495f20 - -IPV4Address - -Example:157.59.132.61 - -Global IPV6Address - -Example: 2001:4898:0:fff:200:5efe:157.59.132.61 - -DNS Host Name (dNSHostName) - -Example: corp-DC01.corp.contoso.com - -Name of the server object - -Example: corp-DC01$ - -Distinguished Name (DN) of the NTDS Settings object - -Example: CN=NTDS Settings,CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso - -Distinguished Name (DN) of the server object that represents the domain controller - -Example: CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID of NTDS settings object under the configuration partition - -Example: 68adaf21-e28d-6012-bca8-320d93450ab0 - -GUID of server object under the configuration partition - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Distinguished Name (DN) of the computer object that represents the domain controller. - -Example: CN=CORP-DC12,OU=Domain Controllers,DC=corp,DC=contoso,DC=com - -Note: The identifier in parentheses is the LDAP display name for the attribute. - -The following example shows how to set this parameter to the DNS host name of a domain controller. - --DomainController "corp-DC01.corp.contoso.com" - -```yaml -Type: ADDomainController -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADResultantPasswordReplicationPolicy -Returns an ADResultantPasswordReplicationPolicy enum value that represents the resultant password replication policy for an account on the specified domain controller. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Get-ADUser](./Get-ADUser.md) - -[Search-ADAccount](./Search-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADCentralAccessPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADCentralAccessPolicy.md deleted file mode 100644 index 1155a634c1..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADCentralAccessPolicy.md +++ /dev/null @@ -1,447 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adcentralaccesspolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADCentralAccessPolicy - -## SYNOPSIS -Retrieves central access policies from Active Directory. - -## SYNTAX - -### Filter (Default) -``` -Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -### Identity -``` -Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADCentralAccessPolicy [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADCentralAccessPolicy cmdlet retrieves central access policies from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy -Filter * -``` - -Description - ------------ - -Retrieves a list of all central access policies. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy -Filter "Members -eq 'Finance Documents Rule'" -``` - -Description - ------------ - -Get the central access policies that have the central access rule 'Finance Documents Rule' as its members. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy "Finance Policy" -``` - -Description - ------------ - -Gets information for a central access policy named "Finance Policy". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Policy,CN=Central Access Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -A ADCentralAccessPolicy object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -Returns one or more ADCentralAccessPolicy objects. - -The Get-ADCentralAccessPolicy cmdlet returns a default set of ADCentralAccessPolicy property values. -To retrieve additional ADCentralAccessPolicy properties, use the Properties parameter of the cmdlet. - -To view the properties for an ADCentralAccessPolicy object, see the following examples. -To run these examples, replace \ with an Active Directory object identifier. - -To get a list of the default set of properties of an ADCentralAccessPolicy object, use the following command: - -Get-ADCentralAccessPolicy \ - -To get a list of all the properties of an ADCentralAccessPolicy object, use the following command: - -Get-ADCentralAccessPolicy \ -Properties * - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADCentralAccessRule.md b/docset/winserver2012-ps/activedirectory/Get-ADCentralAccessRule.md deleted file mode 100644 index 295f597d75..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADCentralAccessRule.md +++ /dev/null @@ -1,445 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adcentralaccessrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADCentralAccessRule - -## SYNOPSIS -Retrieves central access rules from Active Directory. - -## SYNTAX - -### Filter (Default) -``` -Get-ADCentralAccessRule [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -### Identity -``` -Get-ADCentralAccessRule [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADCentralAccessRule [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADCentralAccessRule cmdlet retrieves central access rules from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADCentralAccessRule -Filter * -``` - -Description - ------------ - -Retrieves a list of all central access rules. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADCentralAccessRule -Filter "ResourceCondition -like '*Department*'" -``` - -Description - ------------ - -Retrieve the central access rules that have "Department" in its resource condition. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADCentralAccessRule "Financial Documents Rule" -``` - -Description - ------------ - -Retrieve a central access rule named "Finance Documents Rule". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessRule -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicyEntry -A ADCentralAccessPolicyEntry object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADCentralAccessRule -Returns one or more ADCentralAccessRule objects. - -The Get-ADCentralAccessRule cmdlet returns a default set of ADCentralAccessRule property values. -To retrieve additional ADCentralAccessRule properties, use the Properties parameter of the cmdlet. - -To view the properties for an ADCentralAccessRule object, see the following examples. -To run these examples, replace \ with an Active Directory object identifier. - -To get a list of the default set of properties of an ADCentralAccessRule object, use the following command: - -Get-ADCentralAccessRule \ - -To get a list of all the properties of an ADCentralAccessRule object, use the following command: - -Get-ADCentralAccessRule \ -Properties * - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADClaimTransformPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADClaimTransformPolicy.md deleted file mode 100644 index 76c5ba54f0..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADClaimTransformPolicy.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adclaimtransformpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADClaimTransformPolicy - -## SYNOPSIS -Returns one or more Active Directory claim transform objects based on a specified filter. - -## SYNTAX - -### Filter (Default) -``` -Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] -``` - -### Identity -``` -Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] - [[-Identity] ] [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADClaimTransformPolicy [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADClaimTransformPolicy cmdlet returns one or more Active Directory claim transform objects based on a specified filter. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADClaimTransformPolicy -Filter * -``` - -Description - ------------ - -Retrieves a list of all claims transformation policies. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$contoso = Get-ADTrust "corp.contoso.com"; -Get-ADClaimTransformPolicy -Filter "IncomingTrust -eq '$contoso' -or OutgoingTrust -eq '$contoso'" -``` - -Description - ------------ - -Gets all the claims transformation policies that are applied to trusts made with 'corp.contoso.com'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADClaimTransformPolicy DenyAllPolicy -``` - -Description - ------------ - -Get the claims transformation policy with the name 'DenyAllPolicy' - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADClaimTransformPolicy -LDAPFilter "(name=DenyAll*)" -``` - -Description - ------------ - -Gets information on any claims transformation policies using an LDAP-based query filter that looks for matches where policies have a name that starts with the word "DenyAll". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=DenyAllPolicy,CN=Claims Transformation Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: All Sites (Filter *) -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy -A claim transform policy object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADClaimType.md b/docset/winserver2012-ps/activedirectory/Get-ADClaimType.md deleted file mode 100644 index 095e940603..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADClaimType.md +++ /dev/null @@ -1,441 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adclaimtype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADClaimType - -## SYNOPSIS -Returns a claim type from Active Directory. - -## SYNTAX - -### Filter (Default) -``` -Get-ADClaimType [-AuthType ] [-Credential ] -Filter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-Server ] [] -``` - -### Identity -``` -Get-ADClaimType [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADClaimType [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADClaimType cmdlet returns a claim type defined in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADClaimType -Filter * -``` - -Description - ------------ - -Retrieves a list of all claim types. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADClaimType -Filter "SourceAttribute -eq 'title'" -``` - -Description - ------------ - -Get all the claim types that are sourced from the attribute 'title'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADClaimType "Employee Type" -``` - -Description - ------------ - -Get the claim type with display name 'Employee Type'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADClaimType "Employee Type" -Properties * -``` - -Description - ------------ - -Get all properties of the claim type with display name 'Employee Type'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Employee Type,CN=Claim Types,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADClaimType -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimType - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADClaimType - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADComputer.md b/docset/winserver2012-ps/activedirectory/Get-ADComputer.md deleted file mode 100644 index 327dfd0d32..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADComputer.md +++ /dev/null @@ -1,544 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adcomputer?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADComputer - -## SYNOPSIS -Gets one or more Active Directory computers. - -## SYNTAX - -### Filter (Default) -```powershell -Get-ADComputer [-AuthType ] [-Credential ] -Filter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [] -``` - -### Identity -```powershell -Get-ADComputer [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Properties ] [-Server ] [] -``` - -### LdapFilter -```powershell -Get-ADComputer [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -## DESCRIPTION -The **Get-ADComputer** cmdlet gets a computer or performs a search to retrieve multiple computers. - -The *Identity* parameter specifies the Active Directory computer to retrieve. -You can identify a computer by its distinguished name, GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the parameter to a computer object variable, such as `$` or pass a computer object through the pipeline to the *Identity* parameter. - -To search for and retrieve more than one computer, use the *Filter* or *LDAPFilter* parameters. -The *Filter* parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the *Filter* parameter. -For more information about the *Filter* parameter syntax, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the *LDAPFilter* parameter. - -This cmdlet retrieves a default set of computer object properties. -To retrieve additional properties use the *Properties* parameter. -For more information about the how to determine the properties for computer objects, see the *Properties* parameter description. - -## EXAMPLES - -### Example 1: Get specific computer that shows all properties -```powershell -PS C:\> Get-ADComputer -Identity "User01-SRV1" -Properties * - - -AccountExpirationDate : -accountExpires : 9223372036854775807 -AccountLockoutTime : -AccountNotDelegated : False -AllowReversiblePasswordEncryption : False -BadLogonCount : -CannotChangePassword : False -CanonicalName : fabrikam.com/Computers/User01-srv1 -Certificates : {} -CN : User01-srv1 -codePage : 0 -countryCode : 0 -Created : 3/16/2009 4:15:00 PM -createTimeStamp : 3/16/2009 4:15:00 PM -Deleted : -Description : DisplayName : -DistinguishedName : CN= User01-srv1,CN=Computers,DC=fabrikam,DC=com -DNSHostName : User01-srv1 -DoesNotRequirePreAuth : False -dSCorePropagationData : {3/16/2009 4:21:51 PM, 12/31/1600 4:00:01 PM} -Enabled : True -HomedirRequired : False -HomePage : -instanceType : 0 -IPv4Address : -IPv6Address : -isCriticalSystemObject : False -isDeleted : -LastBadPasswordAttempt : -LastKnownParent : -LastLogonDate : -localPolicyFlags : 0 -Location : NA/HQ/Building A -LockedOut : False -ManagedBy : CN=SQL Administrator 01,OU=UserAccounts,OU=Managed,DC=fabrikam,DC=com -MemberOf : {} -MNSLogonAccount : False -Modified : 3/16/2009 4:23:01 PM -modifyTimeStamp : 3/16/2009 4:23:01 PM -msDS-User-Account-Control-Computed : 0 -Name : User01-srv1 -nTSecurityDescriptor : System.DirectoryServices.ActiveDirectorySecurity -ObjectCategory : CN=Computer,CN=Schema,CN=Configuration,DC=fabrikam,DC=com -ObjectClass : computer -ObjectGUID : 828306a3-8ccd-410e-9537-e6616662c0b0 -objectSid : S-1-5-21-41432690-3719764436-1984117282-1130 -OperatingSystem : -OperatingSystemHotfix : -OperatingSystemServicePack : -OperatingSystemVersion : -PasswordExpired : False -PasswordLastSet : -PasswordNeverExpires : False -PasswordNotRequired : False -PrimaryGroup : CN=Domain Computers,CN=Users,DC=fabrikam,DC=com -primaryGroupID : 515 -ProtectedFromAccidentalDeletion : False -pwdLastSet : 0 -SamAccountName : User01-srv1$ -sAMAccountType : 805306369 -sDRightsEffective : 0 -ServiceAccount : {} -servicePrincipalName : {MSOLAPSVC.3/User01-SRV1.fabrikam.com:analyze, MSSQLSVC/User01-SRV1.fabrikam.com:1456} -ServicePrincipalNames : {MSOLAPSVC.3/User01-SRV1.fabrikam.com:analyze, MSSQLSVC/User01-SRV1.fabrikam.com:1456} -SID : S-1-5-21-41432690-3719764436-1984117282-1130 -SIDHistory : {} -TrustedForDelegation : False -TrustedToAuthForDelegation : False -UseDESKeyOnly : False -userAccountControl : 4096 -userCertificate : {} -UserPrincipalName : -uSNChanged : 36024 -uSNCreated : 35966 -whenChanged : 3/16/2009 4:23:01 PM -whenCreated : 3/16/2009 4:15:00 PM -``` - -This command gets a specific computer showing all the properties. - -### Example 2: Get all computers with a name starting with a particular string -```powershell -PS C:\> Get-ADComputer -Filter 'Name -like "User01*"' -Properties IPv4Address | FT Name,DNSHostName,IPv4Address -A -name dnshostname ipv4address ----- ----------- ----------- -User01-SRV1 User01-SRV1.User01.com 10.194.99.181 -User01-SRV2 User01-SRV2.User01.com 10.194.100.3 -``` - -This command gets all the computers with a name starting with a particular string and shows the name, dns hostname, and IPv4 address. - -### Example 3: Gets all computers that have changed their password in specific time frame -```powershell -PS C:\> $Date = [DateTime]::Today.AddDays(-90) -PS C:\> Get-ADComputer -Filter 'PasswordLastSet -ge $Date' -Properties PasswordLastSet | FT Name,PasswordLastSet -Name PasswordLastSet ----- --------------- -USER01-SRV4 3/12/2009 6:40:37 PM -USER01-SRV5 3/12/2009 7:05:45 PM -``` - -This command gets all the computers that have changed their password in the last 90 days. - -### Example 4: Get computer accounts in a specific location using an LDAPFilter -```powershell -PS C:\> Get-ADComputer -LDAPFilter "(name=*laptop*)" -SearchBase "CN=Computers,DC= User01,DC=com" -name ----- -pattiful-laptop -davidche-laptop -``` - -This command gets the computer accounts in the location CN=Computers,DC=User01,DC=com that are listed as laptops by using an *LDAPFilter*. - -### Example 5: Get all computer accounts using a filter -```powershell -PS C:\> Get-ADComputer -Filter * -``` - -This command gets all computer accounts. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the Windows PowerShell Expression Language syntax. -The Windows PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the Windows PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. - -Note: Windows PowerShell wildcards other than \*, such as ?, are not supported by the *Filter* syntax. - -Note: To query using LDAP query strings, use the *LDAPFilter* parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Accounts Manager account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a distinguished name, the partition to search is computed from that distinguished name. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. - -```yaml -Type: ADComputer -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The *Filter* parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help` [about_ActiveDirectory_Filter](/previous-versions/windows/server/hh531527(v=ws.10)). - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $Null (null value). -You can use Ctrl+C to stop the query and return of objects. - -The default is $Null. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an Active Directory Domain Services target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target AD LDS instance if one has been specified by setting the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -When the value of the *SearchBase* parameter is set to an empty string and you are connected to a global catalog port, all partitions are searched. -If the value of the *SearchBase* parameter is set to an empty string and you are not connected to a global catalog port, an error is thrown. - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -The acceptable values for this parameter are: - -- Base or 0 -- OneLevel or 1 -- Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: Subtree -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the *Identity* parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADComputer -Returns one or more computer objects. - -This Get-ADComputer cmdlet returns a default set of **ADComputer** property values. -To retrieve additional **ADComputer** properties, use the *Properties* parameter of this cmdlet. - -To view the properties for an **ADComputer** object, see the following examples. -To run these examples, replace \ with a computer identifier such as the SAM account name of your local computer. - -To get a list of the default set of properties of an ADComputer object, use the following command: - -`Get-ADComputer`\`| Get-Member` - -To get a list of all the properties of an ADComputer object, use the following command: - -`Get-ADComputer`\`-Properties ALL | Get-Member` - -## NOTES -* This cmdlet does not work with AD LDS with its default schema. By default AD LDS schema does not have a computer class, but if the schema is extended to include it, this cmdlet will work with LDS. - -## RELATED LINKS - -[Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) - -[Get-ADComputerServiceAccount](./Get-ADComputerServiceAccount.md) - -[New-ADComputer](./New-ADComputer.md) - -[Remove-ADComputer](./Remove-ADComputer.md) - -[Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) - -[Set-ADComputer](./Set-ADComputer.md) diff --git a/docset/winserver2012-ps/activedirectory/Get-ADComputerServiceAccount.md b/docset/winserver2012-ps/activedirectory/Get-ADComputerServiceAccount.md deleted file mode 100644 index f634562e18..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADComputerServiceAccount.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adcomputerserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADComputerServiceAccount - -## SYNOPSIS -Gets the service accounts hosted by a computer. - -## SYNTAX - -``` -Get-ADComputerServiceAccount [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADComputerServiceAccount cmdlet gets all of the service accounts that are hosted by the specified computer. - -The Computer parameter specifies the Active Directory computer that hosts the service accounts. -You can identify a computer by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the Computer parameter to a computer object variable, such as $\, or pass a computer object through the pipeline to the Computer parameter. -For example, you can use the Get-ADComputer cmdlet to retrieve a computer object and then pass the object through the pipeline to the Get-ADComputerServiceAccount cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADComputerServiceAccount -Identity ComputerAcct1 - - -Enabled : True -Name : SvcAcct1 -UserPrincipalName : -SamAccountName : SvcAcct1$ -ObjectClass : msDS-ManagedServiceAccount -SID : S-1-5-21-159507390-2980359153-3438059098-1104 -ObjectGUID : 8d759d66-ef68-4360-aff6-ec3bb3425ac1 -HostComputers : {CN=ComputerAcct1,CN=Computers,DC=contoso,DC=com} -DistinguishedName : CN=SvcAcct1,CN=Managed Service Accounts,DC=contoso,DC=com -``` - -Description - ------------ - -Get the service accounts hosted on a computer account 'ComputerAcct1' - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager Account Name (sAMAccountName) - -Example: SaraDavisDesktop - -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a DN, the partition to search will be computed from that DN. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a computer object instance named "computerInstance". - --Identity $computerInstance - -```yaml -Type: ADComputer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the Computer parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADServiceAccount -Returns one or more objects that represent the service accounts hosted by the specified computer. - -## NOTES -* This cmdlet does not work with AD LDS. - -## RELATED LINKS - -[Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADDCCloningExcludedApplicationList.md b/docset/winserver2012-ps/activedirectory/Get-ADDCCloningExcludedApplicationList.md deleted file mode 100644 index d6fd9442fe..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADDCCloningExcludedApplicationList.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-addccloningexcludedapplicationlist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADDCCloningExcludedApplicationList - -## SYNOPSIS -Returns the list of installed programs and services present on this domain controller that are not in the default or user defined inclusion list. - -## SYNTAX - -### Default (Default) -``` -Get-ADDCCloningExcludedApplicationList [] -``` - -### Xml -``` -Get-ADDCCloningExcludedApplicationList [-Force] [-GenerateXml] [-Path ] [] -``` - -## DESCRIPTION -The Get-ADDCCloningExcludedApplicationList cmdlet searches the local domain controller for programs and services in the installed programs database, the services control manager that are not specified in the default and user defined inclusion list. -The applications in the resulting list can be added to the user defined exclusion list if they are determined to support cloning. -If the applications are not cloneable, they should be removed from the source domain controller before the clone media is created. -Any application that appears in cmdlet output and is not included in the user defined inclusion list will force cloning to fail. - -Once you have granted a source virtualized DC permissions to be cloned, the Get-ADDCCloningExcludedApplicationList cmdlet should be run a first time with no additional parameters on the source virtualized domain controller to identify all programs or services that are to be evaluated for cloning. -Next, vet the returned list with your software vendors and remove any applications from the list that cannot be safely cloned. -Finally, you can run the Get-ADDCCloningExcludedApplicationList cmdlet again using the **-GenerateXml** parameter set to create the CustomDCCloneAllowList.xml file. - -The Get-ADDCCloningExcludedApplicationList cmdlet needs to be run before the New-ADDCCloneConfigFile cmdlet is used because if the New-ADDCCloneConfigFile cmdlet detects an excluded application, it will not create a DCCloneConfig.xml file. -For more information on virtual domain controller cloning, see the guidance on AD DS virtualization at http://go.microsoft.com/fwlink/?LinkId=208030http://go.microsoft.com/fwlink/?LinkId=208030. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADDCCloningExcludedApplicationList -``` - -Description - ------------ - -Displays the excluded application list to the console. -If there is already a CustomDCCloneAllowList.xml, this cmdlet displays the delta of that list compared to the operating system (which may be nothing if the lists match). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADDCCloningExcludedApplicationList -GenerateXml -Path C:\Windows\NTDS -Force -``` - -Description - ------------ - -Generates the excluded application list as a file named CustomDCCloneAllowList.xml at the specified folder path (C:\Windows\NTDS) and forces overwrite if a file by that name is found to already exist at that path location. - -## PARAMETERS - -### -Force -Forces an overwrite of an existing CustomDCCloneAllowList.xml file if one is found to exist at the folder path specified in the -Path parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Xml -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateXml -Creates the CustomDCCloneAllowList.xml file and writes it in the location specified using the -Path parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: Xml -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -The folder path to use when creating the CustomDCCloneAllowList.xml file using the -GenerateXml switch parameter. - -```yaml -Type: String -Parameter Sets: Xml -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### ADEntity - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADDefaultDomainPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADDefaultDomainPasswordPolicy.md deleted file mode 100644 index 6c4aa2e6a8..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADDefaultDomainPasswordPolicy.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-addefaultdomainpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADDefaultDomainPasswordPolicy - -## SYNOPSIS -Gets the default password policy for an Active Directory domain. - -## SYNTAX - -### Current (Default) -``` -Get-ADDefaultDomainPasswordPolicy [-AuthType ] [-Credential ] - [[-Current] ] [-Server ] [] -``` - -### Identity -``` -Get-ADDefaultDomainPasswordPolicy [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADDefaultDomainPasswordPolicy cmdlet gets the default password policy for a domain. - -The Identity parameter specifies the Active Directory domain. -You can identify a domain by its Distinguished Name (DN), GUID, Security Identifier (SID), DNS domain name, or NETBIOS name. -You can also set the parameter to a domain object variable, such as $\ or pass a domain object through the pipeline to the Identity parameter. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADDefaultDomainPasswordPolicy -Current LoggedOnUser -``` - -Description - ------------ - -Get the default domain password policy from current logged on user domain. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADDefaultDomainPasswordPolicy -Current LocalComputer -``` - -Description - ------------ - -Get the default domain password policy from current local computer. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADDefaultDomainPasswordPolicy -Identity fabrikam.com -``` - -Description - ------------ - -Get the default domain password policy from a given domain. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>(Get-ADForest -Current LoggedOnUser).Domains | %{ Get-ADDefaultDomainPasswordPolicy -Identity $_ } -``` - -Description - ------------ - -Get the default domain password policy objects from all the domains in the forest. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADDefaultDomainPasswordPolicy -``` - -Description - ------------ - -Get the default domain password policy from current logged on user domain. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Current -Specifies whether to return the domain of the local computer or the current logged on user (CLU). -Possible values for this parameter are: - -LocalComputer or 0 - -LoggedOnUser or 1 - -The following example shows how to set this parameter to return the domain of the current logged on user. - --Current LoggedOnUser - -```yaml -Type: ADCurrentDomainType -Parameter Sets: Current -Aliases: -Accepted values: LocalComputer, LoggedOnUser - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -All values are for the domainDNS object that represents the domain. - -Distinguished Name - -Example: DC=redmond,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370- - -DNS domain name - -Example: redmond.corp.contoso.com - -NetBIOS domain name - -Example: redmond - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a domain object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "DC=redmond,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a domain object instance named "domainInstance". - --Identity $domainInstance - -```yaml -Type: ADDefaultDomainPasswordPolicy -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDomain -A domain object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADDefaultDomainPasswordPolicy -Returns the default domain password policy object for the specified domain. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Get-ADDomain](./Get-ADDomain.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADDomain.md b/docset/winserver2012-ps/activedirectory/Get-ADDomain.md deleted file mode 100644 index 15b25a55b5..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADDomain.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-addomain?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADDomain - -## SYNOPSIS -Gets an Active Directory domain. - -## SYNTAX - -### Current (Default) -``` -Get-ADDomain [-AuthType ] [-Credential ] [-Current ] - [-Server ] [] -``` - -### Identity -``` -Get-ADDomain [-AuthType ] [-Credential ] [-Identity] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADDomain cmdlet gets the Active Directory domain specified by the parameters. -You can specify the domain by setting the Identity or Current parameters. - -The Identity parameter specifies the Active Directory domain to get. -You can identify the domain object to get by its Distinguished Name (DN), GUID, Security Identifier (SID), DNS domain name, or NetBIOS name. -You can also set the parameter to a domain object variable, such as $\ or pass a domain object through the pipeline to the Identity parameter. - -To get the domain of the local computer or current logged on user (CLU) set the Current parameter to LocalComputer or LoggedOnUser. -When you set the Current parameter, you do not need to set the Identity parameter. - -When the Current parameter is set to LocalComputer or LoggedOnUser, the cmdlet uses the Server and Credential parameters according to the following rules. - --If both the Server and Credential parameters are not specified: - -- The domain is set to the domain of the LocalComputer or LoggedOnUser and a server is located in this domain. The credentials of the current logged on user are used to get the domain. - --If the Server parameter is specified and the Credential parameter is not specified: - -- The domain is set to the domain of the specified server and the cmdlet checks to make sure that the server is in the domain of the LocalComputer or LoggedOnUser. Then the credentials of the current logged on user are used to get the domain. An error is returned when the server is not in the domain of the LocalComputer or LoggedOnUser. - --If the Server parameter is not specified and the Credential parameter is specified: - -- The domain is set to the domain of the LocalComputer or LoggedOnUser and a server is located in this domain. Then the credentials specified by the Credential parameter are used to get the domain. - -If the Server and Credential parameters are specified: - -The domain is set to the domain of the specified server and the cmdlet checks to make sure that the server is in the domain of the LocalComputer or LoggedOnUser. -Then the credentials specified by the Credential parameter are used to get the domain. -An error is returned when the server is not in the domain of the LocalComputer or LoggedOnUser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADDomain fabrikam.com -``` - -Description - ------------ - -Gets the domain information for the domain 'fabrikam.com'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADDomain -Current LocalComputer -``` - -Description - ------------ - -Get the domain information of the current local computer domain. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADDomain -Current LoggedOnUser -``` - -Description - ------------ - -Gets the domain information for the domain of the currently logged on user. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADDomain - -AllowedDNSSuffixes : {} -ChildDomains : {} -ComputersContainer : CN=Computers,DC=Fabrikam,DC=com -DeletedObjectsContainer : CN=Deleted Objects,DC=Fabrikam,DC=com -DistinguishedName : DC=Fabrikam,DC=com -DNSRoot : Fabrikam.com -DomainControllersContainer : OU=Domain Controllers,DC=Fabrikam,DC=com -DomainMode : Windows2003Domain -DomainSID : S-1-5-21-41432690-3719764436-1984117282 -ForeignSecurityPrincipalsContainer : CN=ForeignSecurityPrincipals,DC=Fabrikam,DC=com -Forest : Fabrikam.com -InfrastructureMaster : Fabrikam-DC1.Fabrikam.com -LastLogonReplicationInterval : -LinkedGroupPolicyObjects : {CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Fabrikam,DC=com} -LostAndFoundContainer : CN=LostAndFound,DC=Fabrikam,DC=com -ManagedBy : -Name : Fabrikam -NetBIOSName : FABRIKAM -ObjectClass : domainDNS -ObjectGUID : b63b4f44-58b9-49cf-8911-b36e8575d5eb -ParentDomain : -PDCEmulator : Fabrikam-DC1.Fabrikam.com -QuotasContainer : CN=NTDS Quotas,DC=Fabrikam,DC=com -ReadOnlyReplicaDirectoryServers : {CSD2722780.Fabrikam.com} -ReplicaDirectoryServers : {Fabrikam-DC1.Fabrikam.com} -RIDMaster : Fabrikam-DC1.Fabrikam.com -SubordinateReferences : {DC=ForestDnsZones,DC=Fabrikam,DC=com, DC=DomainDnsZones,DC=Fabrikam,DC=com, CN=Co -nfiguration,DC=Fabrikam,DC=com} -SystemsContainer : CN=System,DC=Fabrikam,DC=com -UsersContainer : CN=Users,DC=Fabrikam,DC=com -``` - -Description - ------------ - -Gets the domain information for the domain of the currently logged on user. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Current -Specifies whether to return the domain of the local computer or the current logged on user (CLU). -Possible values for this parameter are: - -LocalComputer or 0 - -LoggedOnUser or 1 - -The following example shows how to set this parameter to return the domain of the current logged on user. - --Current LoggedOnUser - -```yaml -Type: ADCurrentDomainType -Parameter Sets: Current -Aliases: -Accepted values: LocalComputer, LoggedOnUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -All values are for the domainDNS object that represents the domain. - -Distinguished Name - -Example: DC=redmond,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370- - -DNS domain name - -Example: redmond.corp.contoso.com - -NetBIOS domain name - -Example: redmond - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a domain object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "DC=redmond,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a domain object instance named "domainInstance". - --Identity $domainInstance - -```yaml -Type: ADDomain -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomain -A domain object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADDomain -Returns one or more domain objects. - -The cmdlet returns all of the properties of the domain. -To view all of the properties for an ADDomain object, use the following command and replace \ with a domain controller identifier such as a DNS host name. - -Get-ADDomain \| Get-Member - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Set-ADDomain](./Set-ADDomain.md) - -[Set-ADDomainMode](./Set-ADDomainMode.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADDomainController.md b/docset/winserver2012-ps/activedirectory/Get-ADDomainController.md deleted file mode 100644 index 84272c9c02..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADDomainController.md +++ /dev/null @@ -1,752 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-addomaincontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADDomainController - -## SYNOPSIS -Gets one or more Active Directory domain controllers based on discoverable services criteria, search parameters or by providing a domain controller identifier, such as the NetBIOS name. - -## SYNTAX - -### Identity (Default) -``` -Get-ADDomainController [-AuthType ] [-Credential ] [[-Identity] ] - [-Server ] [] -``` - -### DiscoverByService -``` -Get-ADDomainController [-AuthType ] [-AvoidSelf] [-Discover] [-DomainName ] - [-ForceDiscover] [-MinimumDirectoryServiceVersion ] [-NextClosestSite] - [-Service ] [-SiteName ] [-Writable] [] -``` - -### Filter -``` -Get-ADDomainController [-AuthType ] [-Credential ] -Filter - [-Server ] [] -``` - -## DESCRIPTION -The Get-ADDomainController cmdlet gets the domain controllers specified by the parameters. -You can get domain controllers by setting the Identity, Filter or Discover parameters. - -The Identity parameter specifies the domain controller to get. -You can identify a domain controller by its GUID, IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the name of the server object that represents the domain controller, the Distinguished Name (DN) of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the DN of the computer object that represents the domain controller. -You can also set the Identity parameter to a domain controller object variable, such as $\, or pass a domain controller object through the pipeline to the Identity parameter. - -To search for and retrieve more than one domain controller, use the Filter parameter. -The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. -For more information about the Filter parameter syntax, see about_ActiveDirectory_Filter. -You cannot use an LDAP query string with this cmdlet. - -To get a domain controller by using the discovery mechanism of DCLocator, use the Discover parameter. -You can provide search criteria by setting parameters such as Service, SiteName, DomainName, NextClosestSite, AvoidSelf, and ForceDiscover. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -Site "Default-First-Site-Name" -``` - -Description - ------------ - -Get one available DC in a given site using Discovery. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -Site "Default-First-Site-Name" -ForceDiscover -``` - -Description - ------------ - -Force discover/find one available DC in a given site. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -Service "GlobalCatalog" -``` - -Description - -Get a global catalog in the current forest using Discovery. Domain type name is used in this scenario. - ------------ - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -Service 2 -``` - -Description - ------------ - -Get a global catalog in the current forest using Discovery. Domain type id is used in this scenario. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -``` - -Description - ------------ - -Get one available DC in the current domain using Discovery. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -Domain "fabrikam.com" -``` - -Description - ------------ - -Get one available DC in a given domain using Discovery. - -### -------------------------- EXAMPLE 7 -------------------------- -``` -C:\PS>Get-ADDomainController -Discover -Domain "corp.contoso.com" -Service "PrimaryDC","TimeService" -``` - -Description - ------------ - -Get the PDC using Discovery and make sure that is advertising as a time server. - -### -------------------------- EXAMPLE 8 -------------------------- -``` -C:\PS>Get-ADDomainController -Identity "PDC-01" -``` - -Description - ------------ - -Get a domain controller using its NetBIOS name. - -### -------------------------- EXAMPLE 9 -------------------------- -``` -C:\PS>Get-ADDomainController "PDC-01" -``` - -Description - ------------ - -Get a domain controller using its NetBIOS name. - -### -------------------------- EXAMPLE 10 -------------------------- -``` -C:\PS>Get-ADDomainController -Identity "TK5-CORP-DC-10.fabrikam.com" -Server "fabrikam.com" -Credential "corp\administrator" -``` - -Description - ------------ - -Get a domain controller using its DNS host name, in a given domain (specified in Server parameter) and specifying administrator credentials. - -### -------------------------- EXAMPLE 11 -------------------------- -``` -C:\PS>Get-ADDomainController -Identity "168.54.62.57" -``` - -Description - ------------ - -Get a domain controller using its IP address. - -### -------------------------- EXAMPLE 12 -------------------------- -``` -C:\PS>Get-ADDomainController -Filter "isGlobalCatalog -eq `$true -and Site -eq 'Default-First-Site-Name'" -``` - -Description - ------------ - -Get all global catalogs in a given site. - -### -------------------------- EXAMPLE 13 -------------------------- -``` -C:\PS>Get-ADDomainController -Server "research.fabrikam.com" -Filter "isGlobalCatalog -eq `$true -and isReadOnly -eq `$true" -``` - -Description - ------------ - -Get all ROGCs in the child domain to which the client is connected. - -### -------------------------- EXAMPLE 14 -------------------------- -``` -C:\PS>Get-ADDomainController -``` - -Description - ------------ - -Gets the domain controller in the user's current session. -This is the domain controller used as a default Server in the context of an AD Provider. -Using this cmdlet in this way will let you know which Server is being used by default. - -### -------------------------- EXAMPLE 15 -------------------------- -``` -C:\PS>$allDCs = (Get-ADForest).Domains | %{ Get-ADDomainController -Filter * -Server $_ } -``` - -Description - ------------ - -Gets a list of all of the domain controllers for all the domains within a forest. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AvoidSelf -Specifies to not return the current computer as a domain controller. -If the current computer is not a domain controller, this parameter is ignored. -You can specify this parameter when you want to get the name of another domain controller in the domain. - -The following example shows how to specify this parameter. - --AvoidSelf - -```yaml -Type: SwitchParameter -Parameter Sets: DiscoverByService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: Identity, Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Discover -Specifies to return a discoverable domain controller that meets the conditions specified by the cmdlet parameters. - -To get a domain controller by using the discovery mechanism of DCLocator, use the Discover parameter. -Along with this parameter, you can provide search criteria by setting parameters such as Service, SiteName, DomainName, NextClosestSite, AvoidSelf, and ForceDiscover. - -The following example shows how to specify this parameter. - --Discover - -The following example shows how to get a live DC that has Web Services enabled in a specific site with name "RODC-Site". - -Get-ADDomainController -Discover -Services ADWS -SiteName RODC-Site - -```yaml -Type: SwitchParameter -Parameter Sets: DiscoverByService -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the domain to search. -The cmdlet locates a discoverable domain controller in this domain. -Specify the domain by using the NetBIOS name or Fully Qualified Domain Name (FQDN) of the domain. - -The following example shows how to set this parameter to the FQDN of a domain. - --DomainName "contoso.com" - -```yaml -Type: String -Parameter Sets: DiscoverByService -Aliases: - -Required: False -Position: Named -Default value: Name of the domain to which this machine is joined -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceDiscover -Forces the cmdlet to clear any cached domain controller information and perform a new discovery. -If this parameter is not specified the cmdlet may return cached domain controller information. - -The following example shows how to set this parameter. - --ForceDiscover - -```yaml -Type: SwitchParameter -Parameter Sets: DiscoverByService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain controller object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. -Unless specified otherwise, these values are for the server object that represents the domain controller. - -GUID (objectGUID) - -Example: 768c44de-f72d-66e0-8a88-0523ca495f20 - -IPV4Address - -Example:157.59.132.61 - -Global IPV6Address - -Example: 2001:4898:0:fff:200:5efe:157.59.132.61 - -DNS Host Name (dNSHostName) - -Example: corp-DC01.corp.contoso.com - -Name of the server object - -Example: corp-DC01$ - -Distinguished Name of the NTDS Settings object - -Example: CN=NTDS Settings,CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso - -Distinguished Name of the server object that represents the domain controller - -Example: CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID of NTDS settings object under the configuration partition - -Example: 68adaf21-e28d-6012-bca8-320d93450ab0 - -GUID of server object under the configuration partition - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Distinguished Name of the computer object that represents the domain controller. - -Example: CN=CORP-DC12,OU=Domain Controllers,DC=corp,DC=contoso,DC=com - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name of the NTDS Settings object. - --Identity "CN=NTDS Settings,CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso" - -This example shows how to set this parameter to a domain controller object instance named "AD_DCInstance". - --Identity $AD_DCInstance - -```yaml -Type: ADDomainController -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MinimumDirectoryServiceVersion -Species the earliest operating system that the domain controller can have so that it is returned by the cmdlet when getting a DC using -Discover switch. -Possible values are: - -Windows2000 or 1 - -Windows2008 or 2 - -The following example shows how to set this parameter. - --MinimumDirectoryServiceVersion Windows2000 - -The following example shows how to get any live DC that is Windows 2008 or above: - -Get-ADDomainController -Discover -MinimumDirectoryServiceVersion Windows2008 - -```yaml -Type: ADMinimumDirectoryServiceVersion -Parameter Sets: DiscoverByService -Aliases: -Accepted values: Windows2000, Windows2008, Windows2012 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NextClosestSite -Specifies to return a domain controller in the next closest site when a domain controller is not found in the site that contains the client. -The next closest site is the site with the lowest site link cost with respect to the current site. -Costs between sites are based on factors such as bandwidth, as well as physical proximity. - -The following example shows how to specify this parameter. - --NextClosestSite - -```yaml -Type: SwitchParameter -Parameter Sets: DiscoverByService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: Identity, Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Species the types of domain controllers to get. -You can specify more than one type by using a comma-separated list. -Possible values for this parameter are: - -PrimaryDC or 1 - -GlobalCatalog or 2 - -KDC or 3 - -TimeService or 4 - -ReliableTimeService or 5 - -ADWS or 6 - -The following example shows how to set this parameter. - --Service GlobalCatalog, KDC - -The following example shows how to get a live DC that has Web Services enabled: - -Get-ADDomainController -Discover -Services ADWS - -```yaml -Type: ADDiscoverableService[] -Parameter Sets: DiscoverByService -Aliases: -Accepted values: PrimaryDC, GlobalCatalog, KDC, TimeService, ReliableTimeService, ADWS - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of a site to search in to find the domain controller. -If this parameter is not set, the cmdlet searches for domain controllers in the same site as the client. -The name of the site is defined by the Name property of the site object. - -The following example shows how to use this parameter to specify a site. - --SiteName "redmond" - -```yaml -Type: String -Parameter Sets: DiscoverByService -Aliases: - -Required: False -Position: Named -Default value: Name of the site that the client is in -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Writable -Specifies whether or not this is a writable domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: DiscoverByService -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDomainController -A domain controller object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADDomainController -Returns one or more domain controller objects. - -When you use the Discover parameter to get a domain controller, the cmdlet returns a default set of property values for each domain controller. - -When you use the Identity or Filter parameters to get a domain controller, this cmdlet returns all of the properties of the domain controller. - -To view all of the properties for an ADDomainController object, use the following command and replace \ with a domain controller identifier such as a DNS host name. - -Get-ADDomainController \| Get-Member - -## NOTES -* The Name and HostName properties of the ADDomainController objects returned by the cmdlet are set according to the following rule: - - - If the Discover parameter is used, HostName is the Fully Qualified Domain Name of the Domain Controller, and the Name is the NetBIOS name of the Domain Controller. -With the Discover parameter, the cmdlet will perform a second DCLocator call, to populate the Name property. -This property will not be set, to the NetBIOS name of the Domain Controller, if the WINS service is unavailable. - - - If the Identity or the Filter parameter is used, HostName is the DNSHostName attribute of the Domain Controller object, and the Name is the Name (RDN) attribute of the Domain Controller object. -With the Identity or the Filter parameter, the HostName property will not be set, if the DNSHostName attribute of the Domain Controller object is null. - - This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Add-ADDomainControllerPasswordReplicationPolicy](./Add-ADDomainControllerPasswordReplicationPolicy.md) - -[Get-ADDomainControllerPasswordReplicationPolicy](./Get-ADDomainControllerPasswordReplicationPolicy.md) - -[Remove-ADDomainControllerPasswordReplicationPolicy](./Remove-ADDomainControllerPasswordReplicationPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy.md deleted file mode 100644 index 9746674caf..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicy.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-addomaincontrollerpasswordreplicationpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADDomainControllerPasswordReplicationPolicy - -## SYNOPSIS -Gets the members of the allowed list or denied list of a read-only domain controller's password replication policy. - -## SYNTAX - -### AllowedPRP (Default) -``` -Get-ADDomainControllerPasswordReplicationPolicy [-Allowed] [-AuthType ] - [-Credential ] [-Identity] [-Server ] [] -``` - -### DeniedPRP -``` -Get-ADDomainControllerPasswordReplicationPolicy [-AuthType ] [-Credential ] [-Denied] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet gets the users, computers, service accounts and groups that are members of the applied list or denied list for a read-only domain controller's (RODC) password replication policy. -To get the members of the applied list, specify the *AppliedList* parameter. -To get the members of the denied list, specify the *DeniedList* parameter. - -The *Identity* parameter specifies the RODC that uses the allowed and denied lists to apply the password replication policy. -You can identify a domain controller by its GUID, IPV4Address, IPV6Address, or DNS host name. -You can also identify a domain controller by the name of the server object that represents the domain controller, the distinguished name of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the distinguished name of the computer object that represents the domain controller. - -You can also set the *Identity* parameter to a domain controller object variable, such as `$`, or pass a domain controller object through the pipeline operator to the *Identity* parameter. -For example, you can use the **Get-ADDomainController** cmdlet to retrieve a domain controller object and then pass the object through the pipeline operator to the **Get-ADDomainControllerPasswordReplicationPolicy** cmdlet. - -If you specify a writeable domain controller for this cmdlet, the cmdlet returns a non-terminating error. - -## EXAMPLES - -### Example 1: Gets from an RODC domain controller password replication policy the allowed accounts showing the name and object class of each -``` -C:\PS>Get-ADDomainControllerPasswordReplicationPolicy -Identity "FABRIKAM-RODC1" -Allowed | ft Name,ObjectClass -``` - -This command gets from an RODC domain controller password replication policy the allowed accounts showing the name and object class of each. - -### Example 2: Get the password replication policy allowed list from all RODCs in the domain -``` -C:\PS>Get-ADDomainController -Filter "IsReadOnly -eq `$true" | Get-ADDomainControllerPasswordReplicationPolicy -Allowed - -DistinguishedName : CN=Allowed RODC Password Replication Group,CN=Users,DC=Fabrikam,DC=com -Name : Allowed RODC Password Replication Group -ObjectClass : group -ObjectGUID : 239b0470-7f49-472d-8fcb-4911e90b2c5e -SamAccountName : Allowed RODC Password Replication Group -SID : S-1-5-21-41432690-3719764436-1984117282-571 -``` - -This command gets the password replication policy allowed lists from all RODCs in the domain. - -## PARAMETERS - -### -Allowed -Specifies a search for accounts that have been authenticated by a read-only domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: AllowedPRP -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -Specifies the credentials for the security context under which the task is performed. -If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory. -If running under the context of an Active Directory module for Windows PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the currently logged on user security context is used. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Denied -Specifies the users, computers, groups, or other accounts to add to the list of accounts that are denied the right to replicate their passwords to this read-only domain controller (RODC). -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -```yaml -Type: SwitchParameter -Parameter Sets: DeniedPRP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain controller object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: - -- A GUID (objectGUID) -- An IPV4Address -- A Global IPV6Address -- A DNS Host Name (dNSHostName) -- A name of the server object -- A Distinguished Name of the NTDS Settings object -- A distinguished name of the server object that represents the domain controller -- A GUID of NTDS settings object under the configuration partition -- A GUID of server object under the configuration partition -- A distinguished name of the computer object that represents the domain controller. - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADDomainController -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDomainController -A domain controller object is received by the *Identity* parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADPrincipal -Returns one or more objects that represent the users, computers, service accounts and groups that are members of the applied list or denied list of the domain controller password replication policy. -The list returned depends on the parameters specified. - -## NOTES -* This cmdlet does not work with Active Directory Lightweight Directory Services. -* This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Add-ADDomainControllerPasswordReplicationPolicy](./Add-ADDomainControllerPasswordReplicationPolicy.md) - -[Remove-ADDomainControllerPasswordReplicationPolicy](./Remove-ADDomainControllerPasswordReplicationPolicy.md) - -[AD DS Administration Cmdlets in Windows PowerShell](./ActiveDirectory.md) diff --git a/docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage.md b/docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage.md deleted file mode 100644 index 267196d4f7..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADDomainControllerPasswordReplicationPolicyUsage.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-addomaincontrollerpasswordreplicationpolicyusage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADDomainControllerPasswordReplicationPolicyUsage - -## SYNOPSIS -Gets the Active Directory accounts that are authenticated by a read-only domain controller or that are in the revealed list of the domain controller. - -## SYNTAX - -### RevealedAccounts (Default) -``` -Get-ADDomainControllerPasswordReplicationPolicyUsage [-AuthType ] [-Credential ] - [-Identity] [-RevealedAccounts] [-Server ] [] -``` - -### AuthenticatedAccounts -``` -Get-ADDomainControllerPasswordReplicationPolicyUsage [-AuthenticatedAccounts] [-AuthType ] - [-Credential ] [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The **Get-ADDomainControllerPasswordReplicationPolicyUsage** cmdlet gets the user or computer accounts that are authenticated by a read-only domain controller (RODC) or that have passwords that are stored on that RODC. -The list of accounts that are stored on a RODC is known as the revealed list. - -To get accounts that are authenticated by the RODC, use the **AuthenticatedAccounts** parameter. -To get the accounts that have passwords stored on the RODC, use the **RevealedAccounts** parameter. - -The **Identity** parameter specifies the RODC. -You can identify a domain controller by its GUID, IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the name of the server object that represents the domain controller, the Distinguished Name (DN) of the NTDS settings object of the server object, the GUID of the NTDS settings object of the server object under the configuration partition, or the DN of the computer object that represents the domain controller. -You can also set the **Identity** parameter to a domain controller object variable, such as **$\**, or pass a domain controller object through the pipeline to the **Identity** parameter. -For example, you can use the Get-ADDomainController cmdlet to retrieve a domain controller object and then pass the object through the pipeline to the **Get-ADDomainControllerPasswordReplicationPolicyUsage** cmdlet. -If you specify a writeable domain controller for this cmdlet, the cmdlet returns a non-terminating error. - -## EXAMPLES - -### Example 1: Get authenticated accounts for a specific RODC -``` -PS C:\> Get-ADDomainControllerPasswordReplicationPolicyUsage -Identity "USER01-RODC1" -AuthenticatedAccounts | ft Name,ObjectClass -A -``` - -This command gets the authenticated accounts for the RODC specified by the **Identity** parameter. -The command displays the name and object class of each. - -### Example 2: Get revealed accounts for a specified RODC -``` -PS C:\> Get-ADDomainControllerPasswordReplicationPolicyUsage -Identity "USER01-RODC1" -RevealedAccounts | ft Name,ObjectClass -A -``` - -This command gets the revealed accounts for the RODC specified by the **Identity** parameter. -The command displays the name and object class of each account returned. - -### Example 3: Get a list of accounts cached across all RODCs -``` -PS C:\> Get-ADDomainController -Filter "IsReadOnly -eq `$true" | Get-ADDomainControllerPasswordReplicationPolicyUsage -DistinguishedName : CN=krbtgt_35512,CN=Users,DC=User01,DC=com -Enabled : False -Name : krbtgt_35512 -ObjectClass : user -ObjectGUID : 8c7268f9-add3-409c-968b-de029e517211 -SamAccountName : krbtgt_35512 -SID : S-1-5-21-41432690-3719764436-1984117282-1106 -UserPrincipalName : - -DistinguishedName : CN=CSD2722780,OU=Domain Controllers,DC=User01,DC=com -Enabled : True -Name : CSD2722780 -ObjectClass : computer -ObjectGUID : 63a5e005-e01f-4fc9-ae71-9d9367f808bc -SamAccountName : CSD2722780$ -SID : S-1-5-21-41432690-3719764436-1984117282-1105 -UserPrincipalName : -``` - -This command gets the list of accounts cached across all RODCs in the domain. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticatedAccounts -Specifies a search for accounts that have been authenticated by a read-only domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: AuthenticatedAccounts -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the user who is currently signed in unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -Specifies the credentials for the security context under which the task is performed. -If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory. -If running under the context of an Active Directory module for Windows PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the security context of the user who is currently signed in is used. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01, or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the **Credential** parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain controller object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: - -- A GUID (objectGUID). -- An IPV4Address. -- A Global IPV6Address. -- A DNS Host Name (dNSHostName). -- A name of the server object. -- A distinguished name of the NTDS Settings object. -- A distinguished name of the server object that represents the domain controller. -- A GUID of NTDS settings object under the configuration partition. -- A GUID of server object under the configuration partition. -- A distinguished name of the computer object that represents the domain controller. - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get the object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADDomainController -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RevealedAccounts -Specifies a search for accounts which have passwords that are stored on the read-only domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: RevealedAccounts -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - - Domain name values: - -- Fully qualified domain name. -- NetBIOS name. - - Directory server values: - -- Fully qualified directory server name. -- NetBIOS name. -- Fully qualified directory server name and port. - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the **Server** value from objects passed through the pipeline. -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive when the cmdlet runs in that drive. -- By using the domain of the computer running Windows PowerShell. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDomainController -A domain controller object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -Returns one or more account objects that represent the users, computers, and service accounts that are authenticated by the specified read-only domain controller (RODC) or that have passwords that are stored on the RODC. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Get-ADDomainController](./Get-ADDomainController.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADFineGrainedPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADFineGrainedPasswordPolicy.md deleted file mode 100644 index e9a67ac042..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADFineGrainedPasswordPolicy.md +++ /dev/null @@ -1,649 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adfinegrainedpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFineGrainedPasswordPolicy - -## SYNOPSIS -Gets one or more Active Directory fine grained password policies. - -## SYNTAX - -### Filter (Default) -``` -Get-ADFineGrainedPasswordPolicy [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -### Identity -``` -Get-ADFineGrainedPasswordPolicy [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADFineGrainedPasswordPolicy [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADFineGrainedPasswordPolicy cmdlet gets a fine grained password policy or performs a search to retrieve multiple fine grained password policies. - -The Identity parameter specifies the Active Directory fine grained password policy to get. -You can identify a fine grained password policy by its distinguished name (DN), GUID or name. -You can also set the parameter to a fine grained password policy object variable, such as $\ or pass a fine grained password policy object through the pipeline to the Identity parameter. - -To search for and retrieve more than one fine grained password policies, use the Filter or LDAPFilter parameters. -The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. -For more information about the Filter parameter syntax, see about_ActiveDirectory_Filter. -If you have existing LDAP query strings, you can use the LDAPFilter parameter. - -This cmdlet retrieves a default set of fine grained password policy object properties. -To retrieve additional properties use the Properties parameter. -For more information about the how to determine the properties for FineGrainedPasswordPolicy objects, see the Properties parameter description. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicy -Filter "Name -like '*'" | ft Name, Precedence,MaxPasswordAge,MinPasswordLength -A - - -Name Precedence MaxPasswordAge MinPasswordLength ----- ---------- -------------- ----------------- -DomainUsersPSO 500 60.00:00:00 8 -SvcAccPSO 100 30.00:00:00 20 -AdminsPSO 200 15.00:00:00 10 -DlgtdAdminsPSO 300 20.00:00:00 10 -``` - -Description - ------------ - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicy AdminsPSO - - -Name : AdminsPSO -ComplexityEnabled : True -LockoutThreshold : 0 -ReversibleEncryptionEnabled : True -LockoutDuration : 00:30:00 -LockoutObservationWindow : 00:30:00 -MinPasswordLength : 10 -Precedence : 200 -ObjectGUID : ba1061f0-c947-4018-a399-6ad8897d26e3 -ObjectClass : msDS-PasswordSettings -PasswordHistoryCount : 24 -MinPasswordAge : 1.00:00:00 -MaxPasswordAge : 15.00:00:00 -AppliesTo : {} -DistinguishedName : CN=AdminsPSO,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM -``` - -Description - ------------ - -Get the Fine Grained Password Policy named 'AdminsPSO'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicy 'CN=DlgtdAdminsPSO,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM' -Properties * - - -msDS-LockoutDuration : -18000000000 -msDS-PasswordSettingsPrecedence : 300 -ObjectCategory : CN=ms-DS-Password-Settings,CN=Schema,CN=Configuration,DC=FABRIKAM,DC=COM -DistinguishedName : CN=DlgtdAdminsPSO,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM -ExpireOn : -msDS-MinimumPasswordAge : -864000000000 -dSCorePropagationData : {12/31/1600 4:00:00 PM} -msDS-LockoutThreshold : 0 -Description : The Delegated Administrators Password Policy -LockoutThreshold : 0 -instanceType : 4 -msDS-PasswordComplexityEnabled : True -MaxPasswordAge : 20.00:00:00 -whenCreated : 8/15/2008 12:47:43 AM -Name : DlgtdAdminsPSO -ObjectClass : msDS-PasswordSettings -ReversibleEncryptionEnabled : True -msDS-PasswordReversibleEncryptionEnabled : True -Dynamic : False -LockoutDuration : 00:30:00 -msDS-PSOAppliesTo : {CN=Kim Abercrombie,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM, CN=Bob Kelly,OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM} -DisplayName : Delegated Administrators PSO -uSNCreated : 16395 -Modified : 8/20/2008 12:21:15 AM -MinPasswordAge : 1.00:00:00 -ProtectedFromAccidentalDeletion : False -Created : 8/15/2008 12:47:43 AM -sDRightsEffective : 15 -ComplexityEnabled : True -PasswordHistoryCount : 24 -msDS-MaximumPasswordAge : -17280000000000 -MinPasswordLength : 10 -Precedence : 300 -ObjectGUID : 75cf8c7a-9c93-4e81-b611-851803372cb2 -msDS-MinimumPasswordLength : 10 -Deleted : -Orphaned : False -CN : DlgtdAdminsPSO -LastKnownParent : -CanonicalName : FABRIKAM.COM/System/Password Settings Container/DlgtdAdminsPSO -modifyTimeStamp : 8/20/2008 12:21:15 AM -msDS-LockoutObservationWindow : -18000000000 -LockoutObservationWindow : 00:30:00 -whenChanged : 8/20/2008 12:21:15 AM -createTimeStamp : 8/15/2008 12:47:43 AM -msDS-PasswordHistoryLength : 24 -nTSecurityDescriptor : System.DirectoryServices.ActiveDirectorySecurity -AppliesTo : {CN=JeffPrice,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM, CN=GlenJohn,OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM} -uSNChanged : 72719 -``` - -Description - ------------ - -Get all the properties for the Fine Grained Password Policy with DistinguishedName 'CN=DlgtdAdminsPSO,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicy -Filter "name -like '*admin*'" - -AppliesTo : {CN=GlenJohn,CN=Users,DC=Fabrikam,DC=com, CN=JeffPrice,CN=Users,DC=Fabrikam,DC=com, CN=Administrator,CN=Users,DC=Fabrikam,DC=com} -ComplexityEnabled : True -DistinguishedName : CN=DlgtdAdminsPSO,CN=Password Settings Container,CN=System,DC=Fabrikam,DC=com -LockoutDuration : 00:30:00 -LockoutObservationWindow : 00:30:00 -LockoutThreshold : 0 -MaxPasswordAge : 42.00:00:00 -MinPasswordAge : 1.00:00:00 -MinPasswordLength : 7 -Name : DlgtdAdminsPSO -ObjectClass : msDS-PasswordSettings -ObjectGUID : b7de4e6e-c291-4ce6-bb47-6bf8f807df53 -PasswordHistoryCount : 24 -Precedence : 100 -ReversibleEncryptionEnabled : True -``` - -Description - ------------ - -Get all the Fine Grained Password Policy object that have a name that begins with admin. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name (distinguishedName) - -Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: PasswordPolicyLevel1 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a fine-grained password policy object instance named "fineGrainedPasswordPolicyInstance". - --Identity $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -The following example shows how to set this parameter to search under an OU. - --SearchBase "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. -If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown. - -The following example shows how to set this parameter to an empty string. --SearchBase "" - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -Possible values for this parameter are: - -Base or 0 - -OneLevel or 1 - -Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -The following example shows how to set this parameter to a subtree search. - --SearchScope Subtree - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -A fine grained password policy is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -Returns one or more fine grained password policy objects. - -This cmdlet returns a default set of ADFineGrainedPasswordPolicy property values. -To retrieve additional ADFineGrainedPasswordPolicy properties, use the Properties parameter. - -To view the properties for an ADFineGrainedPasswordPolicy object, see the following examples. -To run these examples, replace \ with a fine grained password policy identifier such as the name of your local fine grained password policy. - -To get a list of the default set of properties of an ADFineGrainedPasswordPolicy object, use the following command: - -Get-ADFineGrainedPasswordPolicy \| Get-Member - -To get a list of all the properties of an ADFineGrainedPasswordPolicy object, use the following command: - -Get-ADFineGrainedPasswordPolicy \ -Properties * | Get-Member - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Add-ADFineGrainedPasswordPolicySubject](./Add-ADFineGrainedPasswordPolicySubject.md) - -[New-ADFineGrainedPasswordPolicy](./New-ADFineGrainedPasswordPolicy.md) - -[Remove-ADFineGrainedPasswordPolicy](./Remove-ADFineGrainedPasswordPolicy.md) - -[Remove-ADFineGrainedPasswordPolicySubject](./Remove-ADFineGrainedPasswordPolicySubject.md) - -[Set-ADFineGrainedPasswordPolicy](./Set-ADFineGrainedPasswordPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADFineGrainedPasswordPolicySubject.md b/docset/winserver2012-ps/activedirectory/Get-ADFineGrainedPasswordPolicySubject.md deleted file mode 100644 index e311fa9b3a..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADFineGrainedPasswordPolicySubject.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adfinegrainedpasswordpolicysubject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFineGrainedPasswordPolicySubject - -## SYNOPSIS -Gets the users and groups to which a fine grained password policy is applied. - -## SYNTAX - -``` -Get-ADFineGrainedPasswordPolicySubject [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Get- ADFineGrainedPasswordPolicySubject cmdlet gets users and groups that are subject to a fine grained password policy. - -The Identity parameter specifies the fine grained password policy. -You can identify a fine grained password policy by its distinguished name, GUID or name. -You can also set the Identity parameter to a fine grained password policy object variable, such as $\, or pass a fine grained password policy object through the pipeline to the Identity parameter. -For example, you can use the Get-ADFineGrainedPasswordPolicy cmdlet to retrieve a fine grained password policy object and then pass the object through the pipeline to the Get- ADFineGrainedPasswordPolicySubject cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicySubject -Identity DomainUsersPSO | FT Name,ObjectClass,DistinguishedName -AutoSize - - -Name ObjectClass DistinguishedName ----- ----------- ----------------- -Domain Users group CN=Domain Users,CN=Users,DC=FABRIKAM,DC=COM -``` - -Description - ------------ - -Get the Fine Grained Password Policy subject of the Password Policy named 'DomainUsersPSO'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name (distinguishedName) - -Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: PasswordPolicyLevel1 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a fine-grained password policy object instance named "fineGrainedPasswordPolicyInstance". - --Identity $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -A fine grained password policy object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADPrincipal -Returns principal objects that represent the users and groups to which the fine grained password policy is applied. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADForest.md b/docset/winserver2012-ps/activedirectory/Get-ADForest.md deleted file mode 100644 index 3c73522c11..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADForest.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adforest?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADForest - -## SYNOPSIS -Gets an Active Directory forest. - -## SYNTAX - -### Current (Default) -``` -Get-ADForest [-AuthType ] [-Credential ] [-Current ] - [-Server ] [] -``` - -### Identity -``` -Get-ADForest [-AuthType ] [-Credential ] [-Identity] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADForest cmdlet gets the Active Directory forest specified by the parameters. -You can specify the forest by setting the Identity or Current parameters. - -The Identity parameter specifies the Active Directory forest to get. -You can identify a forest by its fully qualified domain name (FQDN), DNS host name, or NetBIOS name. -You can also set the parameter to a forest object variable, such as $\ or you can pass a forest object through the pipeline to the Identity parameter. - -To retrieve the forest of the local computer or current logged on user (CLU) set the Current parameter to LocalComputer or LoggedOnUser. -When you set the Current parameter, you do not need to set the Identity parameter. - -When the Current parameter is set to LocalComputer or LoggedOnUser, the cmdlet uses the Server and Credential parameter values to determine the domain and the credentials to use to identify the domain of the forest according to the following rules. - --If both the Server and Credential parameters are not specified: - -- The domain is set to the domain of the LocalComputer or LoggedOnUser and a server is located in this domain. The credentials of the current logged on user are used to get the domain. - --If the Server parameter is specified and the Credential parameter is not specified: - -- The domain is set to the domain of the specified server and the cmdlet checks to make sure that the server is in the domain of the LocalComputer or LoggedOnUser. Then the credentials of the current logged on user are used to get the domain. An error is returned when the server is not in the domain of the LocalComputer or LoggedOnUser. - --If the Server parameter is not specified and the Credential parameter is specified: - -- The domain is set to the domain of the LocalComputer or LoggedOnUser and a server is located in this domain. Then the credentials specified by the Credential parameter are used to get the domain. - -If the Server and Credential parameters are specified: - -The domain is set to the domain of the specified server and the cmdlet checks to make sure that the server is in the domain of the LocalComputer or LoggedOnUser. -Then the credentials specified by the Credential parameter are used to get the domain. -An error is returned when the server is not in the domain of the LocalComputer or LoggedOnUser. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADForest Fabrikam.com -``` - -Description - ------------ - -Get the forest information of the Fabrikam.com forest. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADForest -Current LocalComputer -``` - -Description - ------------ - -Get the forest information of the current local computer's forest. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADForest -Current LoggedOnUser -``` - -Description - ------------ - -Get the forest information of the current logged on users's forest. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADForest -ApplicationPartitions : {DC=ForestDnsZones,DC=Fabrikam,DC=com, DC=DomainDnsZones,DC=Fabrikam,DC=com} -CrossForestReferences : {CN=northwind,CN=Partitions,CN=Configuration,DC=Fabrikam,DC=com} -DomainNamingMaster : Fabrikam-DC1.Fabrikam.com -Domains : {Fabrikam.com} -ForestMode : Windows2003Forest -GlobalCatalogs : {Fabrikam-DC1.Fabrikam.com, CSD2722780.Fabrikam.com} -Name : Fabrikam.com -PartitionsContainer : CN=Partitions,CN=Configuration,DC=Fabrikam,DC=com -RootDomain : Fabrikam.com -SchemaMaster : Fabrikam-DC1.Fabrikam.com -Sites : {Default-First-Site-Name, UnitedKingdomHQ, BO3, RODC-Site-Name} -SPNSuffixes : {} -UPNSuffixes : {} -``` - -Description - ------------ - -Gets the forest information for the forest of the currently logged on user. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>$allDCs = (Get-ADForest).Domains | %{ Get-ADDomainController -Filter * -Server $_ } -``` - -Description - ------------ - -Gets a list of all the domain controllers for all domain within a forest. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Current -Specifies whether to return the domain of the local computer or the current logged on user (CLU). -Possible values for this parameter are: - -LocalComputer or 0 - -LoggedOnUser or 1 - -The following example shows how to set this parameter to return the domain of the current logged on user. - --Current LoggedOnUser - -```yaml -Type: ADCurrentForestType -Parameter Sets: Current -Aliases: -Accepted values: LocalComputer, LoggedOnUser - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory forest object by providing one of the following attribute values. -The identifier in parentheses is the LDAP display name for the attribute. - -Fully qualified domain name - -Example: corp.contoso.com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -DNS host name - -Example: dnsServer.corp.contoso.com - -NetBIOS name - -Example: corp - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a forest object instance. - -This example shows how to set the parameter to a fully qualified domain name. - --Identity "corp.contoso.com" - -This example shows how to set this parameter to a forest object instance named "forestInstance". - --Identity $forestInstance - -```yaml -Type: ADForest -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADForest -A forest object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADForest -Returns one or more forest objects. - -This cmdlet returns all of the properties of the forest. -To view all of the properties for an ADForest object, use the following command and replace \ with a forest identifier such as a DNS host name. - -Get-ADForest \| Get-Member - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work when targeting a snapshot using the Server parameter. - -## RELATED LINKS - -[Set-ADForest](./Set-ADForest.md) - -[Set-ADForestMode](./Set-ADForestMode.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADGroup.md b/docset/winserver2012-ps/activedirectory/Get-ADGroup.md deleted file mode 100644 index 4c7fe5c04a..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADGroup.md +++ /dev/null @@ -1,641 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adgroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADGroup - -## SYNOPSIS -Gets one or more Active Directory groups. - -## SYNTAX - -### Filter (Default) -``` -Get-ADGroup [-AuthType ] [-Credential ] -Filter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [] -``` - -### Identity -``` -Get-ADGroup [-AuthType ] [-Credential ] [-Identity] [-Partition ] - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADGroup [-AuthType ] [-Credential ] -LDAPFilter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [] -``` - -## DESCRIPTION -The Get-ADGroup cmdlet gets a group or performs a search to retrieve multiple groups from an Active Directory. - -The Identity parameter specifies the Active Directory group to get. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also specify group object variable, such as $\. - -To search for and retrieve more than one group, use the Filter or LDAPFilter parameters. -The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. -For more information about the Filter parameter syntax, see about_ActiveDirectory_Filter. -If you have existing LDAP query strings, you can use the LDAPFilter parameter. - -This cmdlet gets a default set of group object properties. -To get additional properties use the Properties parameter. -For more information about the how to determine the properties for group objects, see the Properties parameter description. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADGroup administrators - - -DistinguishedName : CN=Administrators,CN=Builtin,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : DomainLocal -Name : Administrators -ObjectClass : group -ObjectGUID : 02ce3874-dd86-41ba-bddc-013f34019978 -SamAccountName : Administrators -SID : S-1-5-32-544 -``` - -Description - ------------ - -Get the group with samAccountName administrators. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>get-adgroup -Identity S-1-5-32-544 -Properties member - - -DistinguishedName : CN=Administrators,CN=Builtin,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : DomainLocal -member : {CN=Domain Admins,CN=Users,DC=Fabrikam,DC=com, CN=Enterprise Admins,CN=Users,DC=Fabrikam,DC=com, CN=LabAdmin,CN=Users,DC=Fabrikam,DC=com, C -N=Administrator,CN=Users,DC=Fabrikam,DC=com} -Name : Administrators -ObjectClass : group -ObjectGUID : 02ce3874-dd86-41ba-bddc-013f34019978 -SamAccountName : Administrators -SID : S-1-5-32-544 -``` - -Description - ------------ - -Get the group with SID S-1-5-32-544 including the additional property member. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>get-adgroup -Filter 'GroupCategory -eq "Security" -and GroupScope -ne "DomainLocal"' -``` - -Description - ------------ - -Get all groups that have a GroupCategory of Security but do not have a GroupScope of DomainLocal. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>get-adgroup -server localhost:60000 -filter "GroupScope -eq 'DomainLocal'" -SearchBase "DC=AppNC" - -DistinguishedName : CN=AlphaGroup,OU=AccountDeptOU,DC=AppNC -GroupCategory : Security -GroupScope : DomainLocal -Name : AlphaGroup -ObjectClass : group -ObjectGUID : 6498c9fb-7c62-48fe-9972-1461f7f3dec2 -SID : S-1-510474493-936115905-2475435479-1276657127-1006239422-938965137 - -DistinguishedName : CN=BranchOffice1,OU=AccountDeptOU,DC=AppNC -GroupCategory : Security -GroupScope : DomainLocal -Name : BranchOffice1 -ObjectClass : group -ObjectGUID : 0b7504c5-482b-4a73-88f5-8a76960e4568 -SID : S-1-510474493-936115905-2534227223-1194883713-3669005192-3746664089 - -DistinguishedName : CN=AccountLeads,OU=AccountDeptOU,DC=AppNC -GroupCategory : Distribution -GroupScope : DomainLocal -Name : AccountLeads -ObjectClass : group -ObjectGUID : b20c032b-2de9-401a-b48c-341854a37254 -SID : S-1-510474493-936115905-2813670187-1179675302-2001457839-270172950 -``` - -Description - ------------ - -Get all the DomainLocal groups from the AppNC partition of the AD LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a group object instance named "ADGroupInstance". - --Identity $ADGroupInstance - -```yaml -Type: ADGroup -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -The following example shows how to set this parameter to search under an OU. - --SearchBase "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. -If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown. - -The following example shows how to set this parameter to an empty string. --SearchBase "" - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -Possible values for this parameter are: - -Base or 0 - -OneLevel or 1 - -Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -The following example shows how to set this parameter to a subtree search. - --SearchScope Subtree - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: Subtree -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADGroup -Returns one or more group objects. - -The Get-ADGroup cmdlet returns a default set of ADGroup property values. -To retrieve additional ADGroup properties, use the Properties parameter. - -To view the properties for an ADGroup object, see the following examples. -To run these examples, replace \ with a group identifier such as Administrators. - -To get a list of the default set of properties of an ADGroup object, use the following command: - -Get-ADGroup \| Get-Member - -To get a list of all the properties of an ADGroup object, use the following command: - -Get-ADGroup \ -Properties * | Get-Member - -## NOTES - -## RELATED LINKS - -[New-ADGroup](./New-ADGroup.md) - -[Remove-ADGroup](./Remove-ADGroup.md) - -[Set-ADGroup](./Set-ADGroup.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADGroupMember.md b/docset/winserver2012-ps/activedirectory/Get-ADGroupMember.md deleted file mode 100644 index 411ead74a8..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADGroupMember.md +++ /dev/null @@ -1,445 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adgroupmember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADGroupMember - -## SYNOPSIS -Gets the members of an Active Directory group. - -## SYNTAX - -``` -Get-ADGroupMember [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Recursive] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADGroupMember cmdlet gets the members of an Active Directory group. -Members can be users, groups, and computers. - -The Identity parameter specifies the Active Directory group to access. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also specify the group by passing a group object through the pipeline. -For example, you can use the Get-ADGroup cmdlet to retrieve a group object and then pass the object through the pipeline to the Get-ADGroupMember cmdlet. - -If the Recursive parameter is specified, the cmdlet gets all members in the hierarchy of the group that do not contain child objects. -For example, if the group SaraDavisReports contains the user KarenToh and the group JohnSmithReports, and JohnSmithReports contains the user JoshPollock, then the cmdlet returns KarenToh and JoshPollock. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>get-adgroupmember -cmdlet Get-ADGroupMember at command pipeline position 1 -Supply values for the following parameters: -(Type !? for Help.) -Identity: Administrators - -distinguishedName : CN=Domain Admins,CN=Users,DC=Fabrikam,DC=com -name : Domain Admins -objectClass : group -objectGUID : 5ccc6037-c2c9-42be-8e92-c8f98afd0011 -SamAccountName : Domain Admins -SID : S-1-5-21-41432690-3719764436-1984117282-512 - -distinguishedName : CN=Enterprise Admins,CN=Users,DC=Fabrikam,DC=com -name : Enterprise Admins -objectClass : group -objectGUID : 0215b0a5-aea1-40da-b598-720efe930ddf -SamAccountName : Enterprise Admins -SID : S-1-5-21-41432690-3719764436-1984117282-519 - -distinguishedName : CN=LabAdmin,CN=Users,DC=Fabrikam,DC=com -name : LabAdmin -objectClass : user -objectGUID : ab7c269d-aec5-4fcc-aebe-6cd1a2e6cd53 -SamAccountName : LabAdmin -SID : S-1-5-21-41432690-3719764436-1984117282-1000 - -distinguishedName : CN=Administrator,CN=Users,DC=Fabrikam,DC=com -name : Administrator -objectClass : user -objectGUID : 994f46e6-c62c-483f-a6cf-124197b6a959 -SamAccountName : Administrator -SID : S-1-5-21-41432690-3719764436-1984117282-500 -``` - -Description - ------------ - -Get all the members of the administrators groups using the default behavior. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>get-adgroup -server localhost:60000 -filter "GroupScope -eq 'DomainLocal'" -SearchBase "DC=AppNC" | get-adgroupmember -partition "DC=AppNC" - -distinguishedName : CN=SanjayPatel,OU=AccountDeptOU,DC=AppNC -name : SanjayPatel -objectClass : user -objectGUID : d671de28-6e40-42a7-b32c-63d336de296d -SamAccountName : -SID : S-1-510474493-936115905-2231798853-1260534229-4171027843-767619944 -``` - -Description - ------------ - -Get the groups members of all domain local groups in the AD LDS instance. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>get-adgroupmember -Identity administrators - -distinguishedName : CN=Domain Admins,CN=Users,DC=Fabrikam,DC=com -name : Domain Admins -objectClass : group -objectGUID : 5ccc6037-c2c9-42be-8e92-c8f98afd0011 -SamAccountName : Domain Admins -SID : S-1-5-21-41432690-3719764436-1984117282-512 - -distinguishedName : CN=Enterprise Admins,CN=Users,DC=Fabrikam,DC=com -name : Enterprise Admins -objectClass : group -objectGUID : 0215b0a5-aea1-40da-b598-720efe930ddf -SamAccountName : Enterprise Admins -SID : S-1-5-21-41432690-3719764436-1984117282-519 - -distinguishedName : CN=LabAdmin,CN=Users,DC=Fabrikam,DC=com -name : LabAdmin -objectClass : user -objectGUID : ab7c269d-aec5-4fcc-aebe-6cd1a2e6cd53 -SamAccountName : LabAdmin -SID : S-1-5-21-41432690-3719764436-1984117282-1000 - -distinguishedName : CN=Administrator,CN=Users,DC=Fabrikam,DC=com -name : Administrator -objectClass : user -objectGUID : 994f46e6-c62c-483f-a6cf-124197b6a959 -SamAccountName : Administrator -SID : S-1-5-21-41432690-3719764436-1984117282-500 -``` - -Description - ------------ - -Get all the group members of the administrators group. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>get-adgroupmember "Enterprise Admins" -recursive - -distinguishedName : CN=Administrator,CN=Users,DC=Fabrikam,DC=com -name : Administrator -objectClass : user -objectGUID : 994f46e6-c62c-483f-a6cf-124197b6a959 -SamAccountName : Administrator -SID : S-1-5-21-41432690-3719764436-1984117282-500 - -distinguishedName : CN=Sagiv Hadaya,CN=Users,DC=Fabrikam,DC=com -name : Sagiv Hadaya -objectClass : user -objectGUID : 64706230-f179-4fe4-b8c9-f0d334e66ab1 -SamAccountName : SHadaya -SID : S-1-5-21-41432690-3719764436-1984117282-1158 -``` - -Description - ------------ - -Get all the members of the 'Enterprise Admins' group including the members of any child groups. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a group object instance named "ADGroupInstance". - --Identity $ADGroupInstance - -```yaml -Type: ADGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recursive -Specifies that the cmdlet get all members in the hierarchy of a group that do not contain child objects. -The following example shows a hierarchy for the group SaraDavisReports. - -+SaraDavisReports \[group\] - --KarenToh \[user\] - --MattHinkLaptop \[computer\] - -+JohnSmithReports \[group\] - --JoshPollock \[user\] - --ArmandoPinto \[user\] - -+JohnSmithComputers \[group\] - --JoshComputer \[computer\] - -If you specify SaraDavisReports as the group and specify the Recursive parameter, the following members and sub-members are returned. - -KarenToh - -MattHinkLaptop - -JoshPollock - -ArmandoPinto - -JoshComputer - -If the specified group does not have any members, then nothing is returned. - -The following example shows how to specify this parameter. - --Recursive - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the Identity parameter - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADPrincipal -Returns one or more principal objects that represent users, computers or groups that are members of the specified group. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work when a group has members located in a different forest, and the forest does not have Active Directory Web Service running. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - -[Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADObject.md b/docset/winserver2012-ps/activedirectory/Get-ADObject.md deleted file mode 100644 index c26f9de374..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADObject.md +++ /dev/null @@ -1,695 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADObject - -## SYNOPSIS -Gets one or more Active Directory objects. - -## SYNTAX - -### Filter (Default) -``` -Get-ADObject [-AuthType ] [-Credential ] -Filter [-IncludeDeletedObjects] - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -### Identity -``` -Get-ADObject [-AuthType ] [-Credential ] [-Identity] - [-IncludeDeletedObjects] [-Partition ] [-Properties ] [-Server ] - [] -``` - -### LdapFilter -``` -Get-ADObject [-AuthType ] [-Credential ] [-IncludeDeletedObjects] - -LDAPFilter [-Properties ] [-ResultPageSize ] [-ResultSetSize ] - [-SearchBase ] [-SearchScope ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADObject cmdlet gets an Active Directory object or performs a search to retrieve multiple objects. - -The Identity parameter specifies the Active Directory object to get. -You can identify the object to get by its distinguished name (DN) or GUID. -You can also set the parameter to an Active Directory object variable, such as $\ or pass an object through the pipeline to the Identity parameter. - -To search for and retrieve more than one object, use the Filter or LDAPFilter parameters. -The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. -For more information about the Filter parameter syntax, see about_ActiveDirectory_Filter. -If you have existing LDAP query strings, you can use the LDAPFilter parameter. - -This cmdlet gets a default set of Active Directory object properties. -To get additional properties use the Properties parameter. -For more information about the how to determine the properties for computer objects, see the Properties parameter description. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADObject -LDAPFilter "(objectClass=site)" -SearchBase 'CN=Configuration,DC=Fabrikam,DC=Com' -Properties CanonicalName | FT Name,CanonicalName -A - - -Name CanonicalName ----- ------------- -HQ FABRIKAM.COM/Configuration/Sites/HQ -BO1 FABRIKAM.COM/Configuration/Sites/BO1 -BO2 FABRIKAM.COM/Configuration/Sites/BO2 -BO3 FABRIKAM.COM/Configuration/Sites/BO3 -``` - -Description - ------------ - -Displays a list of sites for Fabrikam using the LDAP filter syntax. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADObject -Filter 'ObjectClass -eq "site"' -SearchBase 'CN=Configuration,DC=Fabrikam,DC=Com' -Properties siteObjectBL | foreach {$_.siteObjectBL} - - -CN=192.167.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.166.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.168.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.165.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.164.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.163.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.162.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.161.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.160.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.159.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.158.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -CN=192.157.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM -``` - -Description - ------------ - -Gets the Site objects from the Configuration Naming Context and then enumerates through the list outputting 'siteObjectBL'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>$changeDate = New-Object DateTime(2008, 11, 18, 1, 40, 02); Get-ADObject -Filter 'whenChanged -gt $changeDate' -IncludeDeletedObjects -``` - -Description - ------------ - -Gets all the objects, including the deleted ones, whose 'whenChanged' attribute is greater than the specified date. -Note that both deleted and non-deleted (and non-recycled) objects matching the filter will be returned. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$changeDate = New-Object DateTime(2008, 11, 18, 1, 40, 02) -Get-ADObject -Filter 'whenChanged -gt $changeDate -and isDeleted -eq $true -and -not (isRecycled -eq $true) -and name -ne "Deleted Objects"' -IncludeDeletedObjects - -ObjectGUID : 98118958-91c7-437d-8ada-ba0b66db823b -Deleted : True -DistinguishedName : CN=Andrew Ma\0ADEL:98118958-91c7-437d-8ada-ba0b66db823b,CN=Deleted Objects,DC=FABRIKAM,DC=COM -Name : Andrew Ma -DEL:98118958-91c7-437d-8ada-ba0b66db823b -ObjectClass : user -``` - -Description - ------------ - -Gets all the deleted objects, whose 'whenChanged' attribute is greater than the specified date. -The clause 'name -ne "Deleted Objects"' makes sure that the Deleted Objects Container is not returned. -This will only return objects which can be restored - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>$changeDate = New-Object DateTime(2008, 11, 18, 1, 40, 02) -Get-ADObject -Filter 'whenChanged -gt $changeDate -and isDeleted -eq $true -and -not (isRecycled -eq $true) -and lastKnownParent -eq "OU=Accounting,DC=Fabrikam,DC=com"' -IncludeDeletedObjects - -ObjectGUID : 12d53e7f-aaf7-4790-b41a-da19044504db -Deleted : True -DistinguishedName : CN=Craig Dewar\0ADEL:12d53e7f-aaf7-4790-b41a-da19044504db,CN=Deleted Objects,DC=Fabrikam,DC=com -Name : Craig Dewar -DEL:12d53e7f-aaf7-4790-b41a-da19044504db -ObjectClass : user -``` - -Description - ------------ - -Gets all the deleted objects whose 'whenChanged' attribute is greater then the specified date AND at the time of deletion were the children of the specified Organizational Unit. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Get-ADObject -Identity "DC=AppNC" -server "FABRIKAM-SRV1:60000" - -ObjectGUID DistinguishedName Name ObjectClass ----------- ----------------- ---- ----------- -62b2e185-9322-4980-9c93-cf... DC=AppNC AppNC domainDNS -``` - -Description - ------------ - -Gets the information of the domainDNS object of an LDS instance - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeDeletedObjects -Specifies to retrieve deleted objects and the deactivated forward and backward links. -When this parameter is specified, the cmdlet uses the following LDAP controls: - -Show Deleted Objects (1.2.840.113556.1.4.417) - -Show Deactivated Links (1.2.840.113556.1.4.2065) - -Note: If this parameter is not specified, the cmdlet will not return or operate on deleted objects. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -The following example shows how to set this parameter to search under an OU. - --SearchBase "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. -If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown. - -The following example shows how to set this parameter to an empty string. --SearchBase "" - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -Possible values for this parameter are: - -Base or 0 - -OneLevel or 1 - -Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -The following example shows how to set this parameter to a subtree search. - --SearchScope Subtree - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: Subtree -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -An Active Directory object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADObject -Derived types, such as the following are also accepted: - Microsoft.ActiveDirectory.Management.ADGroup - Microsoft.ActiveDirectory.Management.ADUser - Microsoft.ActiveDirectory.Management.ADComputer - Microsoft.ActiveDirectory.Management.ADServiceAccount - Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - Microsoft.ActiveDirectory.Management.ADDomain -Returns one or more Active Directory objects. - -The Get-ADObject cmdlet returns a default set of ADObject property values. -To retrieve additional ADObject properties, use the Properties parameter of the cmdlet. - -To view the properties for an ADObject object, see the following examples. -To run these examples, replace \ with an Active Directory object identifier. - -To get a list of the default set of properties of an ADObject object, use the following command: - -Get-ADObject \| Get-Member - -To get a list of all the properties of an ADObject object, use the following command: - -Get-ADObject \ -Properties ALL | Get-Member - -## NOTES - -## RELATED LINKS - -[New-ADObject](./New-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADOptionalFeature.md b/docset/winserver2012-ps/activedirectory/Get-ADOptionalFeature.md deleted file mode 100644 index 344a155724..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADOptionalFeature.md +++ /dev/null @@ -1,550 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adoptionalfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADOptionalFeature - -## SYNOPSIS -Gets one or more Active Directory optional features. - -## SYNTAX - -### Filter (Default) -``` -Get-ADOptionalFeature [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -### Identity -``` -Get-ADOptionalFeature [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADOptionalFeature [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADOptionalFeature cmdlet gets an optional feature or performs a search to retrieve multiple optional features from an Active Directory. - -The Identity parameter specifies the Active Directory optional feature that you want to get. -You can identify an optional feature by its distinguished name (DN), feature GUID, or object GUID. -You can also set the parameter to an optional feature object variable, such as $\ or you can pass an optional feature object through the pipeline to the Identity parameter. - -To search for and retrieve more than one optional feature, use the Filter or LDAPFilter parameters. -The Filter parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the Filter parameter. -For more information about the Filter parameter syntax, see about_ActiveDirectory_Filter. -If you have existing LDAP query strings, you can use the LDAPFilter parameter. - -This cmdlet retrieves a default set of optional feature object properties. -To retrieve additional properties use the Properties parameter. -For more information about the how to determine the properties for computer objects, see the Properties parameter description. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADOptionalFeature -Filter * -``` - -Description - ------------ - -Get a list of all the available optional features in the current forest. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADOptionalFeature 'Recycle Bin Feature' -``` - -Description - ------------ - -Get the optional feature with the name 'Recycle Bin Feature'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADOptionalFeature 766ddcd8-acd0-445e-f3b9-a7f9b6744f2a -``` - -Description - ------------ - -Get the optional feature with the feature guid '766ddcd8-acd0-445e-f3b9-a7f9b6744f2a'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADOptionalFeature 'Recycle Bin Feature' -server server1:50000 -``` - -Description - ------------ - -Get the 'Recycle Bin Feature' optional feature in an AD LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory optional feature object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Fully qualified domain name - -Example: corp.contoso.com - -Feature GUID (featureGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Object GUID (objectGUID) - -Example: 482ab21c-823e-401e-879a-ac7383d64eb9 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an optional feature object instance. - -This example shows how to set the parameter to a fully qualified domain name. - --Identity "corp.contoso.com" - -This example shows how to set this parameter to an optional feature object instance named "optionalFeatureInstance". - --Identity $optionalFeatureInstance - -```yaml -Type: ADOptionalFeature -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -The following example shows how to set this parameter to search under an OU. - --SearchBase "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. -If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown. - -The following example shows how to set this parameter to an empty string. --SearchBase "" - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -Possible values for this parameter are: - -Base or 0 - -OneLevel or 1 - -Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -The following example shows how to set this parameter to a subtree search. - --SearchScope Subtree - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOptionalFeature -An optional feature object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADOptionalFeature -Returns one or more optional feature objects. - -This cmdlet returns a default set of ADOptionalFeature property values. -To retrieve additional ADOptionalFeature properties, use the Properties parameter. - -To view the properties for an ADOptionalFeature object, see the following examples. -To run these examples, replace \ with an optional feature identifier, such as distinguished name of the optional feature. - -To get a list of the default set of properties of an ADOptionalFeature object, use the following command: - -Get-ADOptionalFeature \| Get-Member - -To get a list of all the properties of an ADOptionalFeature object, use the following command: - -Get-ADOptionalFeature \ -Properties ALL | Get-Member - -## NOTES - -## RELATED LINKS - -[Disable-ADOptionalFeature](./Disable-ADOptionalFeature.md) - -[Enable-ADOptionalFeature](./Enable-ADOptionalFeature.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADOrganizationalUnit.md b/docset/winserver2012-ps/activedirectory/Get-ADOrganizationalUnit.md deleted file mode 100644 index c96542a353..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADOrganizationalUnit.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adorganizationalunit?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADOrganizationalUnit - -## SYNOPSIS -Gets one or more Active Directory organizational units. - -## SYNTAX - -### Filter (Default) -``` -Get-ADOrganizationalUnit [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -### Identity -``` -Get-ADOrganizationalUnit [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-Properties ] [-Server ] - [] -``` - -### LdapFilter -``` -Get-ADOrganizationalUnit [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -## DESCRIPTION -The **Get-ADOrganizationalUnit** cmdlet gets an organizational unit (OU) object or performs a search to get multiple OUs. - -The *Identity* parameter specifies the Active Directory OU to get. -You can identify an OU by its distinguished name or GUID. -You can also set the parameter to an OU object variable, such as `$` or pass an OU object through the pipeline to the *Identity* parameter. - -To search for and retrieve more than one OU, use the *Filter* or *LDAPFilter* parameters. -The *Filter* parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the *Filter* parameter. -For more information about the *Filter* parameter syntax, type `Get-Help about_ActiveDirectory_Filter`. -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the *LDAPFilter* parameter. - -This cmdlet gets a default set of OU object properties. -To get additional properties, use the *Properties* parameter. -For more information about the how to determine the properties for computer objects, see the *Properties* parameter description.. - -## EXAMPLES - -### Example 1: Get all of the OUs in a domain -```powershell -PS C:\>Get-ADOrganizationalUnit -Filter 'Name -like "*"' | Format-Table Name, DistinguishedName -A -``` -```output -Name DistinguishedName ----- ----------------- -Domain Controllers OU=Domain Controllers,DC=FABRIKAM,DC=COM -UserAccounts OU=UserAccounts,DC=FABRIKAM,DC=COM -Sales OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM -Marketing OU=Marketing,OU=UserAccounts,DC=FABRIKAM,DC=COM -Production OU=Production,OU=UserAccounts,DC=FABRIKAM,DC=COM -HumanResources OU=HumanResources,OU=UserAccounts,DC=FABRIKAM,DC=COM -NorthAmerica OU=NorthAmerica,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM -SouthAmerica OU=SouthAmerica,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM -Europe OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM -AsiaPacific OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM -Finance OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM -Corporate OU=Corporate,OU=UserAccounts,DC=FABRIKAM,DC=COM -ApplicationServers OU=ApplicationServers,DC=FABRIKAM,DC=COM -Groups OU=Groups,OU=Managed,DC=FABRIKAM,DC=COM -PasswordPolicyGroups OU=PasswordPolicyGroups,OU=Groups,OU=Managed,DC=FABRIKAM,DC=COM -Managed OU=Managed,DC=FABRIKAM,DC=COM -ServiceAccounts OU=ServiceAccounts,OU=Managed,DC=FABRIKAM,DC=COM -``` - -This command gets all of the OUs in a domain. - -### Example 2: Get an OU by its distinguished name -```powershell -PS C:\> Get-ADOrganizationalUnit -Identity 'OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM' | Format-Table Name,Country,PostalCode,City,StreetAddress,State -A -``` -```output -Name Country PostalCode City StreetAddress State ----- ------- ---------- ---- ------------- ----- -AsiaPacific AU 4171 Balmoral 45 Martens Place QLD -``` - -This command gets the OU with the distinguished name OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### Example 3: Get child OUs -```powershell -PS C:\> Get-ADOrganizationalUnit -LDAPFilter '(name=*)' -SearchBase 'OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM' -SearchScope OneLevel | Format-Table Name,Country,PostalCode,City,StreetAddress,State -``` -```output -Name Country PostalCode City StreetAddress State ----- ------- ---------- ---- ------------- ----- -AsiaPacific AU 4171 Balmoral 45 Martens Place QLD -Europe UK NG34 0NI QUARRINGTON 22 Station Rd -NorthAmerica US 02142 Cambridge 1634 Randolph Street MA -``` - -This command gets OUs underneath the Sales OU using an LDAP filter. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. - -Note: PowerShell wildcards other than *, such as ?, are not supported by the *Filter* syntax. - -Note: To query using LDAP query strings, use the *LDAPFilter* parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory organizational unit object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Account Manager account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADOrganizationalUnit -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The *Filter* parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help about_ActiveDirectory_Filter`. - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In Active Directory Lightweight Directory Services (AD LDS) environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an AD DS query. - -The default is 256 objects per page. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an AD DS query. -If you want to receive all of the objects, set this parameter to $Null (null value). -You can use Ctrl+C to stop the query and return of objects. - -The default is $Null. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target AD LDS instance if one has been specified by setting the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -When the value of the *SearchBase* parameter is set to an empty string and you are connected to a global catalog (GC) port, all partitions are searched. -If the value of the *SearchBase* parameter is set to an empty string and you are not connected to a GC port, an error is thrown. - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -The acceptable values for this parameter are: - -- Base or 0 -- OneLevel or 1 -- Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: Subtree -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. - -Specify the AD DS instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOrganizationalUnit -An OU object is received by the *Identity* parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADOrganizationalUnit -Returns one or more OU objects. - -This cmdlet returns a default set of **ADOrganizational** property values. -To retrieve additional **ADOrganizational** properties, use the *Properties* parameter. - -To view the properties for an **ADOrganizational** object, see the following examples. -To run these examples, replace \ with an OU identifier such as the distinguished name of an OU. - -To get a list of the default set of properties of an **ADOrganizational** object, use the following command: - -`Get-ADOrganizationalUnit`\`| Get-Member` - -To get a list of all the properties of an **ADOrganizational** object, use the following command: - -`Get-ADOrganizationalUnit`\`-Properties * | Get-Member` - -## NOTES - -## RELATED LINKS - -[New-ADOrganizationalUnit](./New-ADOrganizationalUnit.md) - -[Set-ADOrganizationalUnit](./Set-ADOrganizationalUnit.md) - -[Remove-ADOrganizationalUnit](./Remove-ADOrganizationalUnit.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADPrincipalGroupMembership.md b/docset/winserver2012-ps/activedirectory/Get-ADPrincipalGroupMembership.md deleted file mode 100644 index 64285ba98c..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADPrincipalGroupMembership.md +++ /dev/null @@ -1,476 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adprincipalgroupmembership?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADPrincipalGroupMembership - -## SYNOPSIS -Gets the Active Directory groups that have a specified user, computer, group, or service account. - -## SYNTAX - -``` -Get-ADPrincipalGroupMembership [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-ResourceContextPartition ] [-ResourceContextServer ] - [-Server ] [] -``` - -## DESCRIPTION -The Get-ADPrincipalGroupMembership cmdlet gets the Active Directory groups that have a specified user, computer, group, or service account as a member. -This cmdlet requires a global catalog to perform the group search. -If the forest that contains the user, computer or group does not have a global catalog, the cmdlet returns a non-terminating error. -If you want to search for local groups in another domain, use the ResourceContextServer parameter to specify the alternate server in the other domain. - -The Identity parameter specifies the user, computer, or group object that you want to determine group membership for. -You can identify a user, computer, or group object by its distinguished name (DN), GUID, security identifier (SID) or SAM account name. -You can also specify a user, group, or computer object variable, such as $\, or pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADGroup cmdlet to retrieve a group object and then pass the object through the pipeline to the Get-ADPrincipalGroupMembership cmdlet. -Similarly, you can use Get-ADUser or Get-ADComputer to get user and computer objects to pass through the pipeline. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>get-adprincipalgroupmembership -server localhost:60000 -identity "CN=GlenJohns,DC=AppNC" -partition "DC=AppNC" -``` - -Description - ------------ - -Retrieve all the groups the user 'CN=GlenJohns,DC=AppNC' is a member of on an AD LDS instance. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>get-adprincipalgroupmembership -Identity Administrator - -distinguishedName : CN=Domain Users,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Global -name : Domain Users -objectClass : group -objectGUID : 86c0f0d5-8b4d-4f35-a867-85a006b92902 -SamAccountName : Domain Users -SID : S-1-5-21-41432690-3719764436-1984117282-513 - -distinguishedName : CN=Administrators,CN=Builtin,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : DomainLocal -name : Administrators -objectClass : group -objectGUID : 02ce3874-dd86-41ba-bddc-013f34019978 -SamAccountName : Administrators -SID : S-1-5-32-544 - -distinguishedName : CN=Schema Admins,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Universal -name : Schema Admins -objectClass : group -objectGUID : 8d62890f-385e-4cfa-9b2a-c72576097583 -SamAccountName : Schema Admins -SID : S-1-5-21-41432690-3719764436-1984117282-518 - -distinguishedName : CN=Enterprise Admins,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Universal -name : Enterprise Admins -objectClass : group -objectGUID : 0215b0a5-aea1-40da-b598-720efe930ddf -SamAccountName : Enterprise Admins -SID : S-1-5-21-41432690-3719764436-1984117282-519 - -distinguishedName : CN=Domain Admins,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Global -name : Domain Admins -objectClass : group -objectGUID : 5ccc6037-c2c9-42be-8e92-c8f98afd0011 -SamAccountName : Domain Admins -SID : S-1-5-21-41432690-3719764436-1984117282-512 - -distinguishedName : CN=Group Policy Creator Owners,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Global -name : Group Policy Creator Owners -objectClass : group -objectGUID : a58f7bf2-fd20-4bbd-96f0-ee10fa1613c7 -SamAccountName : Group Policy Creator Owners -SID : S-1-5-21-41432690-3719764436-1984117282-520 -``` - -Description - ------------ - -Retrieve all the groups the administrator is a member of. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>get-adprincipalgroupmembership -Identity Administrator -ResourceContextServer ChildDomain.Fabrikam.Com -ResourceContextPartition "DC=Fabrikam,DC=com" - -distinguishedName : CN=Domain Users,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Global -name : Domain Users -objectClass : group -objectGUID : 86c0f0d5-8b4d-4f35-a867-85a006b92902 -SamAccountName : Domain Users -SID : S-1-5-21-41432690-3719764436-1984117282-513 - -distinguishedName : CN=Group Policy Creator Owners,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Global -name : Group Policy Creator Owners -objectClass : group -objectGUID : a58f7bf2-fd20-4bbd-96f0-ee10fa1613c7 -SamAccountName : Group Policy Creator Owners -SID : S-1-5-21-41432690-3719764436-1984117282-520 - -distinguishedName : CN=Enterprise Admins,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Universal -name : Enterprise Admins -objectClass : group -objectGUID : 0215b0a5-aea1-40da-b598-720efe930ddf -SamAccountName : Enterprise Admins -SID : S-1-5-21-41432690-3719764436-1984117282-519 - -distinguishedName : CN=Schema Admins,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Universal -name : Schema Admins -objectClass : group -objectGUID : 8d62890f-385e-4cfa-9b2a-c72576097583 -SamAccountName : Schema Admins -SID : S-1-5-21-41432690-3719764436-1984117282-518 - -distinguishedName : CN=Domain Admins,CN=Users,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : Global -name : Domain Admins -objectClass : group -objectGUID : 5ccc6037-c2c9-42be-8e92-c8f98afd0011 -SamAccountName : Domain Admins -SID : S-1-5-21-41432690-3719764436-1984117282-512 - -distinguishedName : CN=Administrators,CN=Builtin,DC=Fabrikam,DC=com -GroupCategory : Security -GroupScope : DomainLocal -name : Administrators -objectClass : group -objectGUID : 02ce3874-dd86-41ba-bddc-013f34019978 -SamAccountName : Administrators -SID : S-1-5-32-544 -``` - -Description - ------------ - -Retrieve all the groups the adminsitrator account in the local domain is a member of in the resource domain ChildDomain.Fabrikam.Com - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory principal object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -- Microsoft.ActiveDirectory.Management.ADGroup -- Microsoft.ActiveDirectory.Management.ADUser -- Microsoft.ActiveDirectory.Management.ADComputer -- Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a principal object instance named "principalInstance". - --Identity $principalInstance - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceContextPartition -Specifies the distinguished name of the partition of an AD or AD LDS instance to search. -Use this parameter with the ResourceContextServer parameter to specify a partition hosted by the specified server. -If the ResourceContextPartition parameter is not specified, the default partition of the ResourceContextServer is searched. - -The following example shows how to set this parameter. - --ResourceContextPartition "cn=employees,dc=corp,dc=contoso,dc=com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceContextServer -Specifies that the cmdlet return a list of groups that the user is a member of and that reside in the specified domain. -Use this parameter to search for groups in a domain that is not the domain where the user's account resides. -To search a partition other than the default partition in this domain, also specify the ResourceContextPartition parameter. - -The following example shows how to specify this parameter. - --ResourceContextServer "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADPrincipal -A principal object that represents a user, computer or group is received by the Identity parameter. -Derived types, such as the following are also received by this parameter. - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADGroup - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADGroup -Returns group objects that have the specified user, computer, group or service account as a member. - -The Get-ADPrincipalGroupMembership cmdlet returns a default set of ADGroup property values. -To retrieve additional ADGroup properties pass the ADGroups objects produced by this cmdlet through the pipline to Get-ADGroup. -Specify the additional properties required from the group objects by passing the -Properties parameter to Get-ADGroup. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[Get-ADUser](./Get-ADUser.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - -[Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationAttributeMetadata.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationAttributeMetadata.md deleted file mode 100644 index 30f9bfa116..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationAttributeMetadata.md +++ /dev/null @@ -1,306 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationattributemetadata?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationAttributeMetadata - -## SYNOPSIS -Returns the replication metadata for one or more Active Directory replication partners. - -## SYNTAX - -``` -Get-ADReplicationAttributeMetadata [-AuthType ] [-Credential ] [-Filter ] - [-IncludeDeletedObjects] [-Object] [[-Properties] ] [-Server] - [-ShowAllLinkedValues] [] -``` - -## DESCRIPTION -The Get-ADReplicationAttributeMetadata cmdlet returns the replication metadata for one or more attributes on a given object. -The metadata is contained in the following two directory objects: - -single-value attribute: msDS-ReplAttributeMetaData - -multi-value attribute: msDS-ReplValueMetaData - -The cmdlet parses the byte array(s) and returns the data in a readable format. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationAttributeMetadata "CN=Domain Admins,CN=Users,DC=corp,DC=contoso,DC=com" corp-DC01 -ShowAllLinkedValues -``` - -Description - ------------ - -Get the replication metadata for the attributes of a group with Distinguished Name "CN=Domain Admins,CN=Users,DC=corp,DC=contoso,DC=com" from the CORP-DC01 domain controller. -By including the -ShowAllLinkedValues switch parameter if a multi-valued attribute is present, all its linked values are also retrieved. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationAttributeMetadata "1A7BFEC6-C92C-4804-94B0-D407E51F1B64" corp-DC01 -IncludeDeletedObjects -``` - -Description - ------------ - -Get the replication metadata for the attributes of an object with GUID "1A7BFEC6-C92C-4804-94B0-D407E51F1B64", including the deleted objects and the deactivated forward and backward links. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADObject -Filter 'objectclass -eq "group"' | Get-ADReplicationAttributeMetadata -Server corp-DC01 | Where-Object {$_.lastoriginatingchangetime -like "*11/10/2011*"} | Format-Table object -``` - -Description - ------------ - -Get all groups that have any of their attributes modified on 11/10/2011. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a filter in the provider's format or language. -The value of this parameter qualifies the Path parameter. -The syntax of the filter, including the use of wildcards, depends on the provider. -Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDeletedObjects -Specifies to retrieve deleted objects and the deactivated forward and backward links. -When this parameter is specified, the cmdlet uses the following LDAP controls: - -Show Deleted Objects (1.2.840.113556.1.4.417) - -Show Deactivated Links (1.2.840.113556.1.4.2065) - -Note: If this parameter is not specified, the cmdlet will not return or operate on deleted objects. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Object -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Properties -Specifies a list of one or more attribute names as a comma separated list to return the metadata for replication partners. -This parameter also accepts * to indicate that all attributes set on the object should be returned. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property, Attribute, Attributes - -Required: False -Position: 2 -Default value: * (all properties) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowAllLinkedValues -Specifying this switch returns all linked values if the attribute returned is multi-valued. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False; by default, only the linked value with the highest USN is returned -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADObject -A class structure that represents the Active Directory objects. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationAttributeMetadata -A class structure that represents Active Directory replication attribute metadata objects. - -## NOTES -* The default behavior for this cmdlet is to prompt for object identity. Other tools that have been provided to manage this feature in previous releases of Windows Server include the Repadmin.exe command-line tool. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationConnection.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationConnection.md deleted file mode 100644 index a728a00ec6..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationConnection.md +++ /dev/null @@ -1,376 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationconnection?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationConnection - -## SYNOPSIS -Returns a specific Active Directory replication connection or a set of AD replication connection objects based on a specified filter. - -## SYNTAX - -### Filter (Default) -``` -Get-ADReplicationConnection [-AuthType ] [-Credential ] [-Filter ] - [-Properties ] [-Server ] [] -``` - -### Identity -``` -Get-ADReplicationConnection [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADReplicationConnection cmdlet returns a specific Active Directory replication connection or a set of AD replication connection objects based on a specified filter. -Connections are used to enable domain controllers to replicate with each other. -A connection defines a one-way, inbound route from one domain controller, the source, to another domain controller, the destination. -The Knowledge Consistency Checker (KCC) reuses existing connections where it can, deletes unused connections, and creates new connections if none exist that meet the current need. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationConnection -Filter * -``` - -Description - ------------ - -Get all the replication connections. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationConnection -Filter "ReplicateFromDirectoryServer -eq 'corp-DC01'" -``` - -Description - ------------ - -Get all replication connections that replicate from corp-DC01. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationConnection "5f98e288-19e0-47a0-9677-57f05ed54f6b" -``` - -Description - ------------ - -Get the replication connection with name '5f98e288-19e0-47a0-9677-57f05ed54f6b'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationConnection "5f98e288-19e0-47a0-9677-57f05ed54f6b" -Properties * -``` - -Description - ------------ - -Get all the properties of the replication connection with name '5f98e288-19e0-47a0-9677-57f05ed54f6b'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationConnection -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationConnection -A connection object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationConnection - -## NOTES - -## RELATED LINKS - -[Set-ADReplicationConnection](./Set-ADReplicationConnection.md) diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationFailure.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationFailure.md deleted file mode 100644 index 2ba4465d3b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationFailure.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationfailure?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationFailure - -## SYNOPSIS -Returns a collection of data describing an Active Directory replication failure. - -## SYNTAX - -### Target (Default) -``` -Get-ADReplicationFailure [-AuthType ] [-Credential ] [-EnumeratingServer ] - [-Filter ] [-Target] [] -``` - -### Scope -``` -Get-ADReplicationFailure [-AuthType ] [-Credential ] [-EnumeratingServer ] - [-Filter ] [-Scope] [[-Target] ] [] -``` - -## DESCRIPTION -The Get-ADReplicationFailure cmdlet returns all failures currently associated with a given domain controller or Active Directory Lightweight Directory Services (AD LDS) instance. -The return object is of type ADReplicationFailure. -This cmdlet returns the list of failures in the ADReplicationSummary object for a specific server. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationFailure -Target corp-DC01 -``` - -Description - ------------ - -Get a collection of data describing an Active Directory replication failure for corp-DC01. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationFailure -Target corp-DC01 -Scope Server -``` - -Description - ------------ - -Get a collection of data describing an Active Directory replication failure from corp-DC01 (same as above). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationFailure -Target corp-DC01,corp-DC02 -``` - -Description - ------------ - -Get a collection of data describing an Active Directory replication failure from corp-DC01 and corp-DC02. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationFailure -Target NorthAmerica -Scope Site -``` - -Description - ------------ - -Get a collection of data describing Active Directory replication failures from all the domain controllers in the site 'NorthAmerica'. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADReplicationFailure -Target "corp.contoso.com" -Scope Domain -``` - -Description - ------------ - -Get a collection of data describing Active Directory replication failures from all the domain controllers in the domain 'corp.contoso.com'. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Get-ADReplicationFailure -Target "corp.contoso.com" -Scope Forest -``` - -Description - ------------ - -Get a collection of data describing Active Directory replication failures from all the domain controllers in the forest 'corp.contoso.com' - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnumeratingServer -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a filter in the provider's format or language. -The value of this parameter qualifies the Path parameter. -The syntax of the filter, including the use of wildcards, depends on the provider. -Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the type of object used as input by the Target parameter. -The following are allowable values to use: - -Server - -Site - -Domain - -Forest - -```yaml -Type: ADScopeType -Parameter Sets: Scope -Aliases: ReplicationSite -Accepted values: Server, Domain, Forest, Site - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies either one or more (using a comma separated list) of Active Directory domain controllers, sites, domains, or forests. -It will return results for all the domain controllers that are specified or that are part of the specified container. - -```yaml -Type: Object[] -Parameter Sets: Target -Aliases: Name, HostName, Site, Domain, Forest - -Required: True -Position: 0 -Default value: DCLocator; Provider: -Server of the connected drive -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Object[] -Parameter Sets: Scope -Aliases: Name, HostName, Site, Domain, Forest - -Required: False -Position: 0 -Default value: DCLocator; Provider: -Server of the connected drive -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDirectoryServer -A class structure that contains one or more Active Directory server objects. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationFailure -A class structure that represents Active Directory replication failure objects. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationPartnerMetadata.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationPartnerMetadata.md deleted file mode 100644 index 251584a141..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationPartnerMetadata.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationpartnermetadata?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationPartnerMetadata - -## SYNOPSIS -Returns the replication metadata for a set of one or more replication partners. - -## SYNTAX - -### Target (Default) -``` -Get-ADReplicationPartnerMetadata [-AuthType ] [-Credential ] - [-EnumerationServer ] [-Filter ] [[-Partition] ] [[-PartnerType] ] - [-Target] [] -``` - -### Scope -``` -Get-ADReplicationPartnerMetadata [-AuthType ] [-Credential ] - [-EnumerationServer ] [-Filter ] [[-Partition] ] [[-PartnerType] ] - [-Scope] [[-Target] ] [] -``` - -## DESCRIPTION -The Get-ADReplicationPartnerMetadata cmdlet returns an Active Directory replication partner metadata object for each of its replication partners which contains all of the relevant replication data for the partners involved. -This includes attributes such as LastReplicationSuccess or LastReplicationAttempt and other data specific to each pairing of replication partners. -If the results are too verbose for your needs, you can use the Partition parameter to specify a partition to narrow down the results. -Optionally, you can use the Filter parameter to narrow down results as well. -If no partition or filter are specified for the results, the default naming context is used and metadata for all replication partners is returned. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationPartnerMetadata -Target corp-DC01 -``` - -Description - ------------ - -Get the replication metadata between corp-DC01 and its inbound partners for the default partition only. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationPartnerMetadata -Target corp-DC01 -PartnerType Inbound -``` - -Description - ------------ - -Get the replication metadata between corp-DC01 and its inbound partners for the default partition only (same as above). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationPartnerMetadata -Target corp-DC01,corp-DC02 -PartnerType Both -Partition Schema -``` - -Description - ------------ - -Get the replication metadata between corp-DC01, corp-DC02 and their respective partners only (both inbound and outbound) for the schema partition. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationPartnerMetadata -Target NorthAmerica -Scope Site -Partition * -``` - -Description - ------------ - -Get the replication metadata for all the inbound partners of all the domain controllers within the 'NorthAmerica' site for all hosted partitions. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADReplicationPartnerMetadata -Target "corp.contoso.com" -Scope Domain -``` - -Description - ------------ - -Get the replication metadata for all the domain controllers that are inbound partners for the default partition in the domain 'corp.contoso.com'. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Get-ADReplicationPartnerMetadata -Target "corp.contoso.com" -Scope Forest -Partition Configuration -``` - -Description - ------------ - -Get the replication metadata for all the domain controllers that are inbound partners for the configuration partition in the forest 'corp.contoso.com'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnumerationServer -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a filter in the provider's format or language. -The value of this parameter qualifies the Path parameter. -The syntax of the filter, including the use of wildcards, depends on the provider. -Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: NC, NamingContext - -Required: False -Position: 2 -Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PartnerType -An enumeration of the replication types returned by this cmdlet. -The following are the allowable values for this parameter: Inbound, Outbound, Both. - -```yaml -Type: ADPartnerType -Parameter Sets: (All) -Aliases: -Accepted values: Inbound, Outbound, Both - -Required: False -Position: 3 -Default value: Inbound -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the scope type for the Target parameter when used as input. -The allowable values for this parameter are: - -Server - -Site - -Domain - -Forest - -```yaml -Type: ADScopeType -Parameter Sets: Scope -Aliases: -Accepted values: Server, Domain, Forest, Site - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the target for returning replication partner metadata as either one or more domain controllers, sites, domains, or forests. -If multiple values for the target are to be specified, they need to be separated by commas. -This parameter will return results for all the domain controllers specified or for part of the specified container. - -```yaml -Type: Object[] -Parameter Sets: Target -Aliases: Name, HostName, Site, Domain, Forest - -Required: True -Position: 0 -Default value: DCLocator; Provider: -Server of the connected drive -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Object[] -Parameter Sets: Scope -Aliases: Name, HostName, Site, Domain, Forest - -Required: False -Position: 0 -Default value: DCLocator; Provider: -Server of the connected drive -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDirectoryServer -A class structure that represents Active Directory server objects. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationPartnerMetadata -A class structure that represents Active Directory replication partner metadata objects. - -## NOTES -* The default behavior for this cmdlet is to prompt for server identity. Other tools that have been made available in prior releases of Windows Server to manage replication partnerships include Active Directory Sites and Services and the Repadmin.exe tool. If this cmdlet is aliased, it should use "ReplSummary" as the alias name value. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationQueueOperation.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationQueueOperation.md deleted file mode 100644 index 2eea0dd221..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationQueueOperation.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationqueueoperation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationQueueOperation - -## SYNOPSIS -Returns the contents of the replication queue for a specified server. - -## SYNTAX - -``` -Get-ADReplicationQueueOperation [-AuthType ] [-Credential ] [-Server] - [-Filter ] [[-Partition] ] [] -``` - -## DESCRIPTION -The Get-ADReplicationQueueOperation cmdlet returns all of the pending operations in the replication queue. -While replication operations are pending, this cmdlet can be useful for determining the status of queued operations. - -The Get-ADReplicationQueueOperation cmdlet can be called from script to watch and observe when operations get moved out of the queue as they are replicated. -It also allows for filtering on any of the properties on the ADReplicationOperation object. - -The replication queue operates in the following manner: suppose a domain controller has five inbound replication connections. -As the domain controller formulates change requests, either by a schedule being reached or from a notification, it adds a work item for each request to the end of the queue of pending synchronization requests. -Each pending synchronization request represents one \ pair, such as "synchronize the schema directory partition from DC1," or "delete the ApplicationX directory partition." - -When a work item has been received into the queue, notification and polling intervals do not apply. -Instead, the domain controller processes the item (begins synchronizing from its source) as soon as the work item reaches the front of the replication queue. -This process continues until either the destination is fully synchronized with the source domain controller, an error occurs, or the synchronization is pre-empted by a higher-priority operation. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationQueueOperation "corp-DC01.corp.contoso.com" -``` - -Description - ------------ - -Get the pending operations in the replication queue for the domain controller "corp-DC01" as specified by its fully qualified domain name (FQDN). - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a filter in the provider's format or language. -The value of this parameter qualifies the Path parameter. -The syntax of the filter, including the use of wildcards, depends on the provider. -Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: NC, NamingContext - -Required: False -Position: 2 -Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDirectoryServer -A class structure that represents one or more Active Directory servers. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationOperation -A class structure that represents one or more Active Directory replication operations. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSite.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationSite.md deleted file mode 100644 index 4f68199068..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSite.md +++ /dev/null @@ -1,381 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationsite?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationSite - -## SYNOPSIS -Returns a specific Active Directory replication site or a set of replication site objects based on a specified filter. - -## SYNTAX - -### Identity (Default) -``` -Get-ADReplicationSite [-AuthType ] [-Credential ] [[-Identity] ] - [-Properties ] [-Server ] [] -``` - -### Filter -``` -Get-ADReplicationSite [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADReplicationSite cmdlet returns a specific Active Directory replication site or a set of replication site objects based on a specified filter. -Sites are used in Active Directory to either enable clients to discover network resources (published shares, domain controllers) close to the physical location of a client computer or to reduce network traffic over wide area network (WAN) links. -Sites can also be used to optimize replication between domain controllers. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationSite -Filter * -``` - -Description - ------------ - -Get all the sites. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSite -Properties * -Filter "WindowsServer2003KCCSiteLinkBridgingEnabled -eq `$True" -``` - -Description - ------------ - -Get all sites that have the WindowsServer2003KCCBehaviorEnabled flag turned on. -(The **-Properties** parameter must be set because the WindowsServer2003KCCSiteLinkBridgingEnabled property is not retrieved by default.) - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationSite NorthAmerica -``` - -Description - ------------ - -Get the site with name 'NorthAmerica'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationSite NorthAmerica -Properties AutomaticInterSiteTopologyGenerationEnabled -``` - -Description - ------------ - -Get the AutomaticInterSiteTopologyGenerationEnabled property of the site with name 'NorthAmerica'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSite -Parameter Sets: Identity -Aliases: - -Required: False -Position: 0 -Default value: All Sites (Filter *) -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSite -A site object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationSite - -## NOTES - -## RELATED LINKS - -[New-ADReplicationSite](./New-ADReplicationSite.md) - -[Remove-ADReplicationSite](./Remove-ADReplicationSite.md) - -[Set-ADReplicationSite](./Set-ADReplicationSite.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSiteLink.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationSiteLink.md deleted file mode 100644 index d908db00aa..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSiteLink.md +++ /dev/null @@ -1,342 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationsitelink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationSiteLink - -## SYNOPSIS -Returns a specific Active Directory site link or a set of site links based on a specified filter. - -## SYNTAX - -### Filter (Default) -``` -Get-ADReplicationSiteLink [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] -``` - -### Identity -``` -Get-ADReplicationSiteLink [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADReplicationSiteLink cmdlet can be used to return a specific Active Directory site link or a set of site links based on a specified filter. -A site link connects two or more sites. -Site links reflect the administrative policy for how sites are to be interconnected and the methods used to transfer replication traffic. -You must connect sites with site links so that domain controllers at each site can replicate Active Directory changes. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink -Filter * -``` - -Description - ------------ - -Get all the site links. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink -Filter "SitesIncluded -eq 'NorthAmerica'" | FT Name,SitesIncluded -A -``` - -Description - ------------ - -Get all site links that include 'NorthAmerica'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink -Filter "Cost -gt 100 -and ReplicationFrequencyInMinutes -lt 15" -``` - -Description - ------------ - -Get all site links that have a cost greater than 100 and a replication frequency less than 15 minutes. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink "Europe-Asia" -``` - -Description - ------------ - -Get the site link with name 'Europe-Asia'. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink "Europe-Asia" -Properties ReplicationSchedule -``` - -Description - ------------ - -Get the ReplicationSchedule property of the site link with name 'Europe-Asia'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica-SouthAmerica,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSiteLink -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink -A site link object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationSiteLink - -## NOTES - -## RELATED LINKS - -[New-ADReplicationSiteLink](./New-ADReplicationSiteLink.md) - -[Remove-ADReplicationSiteLink](./Remove-ADReplicationSiteLink.md) - -[Set-ADReplicationSiteLink](./Set-ADReplicationSiteLink.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSiteLinkBridge.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationSiteLinkBridge.md deleted file mode 100644 index c3c3fe0078..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSiteLinkBridge.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationsitelinkbridge?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationSiteLinkBridge - -## SYNOPSIS -Returns a specific Active Directory site link bridge or a set of site link bridge objects based on a specified filter. - -## SYNTAX - -### Filter (Default) -``` -Get-ADReplicationSiteLinkBridge [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] -``` - -### Identity -``` -Get-ADReplicationSiteLinkBridge [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADReplicationSiteLinkBridge cmdlet returns a specific Active Directory site link bridge or a set of site link bridge objects based on a specified filter. -A site link bridge connects two or more site links and enables transitivity between site links. -Each site link in a bridge must have a site in common with another site link in the bridge. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLinkBridge -Filter * -``` - -Description - ------------ - -Get all the site link bridges. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLinkBridge -Filter "SiteLinksIncluded -eq 'NorthAmerica-Europe'" | FT Name,SiteLinksIncluded -A -``` - -Description - ------------ - -Get all site link bridges that include site link 'NorthAmerica-Europe'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -``` - -Description - ------------ - -Get the site link bridge with name 'NorthAmerica-Europe' - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -Properties * -``` - -Description - ------------ - -Get all the properties of the site link bridge with name 'NorthAmerica-Europe'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica-Asia,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSiteLinkBridge -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge -A site link bridge object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge - -## NOTES -* By default, the following site link bridge properties are returned: - - - Name - - - Description - - - SiteLinksIncluded - - - DN - -## RELATED LINKS - -[New-ADReplicationSiteLinkBridge](./New-ADReplicationSiteLinkBridge.md) - -[Remove-ADReplicationSiteLinkBridge](./Remove-ADReplicationSiteLinkBridge.md) - -[Set-ADReplicationSiteLinkBridge](./Set-ADReplicationSiteLinkBridge.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSubnet.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationSubnet.md deleted file mode 100644 index 2003fd8b4f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationSubnet.md +++ /dev/null @@ -1,382 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationsubnet?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationSubnet - -## SYNOPSIS -Returns a specific Active Directory subnet or a set of AD subnets based on a specified filter. - -## SYNTAX - -### Filter (Default) -``` -Get-ADReplicationSubnet [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] -``` - -### Identity -``` -Get-ADReplicationSubnet [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADReplicationSubnet cmdlet returns a specific Active Directory subnet or a set of AD subnets based on a specified filter. -Subnet objects (class subnet) define network subnets in Active Directory. -A network subnet is a segment of a TCP/IP network to which a set of logical IP addresses is assigned. -Subnets group computers in a way that identifies their physical proximity on the network. -Subnet objects in Active Directory are used to map computers to sites. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationSubnet -Filter * -``` - -Description - ------------ - -Get all the subnets. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSubnet -Filter "Location -like '*Japan'" -``` - -Description - ------------ - -Get all the subnets in Japan. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationSubnet "10.0.0.0/25" -``` - -Description - ------------ - -Get the subnet with name '10.0.0.0/25'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationSubnet "10.0.0.0/25" -Properties * -``` - -Description - ------------ - -Get all the properties of the subnet with name '10.0.0.0/25'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=10.0.0.0/25,CN=Subnets,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSubnet -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: All Subnets (Filter *) -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet -A subnet object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationSubnet - -## NOTES - -## RELATED LINKS - -[New-ADReplicationSubnet](./New-ADReplicationSubnet.md) - -[Remove-ADReplicationSubnet](./Remove-ADReplicationSubnet.md) - -[Set-ADReplicationSubnet](./Set-ADReplicationSubnet.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADReplicationUpToDatenessVectorTable.md b/docset/winserver2012-ps/activedirectory/Get-ADReplicationUpToDatenessVectorTable.md deleted file mode 100644 index 44b757fb95..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADReplicationUpToDatenessVectorTable.md +++ /dev/null @@ -1,333 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adreplicationuptodatenessvectortable?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADReplicationUpToDatenessVectorTable - -## SYNOPSIS -Displays the highest Update Sequence Number (USN) for the specified domain controller. - -## SYNTAX - -### Target (Default) -``` -Get-ADReplicationUpToDatenessVectorTable [-AuthType ] [-Credential ] - [-EnumerationServer ] [-Filter ] [[-Partition] ] [-Target] - [] -``` - -### Scope -``` -Get-ADReplicationUpToDatenessVectorTable [-AuthType ] [-Credential ] - [-EnumerationServer ] [-Filter ] [[-Partition] ] [-Scope] - [[-Target] ] [] -``` - -## DESCRIPTION -Displays the highest Update Sequence Number (USN) for the specified domain controller(s). -This information shows how up-to-date a replica is with its replication partners. -During replication, each object that is replicated has USN and if the object is modified, the USN is incremented. -The value of the USN for a given object is local to each domain controller where it has replicated are number is different on each domain controller. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADReplicationUpToDatenessVectorTable -Target corp-DC01 -``` - -Description - ------------ - -Get the highest Update Sequence Number (USN) information for the default partition from corp-DC01. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationUpToDatenessVectorTable -Target corp-DC01 -Scope Server -``` - -Description - ------------ - -Get the highest Update Sequence Number (USN) information for the default partition from corp-DC01 (same as above). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADReplicationUpToDatenessVectorTable -Target corp-DC01,corp-DC02 -Partition Schema -``` - -Description - ------------ - -Get the highest Update Sequence Number (USN) information for the schema partition from corp-DC01 and corp-DC02. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADReplicationUpToDatenessVectorTable -Target NorthAmerica -Scope Site -Partition * -``` - -Description - ------------ - -Get the highest Update Sequence Number (USN) for all partitions from all the Domain Controllers in site 'NorthAmerica'. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADReplicationUpToDatenessVectorTable -Target "corp.contoso.com" -Scope Domain -Partition Default -``` - -Description - ------------ - -Get the highest Update Sequence Number (USN) for the default partition from all the Domain Controllers in domain 'corp.contoso.com'. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Get-ADReplicationUpToDatenessVectorTable -Target "corp.contoso.com" -Scope Forest -Partition Configuration -``` - -Description - ------------ - -Get the highest Update Sequence Number (USN) for the configuration partition from all the Domain Controllers in forest 'corp.contoso.com'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnumerationServer -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a filter in the provider's format or language. -The value of this parameter qualifies the Path parameter. -The syntax of the filter, including the use of wildcards, depends on the provider. -Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: NC, NamingContext - -Required: False -Position: 2 -Default value: DefaultNC; Provider: Default is to use the Partition that you are currently in. Else, use DefaultNC (IE: If you are in the RootDSE) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Scope -Specifies the type of object used as input by the Target parameter. -The following are allowable values to use: - -Server - -Site - -Domain - -Forest - -```yaml -Type: ADScopeType -Parameter Sets: Scope -Aliases: ReplicationSite -Accepted values: Server, Domain, Forest, Site - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies either one or more (using a comma separated list) of Active Directory domain controllers, sites, domains, or forests. -It will return results for all the domain controllers that are specified or that are part of the specified container. - -```yaml -Type: Object[] -Parameter Sets: Target -Aliases: Name, HostName, Site, Domain, Forest - -Required: True -Position: 0 -Default value: DCLocator; Provider: -Server of the connected drive -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: Object[] -Parameter Sets: Scope -Aliases: Name, HostName, Site, Domain, Forest - -Required: False -Position: 0 -Default value: DCLocator; Provider: -Server of the connected drive -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDirectoryServer -A class structure that contains one or more Active Directory server objects. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADReplicationUpToDatenessVector -A class structure that contains one or more Active Directory replication up-to-dateness (UTD) vector tables. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADResourceProperty.md b/docset/winserver2012-ps/activedirectory/Get-ADResourceProperty.md deleted file mode 100644 index a72d666e72..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADResourceProperty.md +++ /dev/null @@ -1,420 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adresourceproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADResourceProperty - -## SYNOPSIS -Gets one or more resource properties. - -## SYNTAX - -### Filter (Default) -``` -Get-ADResourceProperty [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -### Identity -``` -Get-ADResourceProperty [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADResourceProperty [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADResourceProperty cmdlet gets one or more resource properties. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADResourceProperty -Filter "SharesValuesWith -eq 'Country'" -``` - -Description - ------------ - -Get all the resource properties that refer to the claim type named 'Country' for their suggested values. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADResourceProperty Authors -``` - -Description - ------------ - -Get the resource property with display name 'Authors'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourceProperty -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Windows PowerShell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourceProperty - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADResourceProperty - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADResourcePropertyList.md b/docset/winserver2012-ps/activedirectory/Get-ADResourcePropertyList.md deleted file mode 100644 index 2d01b819b1..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADResourcePropertyList.md +++ /dev/null @@ -1,432 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adresourcepropertylist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADResourcePropertyList - -## SYNOPSIS -Retrieves resource property lists from Active Directory. - -## SYNTAX - -### Filter (Default) -``` -Get-ADResourcePropertyList [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -### Identity -``` -Get-ADResourcePropertyList [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADResourcePropertyList [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADResourcePropertyList cmdlet retrieves resource property lists from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList -Filter * -``` - -Description - ------------ - -Retrieves a list of all resource property lists. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList -Filter "Members -eq 'Country'" -``` - -Description - ------------ - -Retrieves all resource property lists that has the resource property "Country" in the list. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList "Global Resource Property List" -``` - -Description - ------------ - -Retrieves the global resource property list. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Global Resource Property List,CN=Resource Property Lists,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to a user object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourcePropertyList -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -The following example shows how to set this parameter. - --ResultPageSize 500 - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $null (null value). -You can use Ctrl+c to stop the query and return of objects. - -The default is $null. - -The following example shows how to set this parameter so that you receive all of the returned objects. - --ResultSetSize $null - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADResourcePropertyValueType.md b/docset/winserver2012-ps/activedirectory/Get-ADResourcePropertyValueType.md deleted file mode 100644 index dcd5532191..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADResourcePropertyValueType.md +++ /dev/null @@ -1,395 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adresourcepropertyvaluetype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADResourcePropertyValueType - -## SYNOPSIS -Retrieves a resource property value type from Active Directory. - -## SYNTAX - -### Filter (Default) -``` -Get-ADResourcePropertyValueType [-AuthType ] [-Credential ] -Filter - [-Properties ] [-Server ] [] -``` - -### Identity -``` -Get-ADResourcePropertyValueType [-AuthType ] [-Credential ] - [-Identity] [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADResourcePropertyValueType [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADResourcePropertyValueType cmdlet retrieves a resource property value type from Active Directory. -The resource property value type supports the following Active Directory primitives (ValueType, IsSingleValued, RestrictValues) and a Boolean indicating whether SuggestedValues are allowed. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADResourcePropertyValueType -Filter * | ft Name -``` - -Description - ------------ - -Retrieves the names of all resource property value types. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADResourcePropertyValueType -Filter "ResourceProperties -eq 'Country' -or ResourceProperties -eq 'Authors'" -``` - -Description - ------------ - -Retrieves all resource property value types that the resource properties "Country" and "Authors" use. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADResourcePropertyValueType "MS-DS-Text" -``` - -Description - ------------ - -Retrieves a resource property value type named "MS-DS-Text". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter "(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory user object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=MS-DS-Text,CN=Value Types,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to a user object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourcePropertyValueType -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyValueType - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADResourcePropertyValueType -Default - -1 ValueType - -2 IsSingleValued - -3 RestrictValues - -4 AreSuggestedValuesPresent - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADRootDSE.md b/docset/winserver2012-ps/activedirectory/Get-ADRootDSE.md deleted file mode 100644 index 7be4abaa36..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADRootDSE.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adrootdse?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADRootDSE - -## SYNOPSIS -Gets the root of a Directory Server information tree. - -## SYNTAX - -``` -Get-ADRootDSE [-AuthType ] [-Credential ] [-Properties ] [-Server ] - [] -``` - -## DESCRIPTION -The Get-ADRootDSE cmdlet gets the conceptual object representing the root of the directory information tree of a directory server. -This tree provides information about the configuration and capabilities of the directory server, such as the distinguished name for the configuration container, the current time on the directory server, and the functional levels of the directory server and the domain. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADRootDSE - - -configurationNamingContext : CN=Configuration,DC=Fabrikam,DC=com -currentTime : 3/18/2009 11:12:55 AM -defaultNamingContext : DC=Fabrikam,DC=com -dnsHostName : FABRIKAM-DC1.Fabrikam.com -domainControllerFunctionality : Windows2008R2 -domainFunctionality : Windows2003Domain -dsServiceName : CN=NTDS Settings,CN=FABRIKAM-DC1,CN=Servers,CN=Default-First-Site-Name,CN=Sites,CN=Configuration,DC=Fabrikam,DC=com -forestFunctionality : Windows2003Forest -highestCommittedUSN : 23015 -isGlobalCatalogReady : {TRUE} -isSynchronized : {TRUE} -ldapServiceName : Fabrikam.com:FABRIKAM-DC1$@FABRIKAM.COM -namingContexts : {DC=Fabrikam,DC=com, CN=Configuration,DC=Fabrikam,DC=com, CN=Schema,CN=Configuration,DC=Fabrikam,DC=com, DC=DomainDnsZones,DC=Fabrikam,DC=com...} -rootDomainNamingContext : DC=Fabrikam,DC=com -schemaNamingContext : CN=Schema,CN=Configuration,DC=Fabrikam,DC=com -serverName : CN=FABRIKAM-DC1,CN=Servers,CN=Default-First-Site-Name,CN=Sites,CN=Configuration,DC=Fabrikam,DC=com -subschemaSubentry : CN=Aggregate,CN=Schema,CN=Configuration,DC=Fabrikam,DC=com -supportedCapabilities : {1.2.840.113556.1.4.800 (LDAP_CAP_ACTIVE_DIRECTORY_OID), 1.2.840.113556.1.4.1670 (LDAP_CAP_ACTIVE_DIRECTORY_V51_OID), 1.2.840.113556.1.4.1791 (LDAP_CAP_ACTIVE_DIRECTORY_LDAP_INTEG_OID), 1.2.840.113556.1.4.1935 (LDAP_CAP_ACTIVE_DIRECTORY_V61_OID)...} -supportedControl : {1.2.840.113556.1.4.319 (LDAP_PAGED_RESULT_OID_STRING), 1.2.840.113556.1.4.801 (LDAP_SERVER_SD_FLAGS_OID), 1.2.840.113556.1.4.473 (LDAP_SERVER_SORT_OID), 1.2.840.113556.1.4.528 (LDAP_SERVER_NOTIFICATION_OID)...} -supportedLDAPPolicies : {MaxPoolThreads, MaxDatagramRecv, MaxReceiveBuffer, InitRecvTimeout...} -supportedLDAPVersion : {3, 2} -supportedSASLMechanisms : {GSSAPI, GSS-SPNEGO, EXTERNAL, DIGEST-MD5} -``` - -Description - ------------ - -Get the rooDSE from the default domain controller. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADRootDSE -Server Fabrikam-RODC1 -Properties supportedExtension - - -configurationNamingContext : CN=Configuration,DC=Fabrikam,DC=com -currentTime : 3/18/2009 11:12:55 AM -defaultNamingContext : DC=Fabrikam,DC=com -dnsHostName : FABRIKAM-RODC1.Fabrikam.com -domainControllerFunctionality : Windows2008R2 -domainFunctionality : Windows2003Domain -dsServiceName : CN=NTDS Settings,CN=FABRIKAM-RODC1,CN=Servers,CN=Default-First-Site-Name,CN=Sites,CN=Configuration,DC=Fabrikam,DC=com -forestFunctionality : Windows2003Forest -highestCommittedUSN : 23015 -isGlobalCatalogReady : {TRUE} -isSynchronized : {TRUE} -ldapServiceName : Fabrikam.com:FABRIKAM-RODC1$@FABRIKAM.COM -namingContexts : {DC=Fabrikam,DC=com, CN=Configuration,DC=Fabrikam,DC=com, CN=Schema,CN=Configuration,DC=Fabrikam,DC=com, DC=DomainDnsZones,DC=Fabrikam,DC=com...} -rootDomainNamingContext : DC=Fabrikam,DC=com -schemaNamingContext : CN=Schema,CN=Configuration,DC=Fabrikam,DC=com -serverName : CN=FABRIKAM-RODC1,CN=Servers,CN=Default-First-Site-Name,CN=Sites,CN=Configuration,DC=Fabrikam,DC=com -subschemaSubentry : CN=Aggregate,CN=Schema,CN=Configuration,DC=Fabrikam,DC=com -supportedCapabilities : {1.2.840.113556.1.4.800 (LDAP_CAP_ACTIVE_DIRECTORY_OID), 1.2.840.113556.1.4.1670 (LDAP_CAP_ACTIVE_DIRECTORY_V51_OID), 1.2.840.113556.1.4.1791 (LDAP_CAP_ACTIVE_DIRECTORY_LDAP_INTEG_OID), 1.2.840.113556.1.4.1935 (LDAP_CAP_ACTIVE_DIRECTORY_V61_OID)...} -supportedControl : {1.2.840.113556.1.4.319 (LDAP_PAGED_RESULT_OID_STRING), 1.2.840.113556.1.4.801 (LDAP_SERVER_SD_FLAGS_OID), 1.2.840.113556.1.4.473 (LDAP_SERVER_SORT_OID), 1.2.840.113556.1.4.528 (LDAP_SERVER_NOTIFICATION_OID)...} -supportedExtension : {1.3.6.1.4.1.1466.20037, 1.3.6.1.4.1.1466.101.119.1, 1.2.840.113556.1.4.1781, 1.3.6.1.4.1.4203.1.11.3} -supportedLDAPPolicies : {MaxPoolThreads, MaxDatagramRecv, MaxReceiveBuffer, InitRecvTimeout...} -supportedLDAPVersion : {3, 2} -supportedSASLMechanisms : {GSSAPI, GSS-SPNEGO, EXTERNAL, DIGEST-MD5} -``` - -Description - ------------ - -Get the rootDSE information including the supportedExtension property for Fabrikam-RODC1 server. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADRootDSE -Server "FABRIKAM-ADLDS1.Fabrikam.com:60000" -Credential "FABRIKAM\User1" - -configurationNamingContext : CN=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA} -currentTime : 3/18/2009 11:40:19 AM -dnsHostName : FABRIKAM-ADLDS1.Fabrikam.com -domainControllerFunctionality : Windows2008R2 -dsServiceName : CN=NTDS Settings,CN=FABRIKAM-ADLDS1$instance1,CN=Servers,CN=Default-First-Site-Name,CN=Sites,C -N=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA} -forestFunctionality : Windows2003Forest -highestCommittedUSN : 13967 -isSynchronized : {TRUE} -namingContexts : {CN=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA}, CN=Schema,CN=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA}, DC=AppNC} -schemaNamingContext : CN=Schema,CN=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA} -serverName : CN=FABRIKAM-ADLDS1$instance1,CN=Servers,CN=Default-First-Site-Name,CN=Sites,CN=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA} -subschemaSubentry : CN=Aggregate,CN=Schema,CN=Configuration,CN={9131D98B-E210-480F-A95D-24F9396898CA} -supportedCapabilities : {1.2.840.113556.1.4.1851 (LDAP_CAP_ACTIVE_DIRECTORY_ADAM_OID), 1.2.840.113556.1.4.1670 (LDAP_CAP_ACTIVE_DIRECTORY_V51_OID), 1.2.840.113556.1.4.1791 (LDAP_CAP_ACTIVE_DIRECTORY_LDAP_INTEG_OID), 1.2.840.113556.1.4.1935 (LDAP_CAP_ACTIVE_DIRECTORY_V61_OID)...} -supportedControl : {1.2.840.113556.1.4.319 (LDAP_PAGED_RESULT_OID_STRING), 1.2.840.113556.1.4.801 (LDAP_SERVER_SD_FLAGS_OID), 1.2.840.113556.1.4.473 (LDAP_SERVER_SORT_OID), 1.2.840.113556.1.4.528 (LDAP_SERVER_NOTIFICATION_OID)...} -supportedLDAPPolicies : {MaxPoolThreads, MaxDatagramRecv, MaxReceiveBuffer, InitRecvTimeout...} -supportedLDAPVersion : {3, 2} -supportedSASLMechanisms : {GSSAPI, GSS-SPNEGO, EXTERNAL, DIGEST-MD5} -``` - -Description - ------------ - -Get the rootDSE information of FABRIKAM-ADLDS1 using the FABRIKAM\user1 credentials. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADRootDSE -An ADRootDSE object that represents the data tree for the specified directory server is output by this cmdlet. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/Get-ADServiceAccount.md deleted file mode 100644 index a44b746b2b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADServiceAccount.md +++ /dev/null @@ -1,455 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADServiceAccount - -## SYNOPSIS -Gets one or more Active Directory managed service accounts or group managed service accounts. - -## SYNTAX - -### Filter (Default) -``` -Get-ADServiceAccount [-AuthType ] [-Credential ] -Filter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -### Identity -``` -Get-ADServiceAccount [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADServiceAccount [-AuthType ] [-Credential ] -LDAPFilter - [-Properties ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [] -``` - -## DESCRIPTION -The **Get-ADServiceAccount** cmdlet gets a managed service account or performs a search to get managed service accounts. - -The **Identity** parameter specifies the Active Directory managed service account to get. -You can identify a managed service account by its distinguished name, GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also set the parameter to a managed service account object variable, such as `$` or pass a managed service account object through the pipeline to the **Identity** parameter. - -To search for and retrieve more than one managed service account, use the **Filter** or **LDAPFilter** parameters. -The **Filter** parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type conversion support for value types received by the **Filter** parameter. -For more information about the **Filter** parameter syntax, type `Get-Help about_ActiveDirectory_Filter`. -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the **LDAPFilter** parameter. - -This cmdlet gets a default set of managed service account object properties. -To get additional properties use the **Properties** parameter. -For more information about the how to determine the properties for service account objects, see the **Properties** parameter description. - -## EXAMPLES - -### Example 1: Get a managed service account by its Security Account Manager name -```powershell -PS C:\> Get-ADServiceAccount -Identity service1 -``` -```output -Enabled : True -Name : service1 -UserPrincipalName : -SamAccountName : service1$ -ObjectClass : msDS-ManagedServiceAccount -SID : S-1-5-21-159507390-2980359153-3438059098-29770 -ObjectGUID : eaa435ee-6ebc-44dd-b4b6-dc1bb5bcd23a -HostComputers : -DistinguishedName : CN=service1,CN=Managed Service Accounts,DC=contoso,DC=com -``` - -This command gets a managed service account with SAM account name service1. - -### Example 2: Get a managed service account by its SID -```powershell -PS C:\> Get-ADServiceAccount -Identity S-1-5-21-159507390-2980359153-3438059098-29770 -``` -```output -Enabled : True -Name : service1 -UserPrincipalName : -SamAccountName : service1$ -ObjectClass : msDS-ManagedServiceAccount -SID : S-1-5-21-159507390-2980359153-3438059098-29770 -ObjectGUID : eaa435ee-6ebc-44dd-b4b6-dc1bb5bcd23a -HostComputers : -DistinguishedName : CN=service1,CN=Managed Service Accounts,DC=contoso,DC=com -``` - -This command gets the managed service account with SID `S-1-5-21-159507390-2980359153-3438059098-29770`. - -### Example 3: Get a filtered list of managed service accounts -```powershell -PS C:\> Get-ADServiceAccount -Filter "HostComputers -eq 'CN=SQL-Server-1, DC=contoso,DC=com'" -``` -```output -Enabled : True -Name : service1 -UserPrincipalName : -SamAccountName : service1$ -ObjectClass : msDS-ManagedServiceAccount -SID : S-1-5-21-159507390-2980359153-3438059098-29770 -ObjectGUID : eaa435ee-6ebc-44dd-b4b6-dc1bb5bcd23a -HostComputers : {CN=SQL-Server-1, DC=contoso,DC=com} -DistinguishedName : CN=service1,CN=Managed Service Accounts,DC=contoso,DC=com -``` - -This command gets the managed service accounts allowed to be used on the computer `CN=SQL-Server-1,DC=contoso,DC=com`. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the **Filter** parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the **Filter** parameter, type `Get-Help about_ActiveDirectory_Filter`. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - - -```yaml -Type: ADServiceAccount -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The **Filter** parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the **Filter** parameter description or type `Get-Help about_ActiveDirectory_Filter`. - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the **Identity** parameter. - -In many cases, a default value will be used for the **Partition** parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for **Partition** will be set in the following cases: - -- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of **Partition** will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the **Identity** parameter is set to a distinguished name, the default value of **Partition** is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of **Partition** is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of **Partition** will be set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the **Partition** parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. -For more information, type `Get-Help Get-Member`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to `$Null` (null value). -You can use Ctrl+C to stop the query and return of objects. - -The default is `$Null`. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -When the value of the **SearchBase** parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. -If the value of the **SearchBase** parameter is set to an empty string and you are not connected to a GC port, an error will be thrown. - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -The acceptable values for this parameter are: - -- Base or 0 -- OneLevel or 1 -- Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: Subtree -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -- Fully qualified domain name (FQDN) -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for the **Server** parameter is determined by one of the following methods in the order that they are listed: - -- By using **Server** value from objects passed through the pipeline. -- By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. -- By using the domain of the computer running PowerShell. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the **Identity** parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADServiceAccount -Returns one or more managed service account (MSA) objects. - -This cmdlet returns a default set of ADService account property values. -To retrieve additional ADService account properties, use the **Properties** parameter. - -## NOTES -* This cmdlet does not work with AD LDS. - -## RELATED LINKS - -[Install-ADServiceAccount](./Install-ADServiceAccount.md) - -[New-ADServiceAccount](./New-ADServiceAccount.md) - -[Remove-ADServiceAccount](./Remove-ADServiceAccount.md) - -[Set-ADServiceAccount](./Set-ADServiceAccount.md) - -[Uninstall-ADServiceAccount](./Uninstall-ADServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADTrust.md b/docset/winserver2012-ps/activedirectory/Get-ADTrust.md deleted file mode 100644 index 38c38025eb..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADTrust.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-adtrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADTrust - -## SYNOPSIS -Returns all trusted domain objects in the directory. - -## SYNTAX - -### Filter (Default) -``` -Get-ADTrust [-AuthType ] [-Credential ] -Filter [-Properties ] - [-Server ] [] -``` - -### Identity -``` -Get-ADTrust [-AuthType ] [-Credential ] [-Identity] - [-Properties ] [-Server ] [] -``` - -### InputObject -``` -Get-ADTrust [-AuthType ] [-Credential ] -InputObject - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADTrust [-AuthType ] [-Credential ] -LDAPFilter [-Properties ] - [-Server ] [] -``` - -## DESCRIPTION -The Get-ADTrust cmdlet returns all trusted domain objects in the directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADTrust -Filter * -``` - -Description - ------------ - -Get all the trusted domain objects in the forest. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADTrust -Filter "Target -eq 'corp.contoso.com'" -``` - -Description - ------------ - -Get all the trusted domain objects with 'corp.contoso.com' as the trust partner. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADTrust "corp.contoso.com" -``` - -Description - ------------ - -Get the trusted domain object with name 'corp.contoso.com' - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the Filter parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the Filter parameter, see about_ActiveDirectory_Filter. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, see about_ActiveDirectory_ObjectModel. - -Examples: - -The following examples show how to use this syntax with Active Directory cmdlets. - -To get all objects of the type specified by the cmdlet, use the asterisk wildcard: - -All user objects: - -Get-ADUser -Filter * - --or- - -All computer objects: - -Get-ADComputer -Filter * - -To get all user objects that have an e-mail message attribute, use one of the following commands: - -Get-ADUser -Filter "EmailAddress -like '*'" - -Get-ADUser -Filter "mail -like '*'" - --or- - -Get-ADObject -Filter "(mail -like '*') -and (ObjectClass -eq 'user')" - -Note: PowerShell wildcards other than "*", such as "?" are not supported by the Filter syntax. - -To get all users objects that have surname of Smith and that have an e-mail attribute, use one of the following commands: - -Get-ADUser -Filter '(EmailAddress -like '*') -and (Surname -eq 'smith')" - --or- - -Get-ADUser -Filter "(mail -eq '*') -and (sn -eq 'Smith')" - -To get all user objects who have not logged on since January 1, 2007, use the following commands: - -$logonDate = New-Object System.DateTime(2007, 1, 1) - -Get-ADUser -Filter "lastLogon -le '$logonDate'" - -To get all groups that have a group category of Security and a group scope of Global, use one of the following commands: - -Get-ADGroup -Filter "GroupCategory -eq 'Security' -and GroupScope -eq 'Global'" - --or- - -Get-ADGroup -Filter "GroupType -band 0x80000000" - -Note: To query using LDAP query strings, use the LDAPFilter parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: fabrikam.com,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADTrust -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies an Active Directory input object. -This parameter can accept one of the following object types: - -- ADForest -- ADDomain -- ADObject - -The cmdlet will retrieve the corresponding ADTrust based on the input object specified. - -```yaml -Type: Object -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The Filter parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the Filter parameter description and the about_ActiveDirectory_Filter. - -The following example shows how to set this parameter to search for all objects in the organizational unit specified by the SearchBase parameter with a name beginning with "sara". - --LDAPFilter "(name=sara*)" -SearchScope Subtree -SearchBase "DC=NA,DC=fabrikam,DC=com" - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the Get-Member cmdlet. -The following examples show how to retrieve properties for a group where the Administrator's group is used as the sample group object. - -Get-ADGroup -Identity Administrators | Get-Member - -To retrieve and display the list of all the properties for an ADGroup object, use the following command: - -Get-ADGroup -Identity Administrators -Properties *| Get-Member - -The following examples show how to use the Properties parameter to retrieve individual properties as well as the default, extended or complete set of properties. - -To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser object named "SaraDavis", use the following command: - -GetADUser -Identity SaraDavis -Properties OfficePhone,Organization - -To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the default properties for the same user, use the following command: - -GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADTrust -A trusted domain object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADTrust - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Get-ADUser.md b/docset/winserver2012-ps/activedirectory/Get-ADUser.md deleted file mode 100644 index 0ffb8691b6..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADUser.md +++ /dev/null @@ -1,470 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-aduser?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADUser - -## SYNOPSIS -Gets one or more Active Directory users. - -## SYNTAX - -### Filter (Default) -``` -Get-ADUser [-AuthType ] [-Credential ] -Filter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [] -``` - -### Identity -``` -Get-ADUser [-AuthType ] [-Credential ] [-Identity] [-Partition ] - [-Properties ] [-Server ] [] -``` - -### LdapFilter -``` -Get-ADUser [-AuthType ] [-Credential ] -LDAPFilter [-Properties ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [] -``` - -## DESCRIPTION -The **Get-ADUser** cmdlet gets a specified user object or performs a search to get multiple user objects. - -The *Identity* parameter specifies the Active Directory user to get. -You can identify a user by its distinguished name (DN), GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also set the parameter to a user object variable such as `$` or pass a user object through the pipeline to the *Identity* parameter. - -To search for and retrieve more than one user, use the *Filter* or *LDAPFilter* parameters. -The *Filter* parameter uses the PowerShell Expression Language to write query strings for Active Directory. -PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -For more information about the *Filter* parameter syntax, type `Get-Help about_ActiveDirectory_Filter`. -If you have existing Lightweight Directory Access Protocol (LDAP) query strings, you can use the *LDAPFilter* parameter. - -This cmdlet retrieves a default set of user object properties. -To retrieve additional properties use the _Properties_ parameter. -For more information about how to determine the properties for user objects, see the _Properties_ parameter description. - -## EXAMPLES - -### Example 1: Get all of the users in a container -```powershell -PS C:\> Get-ADUser -Filter * -SearchBase "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -This command gets all users in the container OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### Example 2: Get a filtered list of users -```powershell -PS C:\> Get-ADUser -Filter 'Name -like "*SvcAccount"' | Format-Table Name,SamAccountName -A -``` - -```Output -Name SamAccountName ----- -------------- -SQL01 SvcAccount SQL01 -SQL02 SvcAccount SQL02 -IIS01 SvcAccount IIS01 -``` - -This command gets all users that have a name that ends with SvcAccount. - -### Example 3: Get all of the properties for a specified user -```powershell -PS C:\> Get-ADUser -Identity ChewDavid -Properties * -``` - -```Output -Surname : David -Name : Chew David -UserPrincipalName : -GivenName : David -Enabled : False -SamAccountName : ChewDavid -ObjectClass : user -SID : S-1-5-21-2889043008-4136710315-2444824263-3544 -ObjectGUID : e1418d64-096c-4cb0-b903-ebb66562d99d -DistinguishedName : CN=Chew David,OU=NorthAmerica,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM -``` - -This command gets all of the properties of the user with the SAM account name ChewDavid. - -### Example 4: Get a specified user -```powershell -PS C:\> Get-ADUser -Filter "Name -eq 'ChewDavid'" -SearchBase "DC=AppNC" -Properties "mail" -Server lds.Fabrikam.com:50000 -``` - -This command gets the user with the name ChewDavid in the Active Directory Lightweight Directory Services (AD LDS) instance. - -### Example 5: Get all enabled user accounts -```powershell -C:\PS> Get-ADUser -LDAPFilter '(!userAccountControl:1.2.840.113556.1.4.803:=2)' -``` - -This command gets all enabled user accounts in Active Directory using an LDAP filter. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Specifies a query string that retrieves Active Directory objects. -This string uses the PowerShell Expression Language syntax. -The PowerShell Expression Language syntax provides rich type-conversion support for value types received by the *Filter* parameter. -The syntax uses an in-order representation, which means that the operator is placed between the operand and the value. -For more information about the *Filter* parameter, type `Get-Help about_ActiveDirectory_Filter`. - -Syntax: - -The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this parameter. - -\ ::= "{" \ "}" - -\ ::= \ | \ \ \ | \ \ - -\ ::= \ \ \ | "(" \ ")" - -\ ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" | "-recursivematch" | "-like" | "-notlike" - -\ ::= "-and" | "-or" - -\ ::= "-not" - -\ ::= \ | \ - -\::= \ by using the specified \\> - -For a list of supported types for \, type `Get-Help about_ActiveDirectory_ObjectModel`. - -Note: For String parameter type, PowerShell will cast the filter query to a string while processing the command. When using a string variable as a value in the filter component, make sure that it complies with the [PowerShell Quoting Rules](/powershell/module/microsoft.powershell.core/about/about_quoting_rules). For example, if the filter expression is double-quoted, the variable should be enclosed using single quotation marks: -**Get-ADUser -Filter "Name -like '$UserName'"**. On the contrary, if curly braces are used to enclose the filter, the variable should not be quoted at all: **Get-ADUser -Filter {Name -like $UserName}**. - -Note: PowerShell wildcards other than \*, such as ?, are not supported by the *Filter* syntax. - -Note: To query using LDAP query strings, use the *LDAPFilter* parameter. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory user object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADUser -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LDAPFilter -Specifies an LDAP query string that is used to filter Active Directory objects. -You can use this parameter to run your existing LDAP queries. -The *Filter* parameter syntax supports the same functionality as the LDAP syntax. -For more information, see the *Filter* parameter description or type `Get-Help about_ActiveDirectory_Filter`. - -```yaml -Type: String -Parameter Sets: LdapFilter -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first, and when a default value can be determined, no further rules are evaluated. - -In AD DS environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for *Partition* is set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter does not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Properties -Specifies the properties of the output object to retrieve from the server. -Use this parameter to retrieve properties that are not included in the default set. - -Specify properties for this parameter as a comma-separated list of names. -To display all of the attributes that are set on the object, specify * (asterisk). - -To specify an individual extended property, use the name of the property. -For properties that are not default or extended properties, you must specify the LDAP display name of the attribute. - -To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object and pass the output to the **Get-Member** cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Property - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: 256 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. -If you want to receive all of the objects, set this parameter to $Null (null value). -You can use Ctrl+C to stop the query and return of objects. - -The default is $Null. - -```yaml -Type: Int32 -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -When the value of the *SearchBase* parameter is set to an empty string and you are connected to a GC port, all partitions are searched. -If the value of the *SearchBase* parameter is set to an empty string and you are not connected to a GC port, an error is thrown. - -```yaml -Type: String -Parameter Sets: Filter, LdapFilter -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -The acceptable values for this parameter are: - -- Base or 0 -- OneLevel or 1 -- Subtree or 2 - -A SearchScope with a Base value searches only for the given user. If an OU is specified in the SearchBase parameter, no user will be returned by, for example, a specified Filter statement. -A OneLevel query searches the immediate children of that path or object. This option only works when an OU is given as the SearchBase. If a user is given, no results are returned. -A Subtree query searches the current path or object and all children of that path or object. - - -```yaml -Type: ADSearchScope -Parameter Sets: Filter, LdapFilter -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: Subtree -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -- Fully qualified domain name (FQDN) -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for the *Server* parameter is determined by one of the following methods in the order that they are listed: - -- By using *Server* value from objects passed through the pipeline. -- By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. -- By using the domain of the computer running PowerShell. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADUser -A user object is received by the *Identity* parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADUser -Returns one or more user objects. - -This cmdlet returns a default set of **ADUser** property values. -To retrieve additional **ADUser** properties, use the *Properties* parameter. - -To get a list of the default set of properties of an **ADUser** object, use the following command: - -`Get-ADUser`\`| Get-Member` - -To get a list of the most commonly used properties of an ADUser object, use the following command: - -`Get-ADUser`\`-Properties Extended | Get-Member` - -To get a list of all the properties of an **ADUser** object, use the following command: - -`Get-ADUser`\`-Properties * | Get-Member` - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[New-ADUser](./New-ADUser.md) - -[Remove-ADUser](./Remove-ADUser.md) - -[Set-ADUser](./Set-ADUser.md) diff --git a/docset/winserver2012-ps/activedirectory/Get-ADUserResultantPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/Get-ADUserResultantPasswordPolicy.md deleted file mode 100644 index 6dbfe4f936..0000000000 --- a/docset/winserver2012-ps/activedirectory/Get-ADUserResultantPasswordPolicy.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/get-aduserresultantpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADUserResultantPasswordPolicy - -## SYNOPSIS -Gets the resultant password policy for a user. - -## SYNTAX - -``` -Get-ADUserResultantPasswordPolicy [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The Get-ADUserResultantPasswordPolicy gets the resultant password policy object (RSoP) for a user. -The RSoP is defined by the Active Directory attribute named msDS-ResultantPSO. - -A user can have multiple password policy objects (PSOs) associated with it, but only one PSO is the RSoP. -A PSO is associated with a user when the PSO applies directly to the user or when the PSO applies to an Active Directory group that contains the user. -When more than one PSO policy is associated with a user or group, the RSoP value defines the PSO to apply. - -The resultant password policy or RSoP for a user is determined by using the following procedure. - -- If only one PSO is associated with a user, this PSO is the RSoP. -- If more than one PSO is associated with a user, the PSO that applies directly to the user is the RSoP. -- If more than one PSO applies directly to the user, the PSO with the lowest msDS-PasswordSettingsPrecedence attribute value is the RSoP and this event is logged as a warning in the Active Directory event log. The lowest attribute value represents the highest PSO precedence. For example, if the msDS-PasswordSettingsPrecedence values of two PSOs are 100 and 200, the PSO with the attribute value of 100 is the RSoP. -- If there are no PSOs that apply directly to the user, the PSOs of the global security groups that have the user as a member are compared. The PSO with the lowest msDS-PasswordSettingsPrecedence value is the RSoP. - -The Identity parameter specifies the Active Directory user. -You can identify a user by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the parameter to a user object variable, such as $\ or pass a user object through the pipeline to the Identity parameter. -For example, you can use the Get-ADUser cmdlet to retrieve a user object and then pass the object through the pipeline to the Get-ADUserResultantPasswordPolicy cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADUserResultantPasswordPolicy BobKe - - -Name : DomainUsersPSO -ComplexityEnabled : True -LockoutThreshold : 10 -ReversibleEncryptionEnabled : False -LockoutDuration : 12:00:00 -LockoutObservationWindow : 00:15:00 -MinPasswordLength : 8 -Precedence : 500 -ObjectGUID : f8d2653c-9b3b-499e-b272-4c7f4268df4c -ObjectClass : msDS-PasswordSettings -PasswordHistoryCount : 24 -MinPasswordAge : 1.00:00:00 -MaxPasswordAge : 60.00:00:00 -AppliesTo : {CN=Domain Users,CN=Users,DC=FABRIKAM,DC=COM} -DistinguishedName : CN=DomainUsersPSO,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM -``` - -Description - ------------ - -Get the resultant password policy for the user with samAccountName 'BobKe'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory user object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM account name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a user object instance named "userInstance". - --Identity $userInstance - -```yaml -Type: ADUser -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADUser -A user object is received by the Identity parameter. - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -Returns a fine grained password policy object that represents the resultant password policy for the user. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - -## RELATED LINKS - -[Get-ADUser](./Get-ADUser.md) - diff --git a/docset/winserver2012-ps/activedirectory/Install-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/Install-ADServiceAccount.md deleted file mode 100644 index 9419e3ac5e..0000000000 --- a/docset/winserver2012-ps/activedirectory/Install-ADServiceAccount.md +++ /dev/null @@ -1,288 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/install-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-ADServiceAccount - -## SYNOPSIS -Installs an Active Directory managed service account on a computer or caches a group managed service account on a computer. - -## SYNTAX - -``` -Install-ADServiceAccount [-WhatIf] [-Confirm] [-AccountPassword ] [-AuthType ] - [-Force] [-Identity] [-PromptForPassword] [] -``` - -## DESCRIPTION -The Install-ADServiceAccount cmdlet installs an existing Active Directory managed service account (MSA) on the computer on which the cmdlet is run. -This cmdlet verifies that the computer is eligible to host the MSA. -The cmdlet also makes the required changes locally so that the MSA password can be managed without requiring any user action. - -The Identity parameter specifies the Active Directory MSA to install. -You can identify a MSA by its distinguished name Members (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the parameter to a MSA object variable, such as $\ or pass a MSA object through the pipeline to the Identity parameter. -For example, you can use Get-ADServiceAccount to get a MSA object and then pass the object through the pipeline to the Install-ADServiceAccount. - -The AccountPassword parameter allows you to pass a SecureString that contains the password of a standalone MSA and is ignored for group MSAs. -Alternatively you can use PromptForPassword switch parameter to be prompted for the standalone MSA password. -You need to enter the password of a standalone MSA if you want to install an account that you have pre-provisioned early on. -This is required when you are installing a standalone MSA on a server located on a segmented network (site) with no access to writable DCs but only RODCs (e.g. -perimeter network or DMZ). -In this case you should create the standalone MSA, link it with the appropriate computer account and assign a well-known password that needs to be passed when installing the standalone MSA on the server on the RODC-only site with no access to writable DCs. -If you pass both AccountPassword and PromptForPassword parameters the AccountPassword parameter takes precedence. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-ADServiceAccount -Identity 'SQL-HR-svc-01' -``` - -Description - ------------ - -Install a Managed Service Account with name 'SQL-HR-svc-01' on the local computer. -(If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.) - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$a = Get-ADServiceAccount -Filter "Name -eq 'SQL-HR-svc-01'" -Install-ADServiceAccount $a -``` - -Description - ------------ - -Get a Managed Service Account with name 'SQL-HR-svc-01' from the default directory and install it on the local machine. -(If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.) - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Install-ADServiceAccount -Identity 'SQL-HR-svc-01' -PromptForPassword - - -Please enter the current password for 'CN=SQL-HR-svc-01,CN=Managed Service Accounts,DC=contoso,DC=com' -Password: ******* -``` - -Description - ------------ - -Installs a standalone Managed Service Account with name 'SQL-HR-svc-01' in a RODC-only site with not access to writable DCs. -(If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.) - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Install-ADServiceAccount -Identity 'SQL-HR-svc-01' -AccountPassword (ConvertTo-SecureString -AsPlainText "p@ssw0rd" -Force) -``` - -Description - ------------ - -Installs a standalone Managed Service Account with name 'SQL-HR-svc-01' in a RODC-only site with not access to writable DCs passing the account password as a secure string. -(If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.) - -## PARAMETERS - -### -AccountPassword -The AccountPassword SecureString parameter will allow you to inline pass-in the password of a standalone Managed Service Account (MSA) that you have pre-provisioned early on and is ignored for group MSAs. -This is required when you are installing a standalone MSA on a server located on a segmented network (site) with no access to writable DCs but only RODCs (e.g. -perimeter network or DMZ). -In this case you should create the standalone MSA, link it with the appropriate computer account and assign a well-known password that needs to be passed when installing the standalone MSA on the server on the RODC-only site with no access to writable DCs. -If you pass both AccountPassword and PromptForPassword parameters the AccountPassword parameter takes precedence. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces installation of the service account. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: WebAccount$ - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "AccountInstance". - --Identity $AccountInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PromptForPassword -The PromptForPassword switch parameter will allow you to enter the password of a standalone Managed Service Account (MSA) that you have pre-provisioned early on and ignored for group MSAs. -This is required when you are installing a standalone MSA on a server located on a segmented network (site) with no access to writable DCs but only RODCs (e.g. -perimeter network or DMZ). -In this case you should create the standalone MSA, link it with the appropriate computer account and assign a well-known password that needs to be passed when installing the standalone MSA on the server on the RODC-only site with no access to writable DCs. -If you pass both AccountPassword and PromptForPassword parameters the AccountPassword parameter takes precedence. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - To successfully install a service account, the service account should have the **-PrincipalsAllowedToRetrieveManagedPassword** parameter option set first by using either the New-ADServiceAccount or Set-ADServiceAccount cmdlet first. -Otherwise, installation will fail. - -## RELATED LINKS - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[New-ADServiceAccount](./New-ADServiceAccount.md) - -[Remove-ADServiceAccount](./Remove-ADServiceAccount.md) - -[Reset-ADServiceAccountPassword](./Reset-ADServiceAccountPassword.md) - -[Set-ADServiceAccount](./Set-ADServiceAccount.md) - -[Uninstall-ADServiceAccount](./Uninstall-ADServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Move-ADDirectoryServer.md b/docset/winserver2012-ps/activedirectory/Move-ADDirectoryServer.md deleted file mode 100644 index 8b2214f88b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Move-ADDirectoryServer.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/move-addirectoryserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ADDirectoryServer - -## SYNOPSIS -Moves a directory server in Active Directory to a new site. - -## SYNTAX - -``` -Move-ADDirectoryServer [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [-Site] [] -``` - -## DESCRIPTION -The Move-ADDirectoryServer cmdlet moves a directory server in Active Directory to a new site within the same domain. - -The Identity parameter specifies the directory server to move. -You can specify a directory server object by one of the following values: - -Name of the server object (name) - -Distinguished Name (DN) of the NTDS Settings object - -Distinguished Name (DN) of the server object that represents the directory server - -GUID (objectGUID) of server object under the configuration partition - -GUID (objectGUID) of NTDS settings object under the configuration partition - -You can also set the Identity parameter to a directory server object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADDomainController to get a directory server object and then pass that object through the pipeline to the Move-ADDirectoryServer cmdlet. - -The Site parameter specifies the new site for the directory server. -You can identify a site by its distinguished name (DN) or GUID. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Move-ADDirectoryServer -Identity "FABRIKAM-DC2" -Site "Branch-Office-Site" -``` - -Description - ------------ - -Move the domain controller "FABRIKAM-DC2" to the site "Branch-Office-Site". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADDomainController -Filter "IsReadOnly -eq `$true" | Move-ADDirectoryServer -site "RODC-Site-Name" -``` - -Description - ------------ - -Move all Read Only Domain Controllers to the site "RODC-Site-Name". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory server object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Name of the server object (name) - -For AD LDS instances the syntax is of a name is \$\ - -Example: asia-w7-vm4$instance1 - -Note: When you type this value in Windows PowerShell, you must use the backtick (\`) as an escape character for the dollar sign ($). -Therefore, for the previous example you would type the following: asia-w7-vm4\`$instance1 - -For other Active Directory instances, use the value of the name property - -Example: corp-DC01 - -Distinguished Name of the NTDS Settings object - -Example: CN=NTDS Settings,CN=CORP-DC12,CN=Servers,CN=NA-CAN-BC,CN=Sites,CN=Configuration,DC=corp,DC=contoso - -Distinguished Name of the server object that represents the directory server - -Example: CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) of server object under the configuration partition - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -GUID (objectGUID) of NTDS settings object under the configuration partition - -Example: 768c44de-f72d-66e0-8a88-0523ca495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a directory server object instance named "directoryServerInstance". - --Identity $directoryServerInstance - -```yaml -Type: ADDirectoryServer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the new site for the directory server. -You can identify the site by one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished name (DN) - -Example: CN= NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (ObjectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: NA-CAN-QBC - -The following example shows how use this parameter to specify a site object by using the site name. - --Site "NA-CAN-QBC" - -```yaml -Type: ADReplicationSite -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDirectoryServer -A directory server object is received b y the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Move-ADDirectoryServerOperationMasterRole](./Move-ADDirectoryServerOperationMasterRole.md) - diff --git a/docset/winserver2012-ps/activedirectory/Move-ADDirectoryServerOperationMasterRole.md b/docset/winserver2012-ps/activedirectory/Move-ADDirectoryServerOperationMasterRole.md deleted file mode 100644 index d7e6737a96..0000000000 --- a/docset/winserver2012-ps/activedirectory/Move-ADDirectoryServerOperationMasterRole.md +++ /dev/null @@ -1,418 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/move-addirectoryserveroperationmasterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ADDirectoryServerOperationMasterRole - -## SYNOPSIS -Moves operation master roles to an Active Directory directory server. - -## SYNTAX - -``` -Move-ADDirectoryServerOperationMasterRole [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] [-Force] [-Identity] - [-OperationMasterRole] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Move-ADDirectoryServerOperationMasterRole cmdlet moves one or more operation master roles to a directory server. -You can move operation master roles to a directory server in a different domain if the credentials are the same in both domains. - -The Identity parameter specifies the directory server that receives the roles. -You can specify a directory server object by one of the following values: - -Name of the server object (name) - -Distinguished Name (DN) of the NTDS Settings object - -Distinguished Name (DN) of the server object that represents the directory server - -GUID (objectGUID) of server object under the configuration partition - -GUID (objectGUID) of NTDS settings object under the configuration partition - -For AD LDS instances the syntax for the server object name is \$\. -The following is an example of this syntax: - -asia-w7-vm4$instance1 - -When you type this value in Windows PowerShell, you must use the backtick (\`) as an escape character for the dollar sign ($). -Therefore, for this example, you would type the following: - -asia-w7-vm4\`$instance1 - -You can also set the parameter to a directory server object variable, such as $\. - -The Move-ADDirectoryServerOperationMasterRole cmdlet provides two options for moving operation master roles: - -1. Role transfer, which involves transferring roles to be moved by running the cmdlet using the Identity parameter to specify the current role holder and the OperationMasterRole parameter to specify the roles for transfer. - This is the recommended option. - - Operation roles include PDCEmulator, RIDMaster, InfrastructureMaster, SchemaMaster, or DomainNamingMaster. - To specify more than one role, use a comma-separated list. - -2. Role seizure, which involves seizing roles you previously attempted to transfer by running the cmdlet a second time using the same parameters as the transfer operation, and adding the Force parameter. - The Force parameter must be used as a switch to indicate that seizure (instead of transfer) of operation master roles is being performed. - This operation still attempts graceful transfer first, then seizes if transfer is not possible. - -Unlike using Ntdsutil.exe to move operation master roles, the Move-ADDirectoryServerOperationMasterRole cmdlet can be remotely executed from any domain joined computer where the Active Directory PowerShell administration module is installed and available for use. -This can make the process of moving roles simpler and easier to centrally administer as each of the two command operations required can be run remotely and do not have to be locally executed at each of the corresponding role holders involved in the movement of the roles (i.e. -role transfer only allowed at the old role holder, role seizure only allowed at the new role holder). - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Move-ADDirectoryServerOperationMasterRole "FABRIKAM-DC1" PDCEmulator -``` - -Description - ------------ - -Move the PDC Emulator role to the Domain Controller "FABRIKAM-DC1". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Move-ADDirectoryServerOperationMasterRole -Identity "FABRIKAM-DC2" -OperationMasterRole PDCEmulator,SchemaMaster -``` - -Description - ------------ - -Move the PDC Emulator and Schema Master roles to the Domain Controller "FABRIKAM-DC2". - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Move-ADDirectoryServerOperationMasterRole Fabrikam-DC`$instance1 -OperationMasterRole schemaMaster -server Fabrikam-DC:50000 -``` - -Description - ------------ - -Move the schema master FSMO owner to the AD LDS instance "instance1' on the server "Fabrikam-DC". - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Move-ADDirectoryServerOperationMasterRole -Identity FABRIKAM-DC1 -OperationMasterRole RIDMaster,InfrastructureMaster,DomainNamingMaster -Force -``` - -Description - ------------ - -Seizes the specified roles (RID master, infrastructure master, domain naming master). - -### -------------------------- EXAMPLE 5 -------------------------- -``` -PS C:\>$server = Get-ADDomainController -Identity "TK5-CORP-DC-10.fabrikam.com" - - -PS C:\>Move-ADDirectoryServerOperationMasterRole -Identity $server -OperationMasterRole SchemaMaster,DomainNamingMaster,PDCEmulator,RIDMaster,InfrastructureMaster -``` - -Description - ------------ - -Transfers the flexible single master operations (FSMO) role to the specified domain controller. -When using the fully qualified domain name (FQDN) to identify the domain controller, the Get-ADDomainController cmdlet must be used first as a preliminary step. -There is a known issue where the Move-ADDirectoryServerOperationMasterRole cmdlet fails when an FQDN is specified directly as the value of the **-Identity** parameter. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -This parameter is used for seize operations on domain controllers with the flexible single master operations (FSMO) role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory server object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Name of the server object (name) - -For AD LDS instances the syntax is of a name is \$\ - -Example: asia-w7-vm4$instance1 - -Note: When you type this value in Windows PowerShell, you must use the backtick (\`) as an escape character for the dollar sign ($). -Therefore, for the previous example you would type the following: asia-w7-vm4\`$instance1 - -For other Active Directory instances, use the value of the name property - -Example: corp-DC01 - -Distinguished Name of the NTDS Settings object - -Example: CN=NTDS Settings,CN=CORP-DC12,CN=Servers,CN=NA-CAN-BC,CN=Sites,CN=Configuration,DC=corp,DC=contoso - -Distinguished Name of the server object that represents the directory server - -Example: CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) of server object under the configuration partition - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -GUID (objectGUID) of NTDS settings object under the configuration partition - -Example: 768c44de-f72d-66e0-8a88-0523ca495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=CORP-DC12,CN=Servers,CN=NA-CAN-QBC,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a directory server object instance named "directoryServerInstance". - --Identity $directoryServerInstance - -```yaml -Type: ADDirectoryServer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OperationMasterRole -Specifies one or more operation master roles to move to the specified directory server in Active Directory Domain Services. -Possible values for this parameter include: - -PDCEmulator or 0 - -RIDMaster or 1 - -InfrastructureMaster or 2 - -SchemaMaster or 3 - -DomainNamingMaster or 4 - -To specify multiple operation master roles, use a comma-separated list. - -The following example shows how to specify this parameter so that the SchemaMaster and DomainNamingMaster roles are moved. - --OperationMasterRole SchemaMaster, 4 - -```yaml -Type: ADOperationMasterRole[] -Parameter Sets: (All) -Aliases: -Accepted values: PDCEmulator, RIDMaster, InfrastructureMaster, SchemaMaster, DomainNamingMaster - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: See notes -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDirectoryServer -A directory server object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDirectoryServer -Returns the modified directory server object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Move-ADDirectoryServer](./Move-ADDirectoryServer.md) - diff --git a/docset/winserver2012-ps/activedirectory/Move-ADObject.md b/docset/winserver2012-ps/activedirectory/Move-ADObject.md deleted file mode 100644 index d6a495824b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Move-ADObject.md +++ /dev/null @@ -1,442 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/move-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ADObject - -## SYNOPSIS -Moves an Active Directory object or a container of objects to a different container or domain. - -## SYNTAX - -``` -Move-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-PassThru] [-Server ] [-TargetPath] [-TargetServer ] - [] -``` - -## DESCRIPTION -The **Move-ADObject** cmdlet moves an object or a container of objects from one container to another or from one domain to another within the same forest. - -The Identity parameter specifies the Active Directory object or container to move. -You can identify an object or container by its distinguished name (DN) or GUID. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADObject cmdlet to retrieve an object and then pass the object through the pipeline to the Move-ADObject cmdlet. -You can also use the Get-ADGroup, Get-ADUser, Get-ADComputer, Get-ADServiceAccount, Get-ADOrganizationalUnit and Get-ADFineGrainedPasswordPolicy cmdlets to get an object that you can pass through the pipeline to this cmdlet. - -The TargetPath parameter must be specified. -This parameter identifies the new location for the object or container. - -The cmdlet also moves the password when a user or computer object is moved across domains within a forest. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Move-ADObject -Identity "OU=ManagedGroups,DC=Fabrikam,DC=Com" -TargetPath "OU=Managed,DC=Fabrikam,DC=Com" -``` - -Description - ------------ - -Moves the Organizational Unit 'ManagedGroups' to a new location. -The OU 'ManagedGroups' must NOT be protected from accidental deletion for the successful move. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Move-ADObject "8d0bcc44-c826-4dd8-af5c-2c69960fbd47" -TargetPath "OU=Managed,DC=Fabrikam,DC=Com" -``` - -Description - ------------ - -Moves the object identified by the specified GUID to the new location. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Move-ADObject "8d0bcc44-c826-4dd8-af5c-2c69960fbd47" -TargetPath "1c2ea8a8-c2b7-4a87-8190-0e8a166aee16" -``` - -Description - ------------ - -Moves an object to a new location. -Both the object and the target path are specified using GUIDs. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Move-ADObject -Identity "CN=Peter Bankov,OU=Accounting,DC=Fabrikam,DC=com" -TargetPath "OU=Accounting,DC=Europe,DC=Fabrikam,DC=com" -TargetServer "server01.europe.fabrikam.com" -``` - -Description - ------------ - -Moves an object with DistinguishedName 'CN=Peter Bankov,OU=Accounting,DC=Fabrikam,DC=com' to a different domain. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Move-ADObject -Identity "CN=AccountLeads,DC=AppNC" -TargetPath "OU=AccountDeptOU,DC=AppNC" -server "FABRIKAM-SRV1:60000" -``` - -Description - ------------ - -Moves an object to a new location within an LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPath -Specifies the new location for the object. -This location must be the path to a container or organizational unit. - -The following example shows how to specify a target path by providing the distinguished name. - --TargetPath "ou=sales,dc=corp,dc=contoso,dc=com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetServer -Specifies the Active Directory instance to use by providing the following value for a corresponding domain name or directory server. - -Note: A cross domain move requires a FQDN server name. - -Domain name values: - -Fully qualified domain name (FQDN) - -Examples: contoso.com - -Directory server values: - -Fully qualified directory server name - -Example: server01.europe.contoso.com - -Fully qualified directory server name and port - -Example: server01.europe.contoso.com:3268 - -The following example shows how to specify a target server by specifying the fully-qualified directory server name. - --TargetServer "server01.europe.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.AObject -An Active Directory object is received by the Identity parameter. -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[New-ADObject](./New-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - -[Rename-ADObject](./Rename-ADObject.md) - -[Restore-ADObject](./Restore-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md b/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md deleted file mode 100644 index 73b06e0b3d..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADCentralAccessPolicy.md +++ /dev/null @@ -1,375 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adcentralaccesspolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADCentralAccessPolicy - -## SYNOPSIS -Creates a new central access policy in Active Directory containing a set of central access rules. - -## SYNTAX - -``` -New-ADCentralAccessPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Description ] [-Instance ] [-Name] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Server ] [] -``` - -## DESCRIPTION -The New-ADCentralAccessPolicy cmdlet creates a new central access policy in Active Directory. -A central access policy in Active Directory contains a set of central access rules. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$departmentResourceProperty = Get-ADResourceProperty Department -$resourceCondition = "(@RESOURCE." + $departmentResourceProperty.Name + " Contains {`"Finance`"})" -New-ADCentralAccessRule "Finance Documents Rule" -ResourceCondition $resourceCondition -``` - -Description - ------------ - -Create a new central access rule named "Finance Documents Rule" with a new resource condition. -The resource condition scopes the resources to ones containing the value 'Finance' in their 'Department' resource property. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$countryClaimType = Get-ADClaimType Country; -$departmentClaimType = Get-ADClaimType Department; -$countryResourceProperty = Get-ADResourceProperty Country; -$departmentResourceProperty = Get-ADResourceProperty Department; -$financeException = Get-ADGroup FinanceException; -$financeAdmin = Get-ADGroup FinanceAdmin; - -$resourceCondition = "(@RESOURCE." + $departmentResourceProperty.Name + " Contains {`"Finance`"})" - -$currentAcl = "O:SYG:SYD:AR(A;;FA;;;OW)(A;;FA;;;BA)(A;;0x1200a9;;;" + $financeException.SID.Value + ")(A;;0x1301bf;;;" + $financeAdmin.SID.Value + ")(A;;FA;;;SY)(XA;;0x1200a9;;;AU;((@USER." + $countryClaimType.Name + " Any_of @RESOURCE." + $countryResourceProperty.Name + ") && (@USER." + $departmentClaimType.Name + " Any_of @RESOURCE." + $departmentResourceProperty.Name + ")))"; - -Set-ADCentralAccessRule "Finance Documents Rule" -ResourceCondition $resourceCondition -CurrentAcl $currentAcl -``` - -Description - ------------ - -Create a new central access rule named "Finance Documents Rule" with a new resource condition and new permissions. - -The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country/region. -Only Finance Administrators should have write access. -The rule allows an exception for members of the FinanceException group. -This group will have read access. - -Targeting: - -Resource.Department Contains Finance - -Access rules: - -Allow Read User.Country=Resource.Country AND User.department = Resource.Department - -Allow Full control User.MemberOf(FinanceAdmin) - -Allow Read User.Country=Resource.Country AND User.department = Resource.DepartmentAllow Read User.MemberOf(FinanceException) - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy "Finance Policy" | New-ADCentralAccessPolicy "Human Resources Policy" -Description "For the Human Resources Department." -``` - -Description - ------------ - -Create a new central access policy named "Human Resources Policy" using the property values from 'Finance Policy', and set the description to "For the Human Resources Department." - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an Active Directory object to use as a template for a new Active Directory object. - -You can use an instance of an existing Active Directory object as a template or you can construct a new Active Directory object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new Active Directory object. - -Method 1: Use an existing Active Directory object as a template for a new object. -To retrieve an instance of an existing Active Directory object, use a cmdlet such as Get-ADObject. -Then provide this object to the Instance parameter of the New-ADObject cmdlet to create a new Active Directory object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADObject -Identity saraDavisDesktop - -New-ADObject -Name "ellenAdamsDesktop" -Instance $ObjectInstance -Type "computer" - -Method 2: Create a new ADObject and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADObject cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADObject $objectInstance.Description = "Ellen Adams New Computer" New-ADObject -Name ellenAdamsDesktop -Instance $ObjectInstance -Type computer - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "Finance Policy" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -An Active Directory object that is a template for the new object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -Returns the new central access policy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/New-ADCentralAccessRule.md b/docset/winserver2012-ps/activedirectory/New-ADCentralAccessRule.md deleted file mode 100644 index c258d90161..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADCentralAccessRule.md +++ /dev/null @@ -1,368 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adcentralaccessrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADCentralAccessRule - -## SYNOPSIS -Creates a new central access rule in Active Directory. - -## SYNTAX - -``` -New-ADCentralAccessRule [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-CurrentAcl ] [-Description ] [-Instance ] [-Name] [-PassThru] - [-ProposedAcl ] [-ProtectedFromAccidentalDeletion ] [-ResourceCondition ] - [-Server ] [] -``` - -## DESCRIPTION -The New-ADCentralAccessRule cmdlet creates a new central access rule in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADCentralAccessRule "Finance Documents Rule" -``` - -Description - ------------ - -Creates a new central access rule named 'Finance Documents Rule'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentAcl -This parameter specifies the currently effective access control list (ACL) of the rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an Active Directory object to use as a template for a new Active Directory object. - -You can use an instance of an existing Active Directory object as a template or you can construct a new Active Directory object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new Active Directory object. - -Method 1: Use an existing Active Directory object as a template for a new object. -To retrieve an instance of an existing Active Directory object, use a cmdlet such as Get-ADObject. -Then provide this object to the Instance parameter of the New-ADObject cmdlet to create a new Active Directory object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADObject -Identity saraDavisDesktop - -New-ADObject -Name "ellenAdamsDesktop" -Instance $ObjectInstance -Type "computer" - -Method 2: Create a new ADObject and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADObject cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADObject $objectInstance.Description = "Ellen Adams New Computer" New-ADObject -Name ellenAdamsDesktop -Instance $ObjectInstance -Type computer - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADCentralAccessRule -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProposedAcl -This parameter specifies the proposed accessed control list (ACL) of the rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceCondition -This parameter specifies the resource condition of the rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessRule -An Active Directory object that is a template for the new object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessRule -Returns the new central access rule object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/activedirectory/New-ADClaimTransformPolicy.md b/docset/winserver2012-ps/activedirectory/New-ADClaimTransformPolicy.md deleted file mode 100644 index 389d9c5e35..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADClaimTransformPolicy.md +++ /dev/null @@ -1,455 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adclaimtransformpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADClaimTransformPolicy - -## SYNOPSIS -Creates a new claim transformation policy object in Active Directory. - -## SYNTAX - -### AllowAll -``` -New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AllowAll] [-AuthType ] - [-Credential ] [-Description ] [-Name] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Server ] [] -``` - -### AllowAllExcept -``` -New-ADClaimTransformPolicy [-WhatIf] [-Confirm] -AllowAllExcept [-AuthType ] - [-Credential ] [-Description ] [-Name] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Server ] [] -``` - -### DenyAll -``` -New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-DenyAll] [-Description ] [-Name] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Server ] [] -``` - -### DenyAllExcept -``` -New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -DenyAllExcept [-Description ] [-Name] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Server ] [] -``` - -### Identity -``` -New-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Description ] [-Instance ] [-Name] [-PassThru] - [-ProtectedFromAccidentalDeletion ] -Rule [-Server ] [] -``` - -## DESCRIPTION -The New-ADClaimTransformPolicy cmdlet creates a new claims transformation policy object in Active Directory. -A claims transformation policy object contains a set of rules authored in the transformation rule language. -After creating a policy object, you can link it with a forest trust to apply the claims transformation to the trust. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADClaimTransformPolicy DenyAllPolicy -DenyAll -``` - -Description - ------------ - -Create a new claims transformation policy named 'DenyAllPolicy' that denies all claims, both those that are sent as well as those that are received. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department -``` - -Description - ------------ - -Create a new claims transformation policy named 'AllowAllExceptCompanyAndDepartmentPolicy' that allows all claims to be sent or received except for the claims 'Company' and 'Department'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ceb0fe88a125db", Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);' -``` - -Description - ------------ - -Create a new claims transformation policy named 'HumanResourcesToHrPolicy' that transforms the value 'Human Resources' to 'HR' in the claim 'Department'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$rule = Get-Content C:\rule.txt; -New-ADClaimTransformPolicy MyRule -Rule $rule -``` - -Description - ------------ - -Create a new claims transformation policy named 'MyRule' with the rule specified in C:\rule.txt. - -## PARAMETERS - -### -AllowAll -When this parameter is specified, the policy sets a claims transformation rule that would allow all claims to be sent or received. - -```yaml -Type: SwitchParameter -Parameter Sets: AllowAll -Aliases: -Accepted values: true - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowAllExcept -When this parameter is specified, the policy sets a claims transformation rule that would allow all claims to be sent or received except for the specified claim types. - -```yaml -Type: ADClaimType[] -Parameter Sets: AllowAllExcept -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyAll -When this parameter is specified, the policy sets a claims transformation rule that would deny all claims to be sent or received. - -```yaml -Type: SwitchParameter -Parameter Sets: DenyAll -Aliases: -Accepted values: true - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DenyAllExcept -When this parameter is specified, the policy sets a claims transformation rule that would deny all claims to be sent or received except for the specified claim types. - -```yaml -Type: ADClaimType[] -Parameter Sets: DenyAllExcept -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an Active Directory object to use as a template for a new claims transformation policy object. - -You can use an instance of an existing claims transformation policy object as a template or you can construct a new claims transformation policy object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new claims transformation policy object. - -Method 1: Use an existing claims transformation policy object as a template for a new object. -To retrieve an instance of an existing claims transformation policy object, use a cmdlet such as Get-ADClaimsTransformationPolicy. -Then provide this object to the Instance parameter of the New-ADClaimsTransformationPolicy cmdlet to create a new claims transformation policy object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADClaimsTransformationPolicy -Identity "Allow All except Finance Policy" - -New-ADClaimsTransformationPolicy -Name "Allow All Except Pii Policy" -Instance $ObjectInstance - -Method 2: Create a new ADClaimsTransformationPolicy and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADClaimsTransformationPolicy cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimsTransformationPolicy $objectInstance.Description = "For finance only." - -New-ADClaimsTransformationPolicy -Name "Deny All except Finance Policy" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "Allow All Policy" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rule -Represents the claims transformation rule. -To specify the rule, you can either (1) type the rule in a text file, and then pass the file to the cmdlet (recommended), or (2) type the rule inline. - -For example, the following commands demonstrate how to create a new claims transformation policy object with the rule specified in a text file named Rule.txt located in a temporary folder C:\temp. - -$rule = Get-Content C:\temp\rule.txt; - -New-ADClaimTransformPolicy MyRule -Rule $rule - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy -A claims transformation policy object that is a template for the new claims transformation policy object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/New-ADClaimType.md b/docset/winserver2012-ps/activedirectory/New-ADClaimType.md deleted file mode 100644 index a720937432..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADClaimType.md +++ /dev/null @@ -1,669 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adclaimtype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADClaimType - -## SYNOPSIS -Creates a new claim type in Active Directory. - -## SYNTAX - -### SourceAttribute (Default) -``` -New-ADClaimType [-WhatIf] [-Confirm] [-AppliesToClasses ] [-AuthType ] - [-Credential ] [-Description ] [-DisplayName] [-Enabled ] - [-ID ] [-Instance ] [-IsSingleValued ] [-OtherAttributes ] - [-PassThru] [-ProtectedFromAccidentalDeletion ] [-RestrictValues ] [-Server ] - -SourceAttribute [-SuggestedValues ] [] -``` - -### SourceOID -``` -New-ADClaimType [-WhatIf] [-Confirm] [-AppliesToClasses ] [-AuthType ] - [-Credential ] [-Description ] [-DisplayName] [-Enabled ] - [-ID ] [-Instance ] [-IsSingleValued ] [-OtherAttributes ] - [-PassThru] [-ProtectedFromAccidentalDeletion ] [-RestrictValues ] [-Server ] - -SourceOID [] -``` - -### SourceTransformPolicy -``` -New-ADClaimType [-WhatIf] [-Confirm] [-AppliesToClasses ] [-AuthType ] - [-Credential ] [-Description ] [-DisplayName] [-Enabled ] - [-ID ] [-Instance ] [-IsSingleValued ] [-OtherAttributes ] - [-PassThru] [-ProtectedFromAccidentalDeletion ] [-RestrictValues ] [-Server ] - [-SourceTransformPolicy] [-SuggestedValues ] -ValueType - [] -``` - -## DESCRIPTION -The New-ADClaimType cmdlet creates a new claim type in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADClaimType Title -SourceAttribute title -``` - -Description - ------------ - -Create a new user claim type with display name 'Title' that is sourced from the AD attribute 'title'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$fullTime = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("FTE", "Full-Time", "Full-time employee"); -$intern = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Intern", "Intern", "Student employee"); -$contractor = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Contractor", "Contractor", "Contract employee"); -New-ADClaimType "Employee Type" -SourceAttribute employeeType -SuggestedValues $fullTime,$intern,$contractor -``` - -Description - ------------ - -Create a new user claim type with display name 'Employee Type' that is sourced from the AD attribute 'employeeType'. -The suggested values are set to 'FTE', 'Intern', and 'Contractor'. -Applications using this claim type would allow their users to specify one of the suggested values as this claim type's value. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADClaimType "Bitlocker Enabled" -SourceOID "1.3.6.1.4.1.311.67.1.1" -Enabled $FALSE -``` - -Description - ------------ - -Create a new device claim type with display name 'Bitlocker Enabled' with the source OID '1.3.6.1.4.1.311.67.1.1'. -The claim type set to disabled. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -PS C:\>New-ADClaimType Title -SourceAttribute title -ID "ad://ext/title" -``` - -Description - ------------ - -Create a new user claim type with display name 'Title' that is sourced from the AD attribute 'title' and ID set to 'ad://ext/title'. - -The ID should only be set manually in a multi-forest environment where the same claim type needs to work across forests. -By default, New-ADClaimType generates the ID automatically. -For claim types to be considered identical across forests, their ID must be the same. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -PS C:\>New-ADClaimType SourceForest -SourceTransformPolicy -ValueType String -``` - -Create a new claim type with display name 'SourceForest' that is sourced from the claims transformation policy engine. - -## PARAMETERS - -### -AppliesToClasses -This parameter is used to specify the security principal classes to which this claim applies. -Possible values for this parameter include the following (or any Active Directory type that derives from these base types): - -- User -- Computer -- InetOrgPerson -- msDS-ManagedServiceAccount -- msDS-GroupManagedServiceAccount - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Depending on SourceAttribute / SourceOID, the value is set to User / Computer respectively -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the claim type, which must be unique. -The display name of a claim type can be used as an identity in other Active Directory cmdlets. -For example, if the display name of a claim type is "Employee Type", then you can use 'Get-ADClaimType -Identity "Employee Type"' to retrieve the claim type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Specifies if the claim type is enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ID -Specifies the claim type ID. -This is an optional parameter. -By default, New-ADClaimType generates the ID automatically. - -The ID should only be set manually in a multi-forest environment where the same claim types need to work across forests. -For claim types to be considered identical across forests, their ID must be the same. - -To specify the ID, the ID string must conform to the following format: - -1. It must have a maximum of 37 characters. - -2. It must have at least one slash (/). - -3. It must have at least one colon before the first slash. - -4. It must not have the slash as the last character. - -5. It must contain valid file characters only. - -An example is "ad://ext/BusinessImpact". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Auto-generated -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an claim type object to use as a template for a new claim type object. - -You can use an instance of an existing claim type object as a template or you can construct a new claim type object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new claim type object. - -Method 1: Use an existing claim type object as a template for a new object. -To retrieve an instance of an existing claim type object, use a cmdlet such as Get-ADClaimType. -Then provide this object to the Instance parameter of the New-ADClaimType cmdlet to create a new claim type object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADClaimType -Identity "Employee Type" - -New-ADClaimType -Name "Employee Type" -Instance $ObjectInstance - -Method 2: Create a new claim type and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADClaimType cmdlet to create the new claim type object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimType - -$objectInstance.Description = "Employee Type can be full-time, intern or contractor." - -New-ADClaimType -Name "Employee Type" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADClaimType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsSingleValued -Specifies whether the claim type is single valued or multi-valued. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RestrictValues -This parameter is used to specify whether the claim type may have values outside of the SuggestedValues. -If this is set to true, then the claim should only have values specified in the SuggestedValues. - -Note that Active Directory does not enforce this restriction. -It is up to the applications that use these claims to enforce the restriction. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAttribute -Specifies an Active Directory attribute from which this claim type is based, and from which the claim value is obtained. -The input must be the distinguished name (DN), Name, or GUID of the attribute definition in the schema. - -Acceptable values include attributes of the following schema class objects: - -User, InetOrgPerson, Computer, ManagedServiceAccount, GroupManagedServiceAccount, and Auxiliary class objects - -Except: - -- Attributes marked as defunct in the schema -- Blocked attributes such as dBCSPwd, lmPwdHistory, and unicodePwd -- Attributes that are not replicated -- Attributes that are not available on read-only domain controllers -- Attributes with syntaxes not based on the following -- String Object (DS-DN) -- String (Unicode) -- Boolean -- Integer -- Large Integer -- String (OID) -- String (SD) - -```yaml -Type: String -Parameter Sets: SourceAttribute -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceOID -Can be used to configure a certificate-based claim type source. -For example, use this parameter to create certificate-based claim types when you want to use smartcard logon claims for authorization decisions. -The SourceOID parameter uses the string representation of an object identifier (OID) from the issuance policy found in the certificate and on the certificate template when using Active Directory Certificate Services. -An example of an OID is "1.3.6.1.4.1.311.47.2.5". - -```yaml -Type: String -Parameter Sets: SourceOID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceTransformPolicy -Indicates that the claim type is sourced from the claims transformation policy engine. - -```yaml -Type: SwitchParameter -Parameter Sets: SourceTransformPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuggestedValues -Specifies one or more suggested values for the claim type. -An application may choose to present this list of suggested values for the user to choose from. -When the RestrictValues switch is set (to a value of True), the application should limit the user to selecting values from this list only. - -Example: - -$fullTime = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("FTE", "Full-Time", - -"Full-time employee"); - -$intern = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Intern", "Intern", "Student - -employee"); - -$contractor = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Contractor", "Contractor", - -"Contract employee"); - -New-ADClaimType "Employee Type" -SourceAttribute employeeType -SuggestedValues $fullTime,$intern,$contractor - -```yaml -Type: ADSuggestedValueEntry[] -Parameter Sets: SourceAttribute, SourceTransformPolicy -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValueType -Specifies the value type for this claim type. -Below is a list of the valid value types: - -- Int64 - -- UInt64 - -- String - -- FQBN - -- SID - -- Boolean - -- OctetString - -```yaml -Type: ADClaimValueType -Parameter Sets: SourceTransformPolicy -Aliases: -Accepted values: Invalid, Int64, UInt64, String, FQBN, SID, Boolean, OctetString - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimType - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimType - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/New-ADComputer.md b/docset/winserver2012-ps/activedirectory/New-ADComputer.md deleted file mode 100644 index a7e25c50a1..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADComputer.md +++ /dev/null @@ -1,1121 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adcomputer?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADComputer - -## SYNOPSIS -Creates a new Active Directory computer. - -## SYNTAX - -``` -New-ADComputer [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AccountPassword ] [-AllowReversiblePasswordEncryption ] [-AuthType ] - [-CannotChangePassword ] [-Certificates ] [-ChangePasswordAtLogon ] - [-CompoundIdentitySupported ] [-Credential ] [-Description ] - [-DisplayName ] [-DNSHostName ] [-Enabled ] [-HomePage ] - [-Instance ] [-KerberosEncryptionType ] [-Location ] - [-ManagedBy ] [-Name] [-OperatingSystem ] [-OperatingSystemHotfix ] - [-OperatingSystemServicePack ] [-OperatingSystemVersion ] [-OtherAttributes ] - [-PassThru] [-PasswordNeverExpires ] [-PasswordNotRequired ] [-Path ] - [-PrincipalsAllowedToDelegateToAccount ] [-SAMAccountName ] [-Server ] - [-ServicePrincipalNames ] [-TrustedForDelegation ] [-UserPrincipalName ] - [] -``` - -## DESCRIPTION -The New-ADComputer cmdlet creates a new Active Directory computer object. -This cmdlet does not join a computer to a domain. -You can set commonly used computer property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the OtherAttributes parameter. - -You can use this cmdlet to provision a computer account before the computer is added to the domain. -These pre-created computer objects can be used with offline domain join, unsecure domain Join and RODC domain join scenarios. - -The Path parameter specifies the container or organizational unit (OU) for the new computer. -When you do not specify the Path parameter, the cmdlet creates a computer account in the default container for computer objects in the domain. - -The following methods explain different ways to create an object by using this cmdlet. - -Method 1: Use the New-ADComputer cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -Method 2: Use a template to create the new object. -To do this, create a new computer object or retrieve a copy of an existing computer object and set the Instance parameter to this object. -The object provided to the Instance parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the Instance parameter description for this cmdlet. - -Method 3: Use the Import-CSV cmdlet with the Add-ADComputer cmdlet to create multiple Active Directory computer objects. -To do this, use the Import-CSV cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the New-ADComputer cmdlet to create the computer objects. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADComputer -Name "FABRIKAM-SRV2" -SamAccountName "FABRIKAM-SRV2" -Path "OU=ApplicationServers,OU=ComputerAccounts,OU=Managed,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Create a new computer account in the OU: "OU=ApplicationServers,OU=ComputerAccounts,OU=Managed,DC=FABRIKAM,DC=COM". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADComputer -Name "FABRIKAM-SRV3" -SamAccountName "FABRIKAM-SRV3" -Path "OU=ApplicationServers,OU=ComputerAccounts,OU=Managed,DC=FABRIKAM,DC=COM" -Enabled $true -Location "Redmond,WA" -``` - -Description - ------------ - -Create a new computer account under a particular OU, which is enabled and located in "Redmond,WA". - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>$templateComp = get-adcomputer "LabServer-00" -properties "Location","OperatingSystem","OperatingSystemHotfix","OperatingSystemServicePack","OperatingSystemVersion"; New-ADComputer -Instance $templateComp -Name "LabServer-01" -``` - -Description - ------------ - -Creates a new computer account from a template object. - -## PARAMETERS - -### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the AccountExpirationDate property of an account object. -The LDAP Display name (ldapDisplayName) for this property is accountExpires. - -Use the DateTime syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. -The following examples show commonly-used syntax to specify a DateTime object. - -"4/17/2006" - -"Monday, April 17, 2006" - -"2:22:45 PM" - -"Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -"4/17/2006 2:22 PM" - -"Monday, April 17, 2006 2:22 PM" - -"2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - -"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - -"2006-04-17T14:22:48.0000000" - -The following example shows how to set this parameter to the date May 1, 2012 at 5 PM. - --AccountExpirationDate "05/01/2012 5:00:00 PM" - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountNotDelegated -Specifies whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the AccountNotDelegated property for an Active Directory account. -This parameter also sets the ADS_UF_NOT_DELEGATED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the security context of the account is not delegated to a service. - --AccountNotDelegated $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountPassword -Specifies a new password value for an account. -This value is stored as an encrypted string. - -The following conditions apply based on the manner in which the password parameter is used: - -$null password is specified - Random password is set and the account is enabled unless it is requested to be disabled - -No password is specified - Random password is set and the account is enabled unless it is requested to be disabled - -User password is specified - Password is set and the account is enabled unless it is requested to be disabled, unless the password you provided does not meet password policy or was not set for other reasons, at which point the account is disabled - -Notes: Computer accounts, by default, are created with a 240-character random password. -If you provide a password, an attempt will be made to set that password however, this can fail due to password policy restrictions. -The computer account will still be created and you can use Set-ADAccountPassword to set the password on that account. -In order to ensure that accounts remain secure, computer accounts will never be enabled unless a valid password is set (either a randomly-generated or user-provided one) or PasswordNotRequired is set to true. - -The account is created if the password fails for any reason. - -The new ADComputer object will always either be disabled or have a user-requested or randomly-generated password. -There is no way to create an enabled computer account object with a password that violates domain password policy, such as an empty password. - -The following example shows how to set this parameter. -This command will prompt you to enter the password. - --AccountPassword (Read-Host -AsSecureString "AccountPassword") - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowReversiblePasswordEncryption -Specifies whether reversible password encryption is allowed for the account. -This parameter sets the AllowReversiblePasswordEncryption property of the account. -This parameter also sets the ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --AllowReversiblePasswordEncryption $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CannotChangePassword -Specifies whether the account password can be changed. -This parameter sets the CannotChangePassword property of an account. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the account password can be changed. - --CannotChangePassword $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Certificates -Modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the Certificates property of the account object. -The LDAP Display Name (ldapDisplayName) for this property is "userCertificate". - -```yaml -Type: X509Certificate[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ChangePasswordAtLogon -Specifies whether a password must be changed during the next logon attempt. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -This parameter cannot be set to $true or 1 for an account that also has the PasswordNeverExpires property set to true. - -The following example shows how to set this parameter so that the password must be changed at logon. - --ChangePasswordAtLogon $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompoundIdentitySupported -Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account supports service tickets with device authorization data. - --SupportDeviceAuthz $true - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DNSHostName -Specifies the fully qualified domain name (FQDN) of the computer. -This parameter sets the DNSHostName property for a computer object. -The LDAP Display Name for this property is "dNSHostName". - -The following example shows how to set this parameter to a FQDN. - --DNSHostName "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Specifies if an account is enabled. -An enabled account requires a password. -This parameter sets the Enabled property for an account object. -This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to enable the account. - --Enabled $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the homePage property of an Active Directory object. -The LDAP Display Name (ldapDisplayName) for this property is "wWWHomePage". - -The following example shows how to set this parameter to a URL. - --HomePage "http://employees.contoso.com/sdavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a computer object to use as a template for a new computer object. - -You can use an instance of an existing computer object as a template or you can construct a new computer object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create computer object templates. - -Method 1: Use an existing computer object as a template for a new object. -To retrieve an instance of an existing computer object use Get-ADcomputer. -Then provide this object to the Instance parameter of the New-ADcomputer cmdlet to create a new computer object. -You can override property values of the new object by setting the appropriate parameters. - -$computerInstance = Get-ADcomputer -Identity ellenAdamsDesktop - -New-ADcomputer -Name "saraDavisDesktop" -Instance $computerInstance -AccountPassword "MustChange242" - --samAccountName "saraDavisDesktop" - -Method 2: Create a new ADcomputer object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADcomputer cmdlet to create the new Active Directory computer object. - -$computerInstance = new-object Microsoft.ActiveDirectory.Management.ADcomputer - -New-ADcomputer -Name "saraDavisDesktop" -Instance $computerInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADComputer -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -None - -DES - -RC4 - -AES128 - -AES256 - -None, will remove all encryption types from the account which may result in the KDC being unable to issue service tickets for services using the account. - -DES is a weak encryption type which is not supported by default since Windows 7 and Windows Server 2008 R2. - -The following example shows how to specify that an account supports service tickets with device authorization data. - --KerberosEncryptionTypes RC4|AES128|AES256 - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: ADKerberosEncryptionType -Parameter Sets: (All) -Aliases: -Accepted values: None, DES, RC4, AES128, AES256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the computer, such as an office number. -This parameter sets the Location property of a computer. -The LDAP display name (ldapDisplayName) of this property is "location". - -The following example shows how to set this parameter. - --Location "Test Lab A" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystem -Specifies an operating system name. -This parameter sets the OperatingSystem property of the computer object. -The LDAP Display Name (ldapDisplayName) for this property is "operatingSystem". - -The following example shows how to set this parameter. - --OperatingSystem "Windows Server 2008 Enterprise" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystemHotfix -Specifies an operating system hotfix name. -This parameter sets the operatingSystemHotfix property of the computer object. -The LDAP display name for this property is "operatingSystemHotfix". - -The following example shows how to specify this parameter. - --operatingSystemHotfix "523466" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystemServicePack -Specifies the name of an operating system service pack. -This parameter sets the OperatingSystemServicePack property of the computer object. -The LDAP display name (ldapDisplayName) for this property is "operatingSystemServicePack". - -The following example shows how to specify this parameter. - --OperatingSystemServicePack "Service Pack 2" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperatingSystemVersion -Specifies an operating system version. -This parameter sets the OperatingSystemVersion property of the computer object. -The LDAP display name (ldapDisplayName) for this property is "operatingSystemVersion". - -The following example shows how to specify this parameter. - --OperatingSystemVersion "6.0 (6001)" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNeverExpires -Specifies whether the password of an account can expire. -This parameter sets the PasswordNeverExpires property of an account object. -This parameter also sets the ADS_UF_DONT_EXPIRE_PASSWD flag of the Active Directory User Account Control attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -Note: This parameter cannot be set to $true or 1 for an account that also has the ChangePasswordAtLogon property set to true. - -The following example shows how to set this parameter so that the password can expire. - --PasswordNeverExpires $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PasswordNotRequired -Specifies whether the account requires a password. -This parameter sets the PasswordNotRequired property of an account, such as a user or computer account. -This parameter also sets the ADS_UF_PASSWD_NOTREQD flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that as password is not required for the account. - --PasswordNotRequired $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created. - -In many cases, a default value will be used for the Path parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If the target AD LDS instance has a default naming context, the default value of Path will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Path parameter will not take any default value. - -The following example shows how to set this parameter to an OU. - --Path "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, Rename-Item and Set-ItemProperty also contain a Path property. -However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToDelegateToAccount -Specifies the accounts which can act on the behalf of users to services running as this computer account. -This parameter sets the msDS-AllowedToActOnBehalfOfOtherIdentity attribute of a computer account object. - -```yaml -Type: ADPrincipal[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SAMAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 15 characters or less. -This parameter sets the SAMAccountName for an account object. -The LDAP display name (ldapDisplayName) for this property is "sAMAccountName". - -The following example shows how to specify this parameter. - --SAMAccountName "saradavis" - -Note: If the SAMAccountName string provided, does not end with a '$', one will be appended if needed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalNames -Specifies the service principal names for the account. -This parameter sets the ServicePrincipalNames property of the account. -The LDAP display name (ldapDisplayName) for this property is servicePrincipalName. -To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`." - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the TrustedForDelegation property of an account object. -This value also sets the ADS_UF_TRUSTED_FOR_DELEGATION flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account is trusted for Kerberos delegation. - --TrustedForDelegation $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -Each user account has a user principal name (UPN) in the format \@\. -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. -The UPN is independent of the user object's DN, so a user object can be moved or renamed without affecting the user logon name. -When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog box. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -A computer object that is a template for the new computer object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -Returns the new computer object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADComputerServiceAccount](./Get-ADComputerServiceAccount.md) - -[Remove-ADComputer](./Remove-ADComputer.md) - -[Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) - -[Set-ADComputer](./Set-ADComputer.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADDCCloneConfigFile.md b/docset/winserver2012-ps/activedirectory/New-ADDCCloneConfigFile.md deleted file mode 100644 index b6e8036939..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADDCCloneConfigFile.md +++ /dev/null @@ -1,412 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-addccloneconfigfile?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADDCCloneConfigFile - -## SYNOPSIS -Performs prerequisite checks for cloning a domain controller and generates a clone configuration file if all checks succeed. - -## SYNTAX - -### IPv4DynamicSettings (Default) -``` -New-ADDCCloneConfigFile [-CloneComputerName ] [-IPv4DNSResolver ] [-Path ] - [-SiteName ] [] -``` - -### IPv4StaticSettings -``` -New-ADDCCloneConfigFile [-AlternateWINSServer ] [-CloneComputerName ] -IPv4Address - [-IPv4DefaultGateway ] -IPv4DNSResolver -IPv4SubnetMask [-Path ] - [-PreferredWINSServer ] [-SiteName ] [-Static] [] -``` - -### OfflineExecution -``` -New-ADDCCloneConfigFile [-AlternateWINSServer ] [-CloneComputerName ] [-IPv4Address ] - [-IPv4DefaultGateway ] [-IPv4DNSResolver ] [-IPv4SubnetMask ] - [-IPv6DNSResolver ] [-Offline] -Path [-PreferredWINSServer ] [-SiteName ] - [-Static] [] -``` - -### IPv6DynamicSettings -``` -New-ADDCCloneConfigFile [-CloneComputerName ] [-IPv6DNSResolver ] [-Path ] - [-SiteName ] [] -``` - -### IPv6StaticSettings -``` -New-ADDCCloneConfigFile [-CloneComputerName ] -IPv6DNSResolver [-Path ] - [-SiteName ] [-Static] [] -``` - -## DESCRIPTION -The New-DCCloneConfigFile cmdlet performs prerequisite checks for cloning a domain controller (DC) when run locally on the DC being prepared for cloning. -This cmdlet generates a clone configuration file, DCCloneConfig.xml, at an appropriate location, if all prerequisite checks succeed. - -There are two mode of operation for this cmdlet, depending on where it is executed. -When run on the domain controller that is being prepared for cloning, it will run the following pre-requisite checks to make sure this DC is adequately prepared for cloning: - -(1) Is the PDC emulator FSMO role hosted on a DC running Windows Server 2012? -(2) Is this computer authorized for DC cloning (i.e. -is the computer a member of the Cloneable Domain Controllers group)? -(3) Are all program and services listed in the output of the Get-ADDCCloningExcludedApplicationList cmdlet captured in CustomDCCloneAllowList.xml? - -If these pre-requisite checks all pass, the New-DCCloneConfigFile cmdlet will generate a DCCloneConfig.xml file at a suitable location based on the parameter values supplied. -This cmdlet can also be run from a client (with RSAT) and used to generate a DCCloneConfig.xml against offline media of the DC being cloned, however, none of the pre-requisite checks will be performed in this usage mode. -This usage is intended to generate DCCloneConfig.xml files with specific configuration values for each clone on copies of the offline media. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -Static -IPv4Address "10.0.0.2" -IPv4DNSResolver "10.0.0.1" -IPv4SubnetMask "255.255.255.0" -CloneComputerName "VirtualDC2" -IPv4DefaultGateway "10.0.0.3" -PreferredWINSServer "10.0.0.1" -SiteName "REDMOND" -``` - -Creates a clone domain controller named VirtualDC2 with a static IPv4 address. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -Static -CloneComputerName "Clone1" -IPv6DNSResolver "FEC0:0:0:FFFF::1" -``` - -Creates a clone domain controller named Clone1 with a static IPv6 settings. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -AlternateWINSServer "10.0.0.3" -CloneComputerName "Clone2"-IPv4DNSResolver "10.0.0.1" -PreferredWINSServer "10.0.0.1" -``` - -Creates a clone domain controller named Clone2 with dynamic IPv4 settings. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -IPv6DNSResolver "FEC0:0:0:FFFF::1" -SiteName "REDMOND" -``` - -Creates a clone domain controller with dynamic IPv6 settings. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -Static -IPv4Address "10.0.0.2" -IPv4DNSResolver "10.0.0.1" -IPv4SubnetMask "255.255.255.0" -Static -IPv6DNSResolver "FEC0:0:0:FFFF::1" -CloneComputerName "Clone2" -PreferredWINSServer "10.0.0.1" -``` - -Creates a clone domain controller named Clone2 with static IPv4 and static IPv6 settings. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -IPv4Address "10.0.0.2" -IPv4DNSResolver "10.0.0.1" -IPv4SubnetMask "255.255.255.0" -IPv4DefaultGateway "10.0.0.3" -IPv6DNSResolver "FEC0:0:0:FFFF::1" -``` - -Creates a clone domain controller named Clone2 with static IPv4 and dynamic IPv6 settings. - -### -------------------------- EXAMPLE 7 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -Static -IPv6DNSResolver "FEC0:0:0:FFFF::1" -CloneComputerName "Clone1" -PreferredWINSServer "10.0.0.1" -SiteName "REDMOND" -``` - -Creates a clone domain controller named Clone1 with dynamic IPv4 and static IPv6 settings. - -### -------------------------- EXAMPLE 8 -------------------------- -``` -PS C:\>New-ADDCCloneConfigFile -IPv4DNSResolver "10.0.0.1" -IPv6DNSResolver "FEC0:0:0:FFFF::1" -``` - -Creates a clone domain controller with dynamic IPv4 and dynamic IPv6 settings. - -### -------------------------- EXAMPLE 9 -------------------------- -``` -PS C:\>New-DCCloneConfig -Offline -CloneComputerName CloneDC1 -SiteName REDMOND -Path F:\Windows\NTDS -Force -``` - -Creates a clone domain controller named CloneDC1 in offline mode, in a site called "REDMOND" with a dynamic IPv4 address. -This command also uses the -Force parameter to force overwrite of any previous DCCloneConfig.xml file created at the specified path (F:\Windows\NTDS). - -## PARAMETERS - -### -AlternateWINSServer -Specifies the name of the alternate Windows Internet Naming Service (WINS) server for the cloned DC to use if the preferred WINS Server is not available. - -```yaml -Type: String -Parameter Sets: IPv4StaticSettings, OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CloneComputerName -Specifies the computer name for the cloned DC. -If this parameter is not specified as a unique name within the enterprise of 15 characters or less, the following formula is used to programmatically generate a name: - -(1) The first 8 characters of the source DC computer name. -For example, a source computer name of "SourceComputer" is truncated to a prefix string of "SourceCo". -(2) A unique naming suffix of the format "**-CL**nnnn" is appended to the prefix string where nnnn is the next available value from 0001-9999 that the PDC determines is not currently in use. -For example, if 0047 is the next available number within the allowed range, using the above source computer prefix of "SourceCo" the derived name to use for the clone computer will be SourceCo-CL0047. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: cn - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4Address -Specifies the Internet Protocol version 4 (IPv4) address to be assigned to the cloned DC. - -```yaml -Type: String -Parameter Sets: IPv4StaticSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4DNSResolver -Specifies the Internet Protocol version 4 (IPv4) address for the DNS server to be used by the cloned DC to resolve names. -A maximum of 4 string values can be provided. - -```yaml -Type: String[] -Parameter Sets: IPv4DynamicSettings, OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String[] -Parameter Sets: IPv4StaticSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4DefaultGateway -Specifies the Internet Protocol version 4 (IPv4) address for the default gateway to be used by the cloned DC. - -```yaml -Type: String -Parameter Sets: IPv4StaticSettings, OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4SubnetMask -Specifies the Internet Protocol version 4 (IPv4) subnet mask to use for the subnet where the cloned DC is to be located. - -```yaml -Type: String -Parameter Sets: IPv4StaticSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6DNSResolver -Specifies the Internet Protocol version 6 (IPv6) address for the DNS server to be used by the cloned DC to resolve names. - -```yaml -Type: String[] -Parameter Sets: OfflineExecution, IPv6DynamicSettings -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String[] -Parameter Sets: IPv6StaticSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Offline -Indicates whether the cmdlet is being run against an offline media or on the DC being prepared for cloning. - -```yaml -Type: SwitchParameter -Parameter Sets: OfflineExecution -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the folder path to use when writing the clone configuration file. -If the cmdlet is run and all prerequisite checks succeed, a DCCloneConfig.xml file will be written and appear in this location as output. -The **Path** parameter is optional when running the cmdlet on the DC being prepared for cloning. -In this case, the default location of the DIT folder will be used and this parameter does not need to be specified. -When running the New-DCCLoneConfigFile cmdlet in offline mode (i.e. -when the **Offline** parameter is specified), however, the **Path** parameter is required. - -```yaml -Type: String -Parameter Sets: IPv4DynamicSettings, IPv4StaticSettings, IPv6DynamicSettings, IPv6StaticSettings -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: OfflineExecution -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferredWINSServer -Specifies the name of the primary Windows Internet Naming Service (WINS) server to use as the preferred WINS Server for the cloned DC. - -```yaml -Type: String -Parameter Sets: IPv4StaticSettings, OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of the Active Directory site in which to place the cloned DC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Static -Indicates whether the TCP/IP configuration specified for the cloned DC is static or dynamic IP configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: IPv4StaticSettings, IPv6StaticSettings -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: OfflineExecution -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-ADDCCloningExcludedApplicationList](./Get-ADDCCloningExcludedApplicationList.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md deleted file mode 100644 index 78f9de95d0..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADFineGrainedPasswordPolicy.md +++ /dev/null @@ -1,622 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adfinegrainedpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADFineGrainedPasswordPolicy - -## SYNOPSIS -Creates a new Active Directory fine-grained password policy. - -## SYNTAX - -```powershell -New-ADFineGrainedPasswordPolicy [-WhatIf] [-Confirm] [-AuthType ] [-ComplexityEnabled ] - [-Credential ] [-Description ] [-DisplayName ] - [-Instance ] [-LockoutDuration ] [-LockoutObservationWindow ] - [-LockoutThreshold ] [-MaxPasswordAge ] [-MinPasswordAge ] - [-MinPasswordLength ] [-Name] [-OtherAttributes ] [-PassThru] - [-PasswordHistoryCount ] [-Precedence] [-ProtectedFromAccidentalDeletion ] - [-ReversibleEncryptionEnabled ] [-Server ] [] -``` - -## DESCRIPTION -The **New-ADFineGrainedPasswordPolicy** cmdlet creates a new Active Directory fine-grained password policy. -You can set commonly used fine-grained password policy property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be set by using the *OtherAttributes* parameter. - -You must set the *Name* and *Precedence* parameters to create a new fine-grained password policy. - -The following methods explain different ways to create an object by using this cmdlet. - -Method 1: Use the **New-ADFineGrainedPasswordPolicy** cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -Method 2: Use a template to create the new object. -To do this, create a new fine-grained password policy object or retrieve a copy of an existing fine-grained password policy object and set the *Instance* parameter to this object. -The object provided to the *Instance* parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the *Instance* parameter description for this cmdlet. - -Method 3: Use the Import-Csv cmdlet with the **New-ADFineGrainedPasswordPolicy** cmdlet to create multiple Active Directory fine-grained password policy objects. -To do this, use the **Import-Csv** cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline operator to the **New-ADFineGrainedPasswordPolicy** cmdlet to create the fine-grained password policy objects. - -## EXAMPLES - -### Example 1: Create a fine-grained password policy -```powershell -PS C:\> New-ADFineGrainedPasswordPolicy -Name "DomainUsersPSO" -Precedence 500 -ComplexityEnabled $true -Description "The Domain Users Password Policy" -DisplayName "Domain Users PSO" -LockoutDuration "0.12:00:00" -LockoutObservationWindow "0.00:15:00" -LockoutThreshold 10 -``` - -This command creates a fine-grained password policy object named DomainUsersPSO and set the **Precedence**, **ComplexityEnabled**, **Description**, **DisplayName**, **LockoutDuration**, **LockoutObservationWindow**, and **LockoutThreshold** properties on the object. - -### Example 2: Create fine-grained password policies using a template object -```powershell -PS C:\> $TemplatePSO = New-Object Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -PS C:\> $TemplatePSO.ComplexityEnabled = $true -PS C:\> $TemplatePSO.LockoutDuration = [TimeSpan]::Parse("0.12:00:00") -PS C:\> $TemplatePSO.LockoutObservationWindow = [TimeSpan]::Parse("0.00:15:00") -PS C:\> $TemplatePSO.LockoutThreshold = 10 -PS C:\> $TemplatePSO.MinPasswordAge = [TimeSpan]::Parse("0.00:10:00") -PS C:\> $TemplatePSO.PasswordHistoryCount = 24 -PS C:\> $TemplatePSO.ReversibleEncryptionEnabled = $false -PS C:\> New-ADFineGrainedPasswordPolicy -Instance $TemplatePSO -Name "SvcAccPSO" -Precedence 100 -Description "The Service Accounts Password Policy" -DisplayName "Service Accounts PSO" -MaxPasswordAge "30.00:00:00" -MinPasswordLength 20 -PS C:\> New-ADFineGrainedPasswordPolicy -Instance $TemplatePSO -Name "AdminsPSO" -Precedence 200 -Description "The Domain Administrators Password Policy" -DisplayName "Domain Administrators PSO" -MaxPasswordAge "15.00:00:00" -MinPasswordLength 10 -``` - -This example creates two new fine-grained password policy objects using a template object. - -### Example 3: Create a fine-grained password policy with manual account unlock -```powershell -PS C:\> New-ADFineGrainedPasswordPolicy -Name "ManualUnlockPSO" -Precedence 500 -ComplexityEnabled $true -Description "Manual Unlock Password Policy" -DisplayName "Manual Unlock PSO" -LockoutDuration "00:00:00" -LockoutObservationWindow "00:00:00" -LockoutThreshold 3 -``` - -This command creates a fine-grained password policy object named ManualUnlockPSO that would require manual unlock of accounts by the administrator. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplexityEnabled -Specifies whether password complexity is enabled for the password policy. -If enabled, the password must contain three of the following four character types: - -- Uppercase characters (A, B, C, D, E, ...) -- Lowercase characters (a, b, c, d, e, ...) -- Numerals (0, 1, 2, 3, ...) -- Special characters (#, $, *, %, ...) - -This parameter sets the **ComplexityEnabled** property of a password policy. -The acceptable values for this parameter are: - -- $False or 0. -Disables password complexity. -- $True or 1. -Enables password complexity. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $true -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the **Description** property for the object. -The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName**) for this property is description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the **DisplayName** property of the object. -The LDAP display name (**ldapDisplayName**) for this property is displayName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a fine-grained password policy object to use as a template for a new fine-grained password policy object. - -You can use an instance of an existing fine-grained password policy object as a template or you can construct a new fine-grained password policy object by using the Windows PowerShell command line or by using a script. - -Method 1: Use an existing fine-grained password policy object as a template for a new object. -To retrieve an instance of an existing fine-grained password policy object, use a cmdlet such as **Get-ADFineGrainedPasswordPolicy**. -Then provide this object to the *Instance* parameter of the **New-ADFineGrainedPasswordPolicy** cmdlet to create a new fine-grained password policy object. -You can override property values of the new object by setting the appropriate parameters. - -Method 2: Create a new **ADFineGrainedPasswordPolicy** object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the *Instance* parameter of the **New-ADFineGrainedPasswordPolicy** cmdlet to create the new Active Directory fine-grained password policy object. - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockoutDuration -Specifies the length of time that an account is locked after the number of failed login attempts exceeds the lockout threshold. -You cannot log in to an account that is locked until the lockout duration time period has expired. If you set the value to 0 the account needs to be unlocked manually by the administrator. -This parameter sets the **lockoutDuration** property of a password policy object. -The LDAP display name (**ldapDisplayName**) of this property is msDS-LockoutDuration. - -The lockout duration must be greater than or equal to the lockout observation time for a password policy. -Use the *LockOutObservationWindow* parameter to set the lockout observation time. - -Specify the lockout duration time interval in the following format: - -`D.H:M:S.F` - -where: - -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) -- F= Fractions of a second (0 to 9999999) - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0.00:30:00 (30 Minutes) -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockoutObservationWindow -Specifies the maximum time interval between two unsuccessful login attempts before the number of unsuccessful login attempts is reset to 0. -An account is locked when the number of unsuccessful login attempts exceeds the password policy lockout threshold. -This parameter sets the **lockoutObservationWindow** property of a password policy object. -The LDAP display name (**ldapDisplayName**) of this property is **msDS-lockoutObservationWindow**. - -The lockout observation window must be smaller than or equal to the lockout duration for a password policy. -Use the *LockoutDuration* parameter to set the lockout duration time. - -Specify the time interval in the following format: - -`D:H:M:S.F` - -where: -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) -- F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0:0:0:0.0 and 10675199:02:48:05.4775807. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0.00.30.00 (30 Minutes) -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LockoutThreshold -Specifies the number of unsuccessful login attempts that are permitted before an account is locked out. -This number increases when the time between unsuccessful login attempts is less than the time specified for the lockout observation time window. -This parameter sets the **LockoutThreshold** property of a password policy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxPasswordAge -Specifies the maximum length of time that you can have the same password. -After this time period, the password expires and you must create a new one. - -This parameter sets the **maxPasswordAge** property of a password policy. -The LDAP display name (**ldapDisplayName**) for this property is maxPwdAge. - -Specify the time interval in the following format: - -`D.H:M:S.F` - -where: -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) -- F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0 and 10675199:02:48:05.4775807. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 42.00:00:00 (42 days) -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinPasswordAge -Specifies the minimum length of time before you can change a password. - -This parameter sets the **minPasswordAge** property of a password policy. -The LDAP display name (**ldapDisplayName**) for this property is minPwdAge. - -Specify the time interval in the following format: - -`D.H:M:S.F` - -where: -- D = Days (0 to 10675199) -- H = Hours (0 to 23) -- M = Minutes (0 to 59) -- S = Seconds (0 to 59) -- F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0 and 10675199:02:48:05. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1.00:00:00 (1day) -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinPasswordLength -Specifies the minimum number of characters that a password must contain. -This parameter sets the **MinPasswordLength** property of the password policy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 7 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the **Name** property of the Active Directory object. -The LDAP display name (**ldapDisplayName**) of this property is name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (**ldapDisplayName**) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value}` - -To specify multiple values for an attribute - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}` - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - -`-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -Specifies the number of previous passwords to save. -A user cannot reuse a password in the list of saved passwords. -This parameter sets the **PasswordHistoryCount** property for a password policy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 24 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Precedence -Specifies a value that defines the precedence of a fine-grained password policy among all fine-grained password policies. -This parameter sets the **Precedence** property for a fine-grained password policy. -The LDAP display name (**ldapDisplayName**) for this property is msDS-PasswordSettingsPrecedence. - -This value determines which password policy to use when more than one password policy applies to a user or group. -When there is a conflict, the password policy that has the lower **Precedence** property value has higher priority. -For example, if PasswordPolicy1 has a **Precedence** property value of 200 and PasswordPolicy2 has a **Precedence** property value of 100, PasswordPolicy2 is used. - -Typically, password policy precedence values are assigned in multiples of 10 or 100, making it easier to add policies at a later time. -For example, if you set the initial precedence values for your policies to 100 and 200, you can add another policy that has precedence value of 150. - -If the specified *Precedence* parameter is already assigned to another password policy object, the cmdlet returns a terminating error. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReversibleEncryptionEnabled -Specifies whether the directory must store passwords using reversible encryption. -This parameter sets the **ReversibleEncryption** property for a password policy. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $true -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -A fine-grained password policy object that is a template for the new fine-grained password policy object is received by the *Instance* parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -This cmdlet returns the new fine-grained password policy object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with Active Directory Lightweight Directory Services (AD LDS). -* This cmdlet does not work with a read-only domain controller. -* This cmdlet does not work with an Active Directory snapshot. - -## RELATED LINKS - -[Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) - -[Remove-ADFineGrainedPasswordPolicy](./Remove-ADFineGrainedPasswordPolicy.md) - -[Set-ADFineGrainedPasswordPolicy](./Set-ADFineGrainedPasswordPolicy.md) diff --git a/docset/winserver2012-ps/activedirectory/New-ADGroup.md b/docset/winserver2012-ps/activedirectory/New-ADGroup.md deleted file mode 100644 index 9aca849693..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADGroup.md +++ /dev/null @@ -1,605 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adgroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADGroup - -## SYNOPSIS -Creates an Active Directory group. - -## SYNTAX - -``` -New-ADGroup [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Description ] - [-DisplayName ] [-GroupCategory ] [-GroupScope] [-HomePage ] - [-Instance ] [-ManagedBy ] [-Name] [-OtherAttributes ] [-PassThru] - [-Path ] [-SamAccountName ] [-Server ] [] -``` - -## DESCRIPTION -The New-ADGroup cmdlet creates a new Active Directory group object. -Many object properties are defined by setting cmdlet parameters. -Properties that cannot be set by cmdlet parameters can be set using the OtherAttributes parameter. - -The Name and GroupScope parameters specify the name and scope of the group and are required to create a new group. -You can define the new group as a security or distribution group by setting the GroupType parameter. -The Path parameter specifies the container or organizational unit (OU) for the group. - -The following methods explain different ways to create an object by using this cmdlet. - -Method 1: Use the New-ADGroup cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -Method 2: Use a template to create the new object. -To do this, create a new group object or retrieve a copy of an existing group object and set the Instance parameter to this object. -The object provided to the Instance parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the Instance parameter description for this cmdlet. - -Method 3: Use the Import-CSV cmdlet with the New-ADGroup cmdlet to create multiple Active Directory group objects. -To do this, use the Import-CSV cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the New-ADGroup cmdlet to create the group objects. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADGroup -Name "RODC Admins" -SamAccountName RODCAdmins -GroupCategory Security -GroupScope Global -DisplayName "RODC Administrators" -Path "CN=Users,DC=Fabrikam,DC=Com" -Description "Members of this group are RODC Administrators" -``` - -Description - ------------ - -Create a new group named 'RODC Admins' in the container 'CN=Users,DC=Fabrikam,DC=Com' and set the GroupCategory, DisplayName, GroupScope, and Description properties on the new object. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADGroup FabrikamBranch1 -Properties Description | New-ADGroup -Name Branch1Employees -SamAccountName Branch1Employees -GroupCategory Distribution -PassThru - - -GroupScope : Universal -Name : Branch1Employees -GroupCategory : Distribution -SamAccountName : Branch1Employees -ObjectClass : group -ObjectGUID : 8eebce44-5df7-4bed-a98b-b987a702103e -SID : S-1-5-21-41432690-3719764436-1984117282-1117 -DistinguishedName : CN=Branch1Employees,CN=Users,DC=Fabrikam,DC=com -``` - -Description - ------------ - -Create a new group using the property values from a current group. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADGroup -Server localhost:60000 -Path "OU=AccountDeptOU,DC=AppNC" -Name AccountLeads -GroupScope DomainLocal -GroupCategory Distribution -``` - -Description - ------------ - -Create a new group named 'AccountLeads' on an AD LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GroupCategory -Specifies the category of the group. -Possible values of this parameter are: - -Distribution or 0 - -Security or 1 - -This parameter sets the GroupCategory property of the group. -This parameter value combined with other group values sets the LDAP Display Name (ldapDisplayName) attribute named "groupType". - -The following example shows how to specify that a group is a security group. - --GroupCategory security - -```yaml -Type: ADGroupCategory -Parameter Sets: (All) -Aliases: -Accepted values: Distribution, Security - -Required: False -Position: Named -Default value: Security -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GroupScope -Specifies the group scope of the group. -Possible values of this parameter are: - -DomainLocal or 0 - -Global or 1 - -Universal or 2 - -This parameter sets the GroupScope property of a group object to the specified value. -The LDAP display name of this property is "groupType". - -The following example shows two ways to set this parameter to DomainLocal. - --GroupScope DomainLocal - --GroupScope 0 - -```yaml -Type: ADGroupScope -Parameter Sets: (All) -Aliases: -Accepted values: DomainLocal, Global, Universal - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the homePage property of an Active Directory object. -The LDAP Display Name (ldapDisplayName) for this property is "wWWHomePage". - -The following example shows how to set this parameter to a URL. - --HomePage "http://employees.contoso.com/sdavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a group object to use as a template for a new group object. - -You can use an instance of an existing group object as a template or you can construct a new group object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create group object templates. - -Method 1: Use an existing group object as a template for a new object. -Use the Get-ADGroup cmdlet to retrieve a group object then pass this object to the Instance parameter of the New-ADGroup cmdlet to create a new group object. -You can override property values of the new object by setting the appropriate parameters. - -$groupInstance = Get-ADGroup -Identity "KarenTohReports" - -New-ADGroup -Name "Sara Davis Reports" -Instance $groupInstance GroupType DomainLocal - -Method 2: Create a new ADGroup object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADGroup cmdlet to create the new group object. - -$groupTemplate = New-Object Microsoft.ActiveDirectory.Management.ADGroup - -$groupTemplateGroupType = DomainLocal - -New-ADGroup -Name "Sara Davis Reports" -Instance $groupInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADGroup -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created. - -In many cases, a default value will be used for the Path parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If the target AD LDS instance has a default naming context, the default value of Path will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Path parameter will not take any default value. - -The following example shows how to set this parameter to an OU. - --Path "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, Rename-Item and Set-ItemProperty also contain a Path property. -However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the SAMAccountName for an account object. -The LDAP display name (ldapDisplayName) for this property is "sAMAccountName". - -The following example shows how to specify this parameter. - --SAMAccountName "saradavis" - -Note: If the string value provided is not terminated with a '$' character, the system adds one if needed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -A group object that is a template for the new group object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -Returns the new group object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADGroup](./Get-ADGroup.md) - -[Remove-ADGroup](./Remove-ADGroup.md) - -[Set-ADGroup](./Set-ADGroup.md) - -[Import-CSV](/previous-versions/powershell/module/microsoft.powershell.utility/import-csv) diff --git a/docset/winserver2012-ps/activedirectory/New-ADObject.md b/docset/winserver2012-ps/activedirectory/New-ADObject.md deleted file mode 100644 index 4167d04ae0..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADObject.md +++ /dev/null @@ -1,528 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADObject - -## SYNOPSIS -Creates an Active Directory object. - -## SYNTAX - -``` -New-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Description ] - [-DisplayName ] [-Instance ] [-Name] [-OtherAttributes ] [-PassThru] - [-Path ] [-ProtectedFromAccidentalDeletion ] [-Server ] [-Type] - [] -``` - -## DESCRIPTION -The New-ADObject cmdlet creates a new Active Directory object such as a new organizational unit or new user account. -You can use this cmdlet to create any type of Active Directory object. -Many object properties are defined by setting cmdlet parameters. -Properties that are not set by cmdlet parameters can be set by using the OtherAttributes parameter. - -You must set the Name and Type parameters to create a new Active Directory object. -The Name specifies the name of the new object. -The Type parameter specifies the LDAP display name of the Active Directory Schema Class that represents the type of object you want to create. -Examples of Type values include computer, group, organizational unit, and user. - -The Path parameter specifies the container where the object will be created.. -When you do not specify the Path parameter, the cmdlet creates an object in the default naming context container for Active Directory objects in the domain. - -The following methods explain different ways to create an object by using this cmdlet. - -Method 1: Use the New-ADObject cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -Method 2: Use a template to create the new object. -To do this, create a new Active Directory object or retrieve a copy of an existing Active Directory object and set the Instance parameter to this object. -The object provided to the Instance parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the Instance parameter description for this cmdlet. -For information about Active Directory cmdlets use the Instance parameter, see about_ActiveDirectory_Instance. - -Method 3: Use the Import-CSV cmdlet with the New-ADObject cmdlet to create multiple Active Directory objects. -To do this, use the Import-CSV cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the New-ADObject cmdlet to create the Active Directory objects. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADObject -Name '192.168.1.0/26' -Type subnet -Description '192.168.1.0/255.255.255.192' -OtherAttributes @{location="Building A";siteObject="CN=HQ,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM"} -Path "CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Creates a subnet object in the HQ site with the described attributes. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$subnetTemplate = get-adobject -Identity "CN=192.168.1.0/26,CN=Subnets,CN=Sites,CN=Configuration,DC=Fabrikam,DC=com" -properties description,location; new-adobject -instance $subnetTemplate -name "192.168.1.0/28" -type subnet -path "CN=Subnets,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Creates a new subnet object, using a different subnet object as a template - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADObject -name SaraDavisContact -type contact -ProtectedFromAccidentalDeletion $true -OtherAttributes @{'msDS-SourceObjectDN'="CN=FabrikamContacts,DC=CONTOSO,DC=COM"} -``` - -Description - ------------ - -Creates a new contact object, sets the msDS-SourceObjectDN property and protects the object from accidental deletion - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>new-adobject -name Apps -type container -path "DC=AppNC" -server "FABRIKAM-SRV1:60000" -``` - -Description - ------------ - -Creates a new container object named 'Apps' in an LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an Active Directory object to use as a template for a new Active Directory object. - -You can use an instance of an existing Active Directory object as a template or you can construct a new Active Directory object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new Active Directory object. - -Method 1: Use an existing Active Directory object as a template for a new object. -To retrieve an instance of an existing Active Directory object, use a cmdlet such as Get-ADObject. -Then provide this object to the Instance parameter of the New-ADObject cmdlet to create a new Active Directory object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADObject -Identity saraDavisDesktop - -New-ADObject -Name "ellenAdamsDesktop" -Instance $ObjectInstance -Type "computer" - -Method 2: Create a new ADObject and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADObject cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADObject $objectInstance.Description = "Ellen Adams New Computer" New-ADObject -Name ellenAdamsDesktop -Instance $ObjectInstance -Type computer - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created. - -In many cases, a default value will be used for the Path parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If the target AD LDS instance has a default naming context, the default value of Path will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Path parameter will not take any default value. - -The following example shows how to set this parameter to an OU. - --Path "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, Rename-Item and Set-ItemProperty also contain a Path property. -However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of object to create. -Set the Type parameter to the LDAP display name of the Active Directory Schema Class that represents the type of object that you want to create. -Examples of type values include user, computer, and group. - -The following example shows how to use this parameter to create a new Active Directory group object. - --Type "group" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -An Active Directory object that is a template for the new object is received by the Instance parameter. - -Derived types such as the following are also accepted: - --Microsoft.ActiveDirectory.Management.ADPartition - --Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - --Microsoft.ActiveDirectory.Management.ADGroup - --Microsoft.ActiveDirectory.Management.ADUser - --Microsoft.ActiveDirectory.Management.ADComputer - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -Returns the new Active Directory object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[Move-ADObject](./Move-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - -[Rename-ADObject](./Rename-ADObject.md) - -[Restore-ADObject](./Restore-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADOrganizationalUnit.md b/docset/winserver2012-ps/activedirectory/New-ADOrganizationalUnit.md deleted file mode 100644 index 8933342624..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADOrganizationalUnit.md +++ /dev/null @@ -1,557 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adorganizationalunit?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADOrganizationalUnit - -## SYNOPSIS - -Creates a new Active Directory organizational unit. - -## SYNTAX - -``` -New-ADOrganizationalUnit [-WhatIf] [-Confirm] [-AuthType ] [-City ] [-Country ] - [-Credential ] [-Description ] [-DisplayName ] - [-Instance ] [-ManagedBy ] [-Name] [-OtherAttributes ] - [-PassThru] [-Path ] [-PostalCode ] [-ProtectedFromAccidentalDeletion ] - [-Server ] [-State ] [-StreetAddress ] [] -``` - -## DESCRIPTION - -The **New-ADOrganizationalUnit** cmdlet creates an Active Directory organizational unit (OU). -You can set commonly used OU property values by using the cmdlet parameters. -**Property** values that are not associated with cmdlet parameters can be set by using the *OtherAttributes* parameter. - -You must set the *Name* parameter to create a new OU. -If you do not specify the *Path* parameter, the cmdlet creates an OU under the default naming context (NC) head for the domain. - -The following methods describe how to create an object by using this cmdlet. - -Method 1: Use the **New-ADOrganizationalUnit** cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -Method 2: Use a template to create the new object. -To do this, create a new OU object or get a copy of an existing OU object and set the *Instance* parameter to this object. -The object provided to the *Instance* parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For more information, see the *Instance* parameter description for this cmdlet. - -Method 3: Use the **Import-Csv** cmdlet with the **New-ADOrganizationalUnit** cmdlet to create multiple Active Directory OU objects. -To do this, use the [**Import-Csv**](/powershell/module/microsoft.powershell.utility/import-csv) cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the **New-ADOrganizationalUnit** cmdlet to create the OU objects. - -## EXAMPLES - -### Example 1: Create an OU - -``` -PS C:\> New-ADOrganizationalUnit -Name "UserAccounts" -Path "DC=FABRIKAM,DC=COM" -``` - -This command creates an OU named UserAccounts that is protected from accidental deletion. Note that accidental protection is implicit. - -### Example 2: Create an OU that is not protected from accidental deletion - -``` -PS C:\> New-ADOrganizationalUnit -Name "UserAccounts" -Path "DC=FABRIKAM,DC=COM" -ProtectedFromAccidentalDeletion $False -``` - -This command creates an OU named UserAccounts that is not protected from accidental deletion. - -### Example 3: Create an OU that is protected from accidental deletion - -``` -PS C:\> New-ADOrganizationalUnit -Name "UserAccounts" -Path "DC=FABRIKAM,DC=COM" -OtherAttributes @{seeAlso="CN=HumanResourceManagers,OU=Groups,OU=Managed,DC=Fabrikam,DC=com";managedBy="CN=TomC,DC=FABRIKAM,DC=COM"} -``` - -This command creates an OU named UserAccounts that is protected from accidental deletion. -The **seeAlso** and **managedBy** properties are set to specified values. - -### Example 4: Create an OU from a template OU - -``` -PS C:\> $OuTemplate = Get-ADOrganizationalUnit -Identity "OU=UserAccounts,DC=Fabrikam,DC=com" -Properties seeAlso,managedBy -PS C:\> New-ADOrganizationalUnit -Name "TomCReports" -Instance $OuTemplate -``` - -This command uses the data from the OU OU=UserAccounts,DC=Fabrikam,DC=com as a template for another OU. - -### Example 5: Create an OU in an AD LDS instance - -``` -PS C:\> New-ADOrganizationalUnit -Name "Managed" -Path "DC=AppNC" -Server "FABRIKAM-SRV1:60000" -``` - -This command creates an OU named Managed in an AD LDS instance. - -## PARAMETERS - -### -AuthType - -Specifies the authentication method to use. - -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City - -Specifies the town or city. -This parameter sets the **City** property of an OU object. -The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName**) of this property is `l`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country - -Specifies the country or region code. -This parameter sets the **Country** property of an OU object. -The LDAP display name (**ldapDisplayName**) of this property is `c`. -This value is not used by Windows 2000. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential - -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the [Get-Credential](/powershell/module/microsoft.powershell.security/get-credential) cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description - -Specifies a description of the object. -This parameter sets the value of the **Description** property for the OU object. -The LDAP display name (**ldapDisplayName**) for this property is `description`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName - -Specifies the display name of the object. -This parameter sets the **DisplayName** property of the OU object. -The LDAP display name (**ldapDisplayName**) for this property is `displayName`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance - -Specifies an instance of an OU object to use as a template for a new OU object. - -You can use an instance of an existing OU object as a template or you can construct a new OU object by using the Windows PowerShell command line or by using a script. - -Method 1: Use an existing OU object as a template for a new object. -To retrieve an instance of an existing OU object use Get-ADOrganizationalUnit. -Then provide this object to the *Instance* parameter of the **New-ADOrganizationalUnit** cmdlet to create a new OU object. -You can override property values of the new object by setting the appropriate parameters. - -Method 2: Create a new **ADOrganizationalUnit** object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the *Instance* parameter of the **New-ADOrganizationalUnit** cmdlet to create the new Active Directory OU object. - -```powershell -$OrganizationalUnitInstance = New-Object -ComObject Microsoft.ActiveDirectory.Management.ADOrganizationalUnit -$OrganizationalUnitInstance.Country = Australia -New-ADOrganizationalUnit -Name accountingAustralia -Instance $OrganizationalUnitInstance -``` - -> [!NOTE] -> Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set raises an error. - -```yaml -Type: ADOrganizationalUnit -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy - -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -This parameter sets the Active Directory attribute with an LDAP display name of `managedBy`. - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name - -Specifies the name of the object. -This parameter sets the **Name** property of the OU object. -The LDAP display name (**ldapDisplayName**) of this property is `name`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes - -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAP display name (**ldapDisplayName**) defined for it in the Active Directory schema. - -To specify a single value for an attribute: - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value}` - -To specify multiple values for an attribute, separate the values with a comma: - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}` - -To specify values for multiple attributes, separate the attributes with a semi-colon: - -`-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru - -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path - -Specifies the X.500 path of the OU or container where the new object is created. - -In many cases, a default value is used for the *Path* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and when a default value can be determined, no further rules are evaluated. - -In Active Directory Domain Services (AD DS) environments, a default value for *Path* is set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the *Path* parameter defaults to the Users container. -- If none of the previous cases apply, the default value of *Path* is set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for *Path* is set in the following cases: - -- If the cmdlet is run from an Active Directory module for PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the *Path* parameter defaults to the Users container. -- If the target AD LDS instance has a default naming context, the default value of *Path* is set to the default naming context. - To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Path* parameter does not take any default value. - -> [!NOTE] -> The Active Directory Provider cmdlets, such as **New-Item**, **Remove-Item**, **Remove-ItemProperty**, **Rename-Item**, and **Set-ItemProperty**, also contain a **Path** property. -> -> However, for the Active Directory Provider cmdlets, the *Path* parameter identifies the path of the actual object rather than the container. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PostalCode - -Specifies the postal code or zip code. -This parameter sets the **PostalCode** property of an OU object. -The LDAP display name (**ldapDisplayName**) of this property is `postalCode`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion - -Indicates whether to prevent the object from being deleted. -When this property is set to $True, you cannot delete the corresponding object without changing the value of the property. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $true -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server - -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. - -Specify the AD DS instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State - -Specifies a state or province. -This parameter sets the **State** property of an OU object. -The LDAP display name (**ldapDisplayName**) of this property is `st`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StreetAddress - -Specifies a street address. -This parameter sets the **StreetAddress** property of an OU object. -The LDAP display name (**ldapDisplayName**) of this property is `street`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -An OU object that is a template for the new OU object is received by the **Instance** parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Returns the new OU object when the **PassThru** parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES - -- This cmdlet does not work with an Active Directory Snapshot. -- This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADOrganizationalUnit](./Get-ADOrganizationalUnit.md) - -[Remove-ADOrganizationalUnit](./Remove-ADOrganizationalUnit.md) - -[Set-ADOrganizationalUnit](./Set-ADOrganizationalUnit.md) diff --git a/docset/winserver2012-ps/activedirectory/New-ADReplicationSite.md b/docset/winserver2012-ps/activedirectory/New-ADReplicationSite.md deleted file mode 100644 index 59c8da0b61..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADReplicationSite.md +++ /dev/null @@ -1,602 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adreplicationsite?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADReplicationSite - -## SYNOPSIS -Creates a new Active Directory replication site in the directory. - -## SYNTAX - -``` -New-ADReplicationSite [-WhatIf] [-Confirm] [-AuthType ] - [-AutomaticInterSiteTopologyGenerationEnabled ] [-AutomaticTopologyGenerationEnabled ] - [-Credential ] [-Description ] [-Instance ] - [-InterSiteTopologyGenerator ] [-ManagedBy ] [-Name] - [-OtherAttributes ] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-RedundantServerTopologyEnabled ] [-ReplicationSchedule ] - [-ScheduleHashingEnabled ] [-Server ] [-TopologyCleanupEnabled ] - [-TopologyDetectStaleEnabled ] [-TopologyMinimumHopsEnabled ] - [-UniversalGroupCachingEnabled ] [-UniversalGroupCachingRefreshSite ] - [-WindowsServer2000BridgeheadSelectionMethodEnabled ] - [-WindowsServer2000KCCISTGSelectionBehaviorEnabled ] [-WindowsServer2003KCCBehaviorEnabled ] - [-WindowsServer2003KCCIgnoreScheduleEnabled ] - [-WindowsServer2003KCCSiteLinkBridgingEnabled ] [] -``` - -## DESCRIPTION -The **New-ADReplicationSite** cmdlet is used to create sites in Active Directory replication. -Sites are used in Active Directory to either enable clients to discover network resources (published shares, domain controllers) close to the physical location of a client computer, or to reduce network traffic over wide area network (WAN) links. -Sites can also be used to optimize replication between domain controllers. - -## EXAMPLES - -### Example 1: Create a replication site -```powershell -PS C:\> New-ADReplicationSite -Name "NorthAmerica" -``` - -This command creates a new site named NorthAmerica. - -### Example 2: Create a replication site and set a property for it -```powershell -PS C:\> New-ADReplicationSite -Name "Europe" -AutomaticInterSiteTopologyGenerationEnabled $FALSE -``` - -This command creates a new site named Europe, and sets the **AutomaticInterSiteTopologyGenerationEnabled** property on the new object. - -### Example 3: Create a replication site and set its replication schedule -```powershell -PS C:\> $Schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule -PS C:\> $Schedule.ResetSchedule() -PS C:\> $Schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty"); -PS C:\> New-ADReplicationSite -Name "Asia" -ReplicationSchedule $schedule -``` - -This example creates a new site named Asia, and sets the daily *ReplicationSchedule* from 20:00 to 22:30. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticInterSiteTopologyGenerationEnabled -Indicates whether the cmdlet prevents the Knowledge Consistency Checker (KCC) that functions as the intersite topology generator (ISTG) from generating connections for intersite replication. -Use this option when you want to create manual intersite connections (disable the ISTG) but retain the KCC to generate intrasite connections. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AutomaticTopologyGenerationEnabled -When enabled, prevents the KCC from generating intrasite connections on all servers in the site. -Disable this option if you use manual connections and do not want the KCC to build connections automatically. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as User01 or Domain01\User01, or enter a **PSCredential** object, such as one generated by the **Get-Credential** cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the **Description** property for the object. -The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName**) for this property is description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a site object to use as a template for a new site object. - -You can use an instance of an existing site object as a template or you can construct a new site object by using the Windows PowerShell command line or by using a script. - -Method 1: Use an existing site object as a template for a new object. -To retrieve an instance of an existing site object, use the **Get-ADReplicationSite** cmdlet. -Then provide this site object to the *Instance* parameter of the **New-ADReplicationSite** cmdlet to create a new site object. -You can override property values of the new object by setting the appropriate parameters. - -Method 2: Create a new **ADReplicationSite** and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the *Instance* parameter of the **New-ADReplicationSite** cmdlet to create the new site object. - -Note: -Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSite -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterSiteTopologyGenerator -Specifies the server acting as the inter-site topology generator for this site. - -```yaml -Type: ADDirectoryServer -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values: - -- Distinguished name -- GUID (objectGUID) -- Security identifier (objectSid) -- SAM account name (sAMAccountName) - -Note: -The identifier in parentheses is the LDAP display name for the property. - -This parameter sets the Active Directory attribute with an LDAP display name of managedBy. - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the replication site object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAP display name (**ldapDisplayName**) defined for it in the Active Directory schema. - -To specify a single value for an attribute: - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value}` - -To specify multiple values for an attribute: - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}` - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - -`-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to $True, you cannot delete the corresponding object without changing the value of the property. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RedundantServerTopologyEnabled -Indicates whether the cmdlet creates redundant connections between sites before a failure takes place. -When enabled, disables the Knowledge Consistency Checker (KCC) failover. -Requires that automatic detection of failed connections also be disabled (+IS_TOPL_DETECT_STALE_DISABLED). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplicationSchedule -Specifies the default replication schedule for connections within this site (intra-site replication). - -```yaml -Type: ActiveDirectorySchedule -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScheduleHashingEnabled -Indicates whether the cmdlet spreads replication start times randomly across the entire schedule interval rather than just the first quarter of the interval. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services (AD LDS), AD DS, or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TopologyCleanupEnabled -Indicates whether the cmdlet enables topology cleanup. -When enabled, prevents the KCC from removing connection objects that it does not need. -Disable this option if you want to take responsibility for removing old redundant connections. -Alternatively, to control or augment the topology, you can use manual connections, which the KCC does not delete. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopologyDetectStaleEnabled -Indicates whether the cmdlet enables topology detect stale. -Prevents the KCC from excluding servers that are unreachable from the topology; that is, the KCC does use an alternate server to reroute replication. -Use this option only if network communication is very unstable and brief outages are expected. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TopologyMinimumHopsEnabled -Indicates whether the cmdlet enables topology minimum hops. -When enabled, prevents the KCC from generating optimizing connections in the ring topology of intrasite replication. -Optimizing connections reduce the replication latency in the site and disabling them is not recommended. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UniversalGroupCachingEnabled -Indicates whether the cmdlet enables universal group caching. -If this parameter is true, it indicates this site caches universal groups, which are those groups cached on global catalog (GC) servers. -It can be useful in sites with no GC servers available locally. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UniversalGroupCachingRefreshSite -Specifies the name of a site from which the cache is pulled if universal group caching is enabled. - -```yaml -Type: ADReplicationSite -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsServer2000BridgeheadSelectionMethodEnabled -Implements the Windows 2000 Server method of selecting a single bridgehead server per directory partition and transport. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsServer2000KCCISTGSelectionBehaviorEnabled -Indicates whether the cmdlet implements the Windows 2000 Server method of ISTG selection. -Off by default. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsServer2003KCCBehaviorEnabled -Implements KCC operation that is consistent with Windows Server 2003 forest functional level. -This option can be set if all domain controllers in the site are running Windows Server 2003. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsServer2003KCCIgnoreScheduleEnabled -When the forest functional level Windows Server 2003 or Windows Server 2003 interim is in effect, provides KCC control of the ability to ignore schedules (replication occurs at the designated intervals and is always available). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsServer2003KCCSiteLinkBridgingEnabled -When the forest functional level Windows Server 2003 or Windows Server 2003 interim is in effect, provides KCC control of the ability to enable or disable site link bridging. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSite -A site object that is a template for the new site object is received by the *Instance* parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSite - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSite](./Get-ADReplicationSite.md) - -[Remove-ADReplicationSite](./Remove-ADReplicationSite.md) - -[Set-ADReplicationSite](./Set-ADReplicationSite.md) diff --git a/docset/winserver2012-ps/activedirectory/New-ADReplicationSiteLink.md b/docset/winserver2012-ps/activedirectory/New-ADReplicationSiteLink.md deleted file mode 100644 index 407da2ea6a..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADReplicationSiteLink.md +++ /dev/null @@ -1,467 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adreplicationsitelink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADReplicationSiteLink - -## SYNOPSIS -Creates a new Active Directory site link for in managing replication. - -## SYNTAX - -``` -New-ADReplicationSiteLink [-WhatIf] [-Confirm] [-AuthType ] [-Cost ] - [-Credential ] [-Description ] [-Instance ] - [-InterSiteTransportProtocol ] [-Name] - [-OtherAttributes ] [-PassThru] [-ReplicationFrequencyInMinutes ] - [-ReplicationSchedule ] [-Server ] [[-SitesIncluded] ] - [] -``` - -## DESCRIPTION -The New-ADReplicationSiteLink cmdlet can be used to create a new Active Directory site link. -A site link connects two or more sites. -Site links reflect the administrative policy for how sites are to be interconnected and the methods used to transfer replication traffic. -You must connect sites with site links so that domain controllers at each site can replicate Active Directory changes. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADReplicationSiteLink "NorthAmerica-Europe" -SitesIncluded NorthAmerica,Europe -``` - -Description - ------------ - -Create a new site link named 'NorthAmerica-Europe' linking the two sites 'NorthAmerica' and 'Europe'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADReplicationSiteLink "Europe-Asia" -SitesIncluded Europe,Asia -Cost 100 -ReplicationFrequencyInMinutes 15 -InterSiteTransportProtocol IP -``` - -Description - ------------ - -Create a new site link named 'Europe-Asia' linking two sites 'Europe' and 'Asia', and set the Cost, ReplicationFrequencyInMinutes and InterSiteTransportProtocol on the new object. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule; -$schedule.ResetSchedule(); -$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty"); -New-ADReplicationSiteLink "NorthAmerica-SouthAmerica" -SitesIncluded NorthAmerica,SouthAmerica -ReplicationSchedule $schedule -``` - -Description - ------------ - -Create a new site link named 'NorthAmerica-SouthAmerica' linking two sites 'NorthAmerica' and 'SouthAmerica', and set the daily ReplicationSchedule from 20:00 to 22:30. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>New-ADReplicationSiteLink "Europe-Asia" -SitesIncluded Europe,Asia -OtherAttributes @{'options'=1} -``` - -Description - ------------ - -Create a new site link named 'Europe-Asia' linking two sites 'Europe' and 'Asia', and enable change notification on the new object. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cost -Specifies the cost to be placed on the site link. -For more information on determining the cost, see the following topic called "Determining the Cost" in the TechNet Library: http://go.microsoft.com/fwlink/?LinkId=221871 - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a site link object to use as a template for a new site link object. - -You can use an instance of an existing site link object as a template or you can construct a new site link object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new site link object. - -Method 1: Use an existing site link object as a template for a new object. -To retrieve an instance of an existing site link object, use a cmdlet such as Get-ADReplicationSiteLink. -Then provide this object to the Instance parameter of the New-ADReplicationSiteLink cmdlet to create a new Active Directory object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSiteLink -Identity "NorthAmerica-SouthAmerica" - -New-ADReplicationSiteLink -Name "Europe-Asia" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSiteLink and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSiteLink cmdlet to create the new site link object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLink - -$objectInstance.Description = "Between North America and South America." - -New-ADReplicationSiteLink -Name "NorthAmerica-SouthAmerica" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSiteLink -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterSiteTransportProtocol -Specifies a valid intersite transport protocol option. -Supported protocol options for the New-ADReplicationSiteLink cmdlet include the following: IP, SMTP. - -```yaml -Type: ADInterSiteTransportProtocolType -Parameter Sets: (All) -Aliases: -Accepted values: IP, SMTP - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the site link. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "Europe-NorthAmerica" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationFrequencyInMinutes -Species the frequency (in minutes) for which replication will occur where this site link is in use between sites. -Active Directory preserves bandwidth between sites by minimizing the frequency of replication and by allowing you to schedule the availability of site links for replication. -By default, intersite replication across each site link occurs every 180 minutes (3 hours). -You can adjust this frequency to match your specific needs. -Be aware that increasing this frequency increases the amount of bandwidth used by replication. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReplicationSchedule -Specifies the default replication schedule for any connections within this site link (intra-site replication). -This allows you to schedule the availability of site links for use by replication. -By default, a site link is available to carry replication traffic 24 hours a day, 7 days a week. -You can limit this schedule to specific days of the week and times of day. -You can, for example, schedule intersite replication so that it only occurs after normal business hours. - -```yaml -Type: ActiveDirectorySchedule -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SitesIncluded -Specifies the list of sites included in the site link. - -```yaml -Type: ADReplicationSite[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink -A site link object that is a template for the new site link object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSiteLink](./Get-ADReplicationSiteLink.md) - -[Remove-ADReplicationSiteLink](./Remove-ADReplicationSiteLink.md) - -[Set-ADReplicationSiteLink](./Set-ADReplicationSiteLink.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADReplicationSiteLinkBridge.md b/docset/winserver2012-ps/activedirectory/New-ADReplicationSiteLinkBridge.md deleted file mode 100644 index 49eee164e3..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADReplicationSiteLinkBridge.md +++ /dev/null @@ -1,390 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adreplicationsitelinkbridge?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADReplicationSiteLinkBridge - -## SYNOPSIS -Creates a new site link bridge in Active Directory for replication. - -## SYNTAX - -``` -New-ADReplicationSiteLinkBridge [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Description ] [-Instance ] - [-InterSiteTransportProtocol ] [-Name] - [-OtherAttributes ] [-PassThru] [-Server ] [[-SiteLinksIncluded] ] - [] -``` - -## DESCRIPTION -The New-ADReplicationSiteLinkBridge cmdlet creates a new site link bridge in Active Directory for use in replication. -A site link bridge connects two or more site links and enables transitivity between site links. -Each site link in a bridge must have a site in common with another site link in the bridge. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded "NorthAmerica-Europe","Europe-Asia" -``` - -Description - ------------ - -Create a new site link bridge named 'NorthAmerica-Asia' bridging the two sites links 'NorthAmerica-Europe' and 'Europe-Asia'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded "NorthAmerica-Europe","Europe-Asia" -InterSiteTransportProtocol IP -``` - -Description - ------------ - -Create a new site link bridge named 'NorthAmerica-Asia' bridging the two sites links 'NorthAmerica-Europe' and 'Europe-Asia', and set the InterSiteTransportProtocol on the new object. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a site link bridge object to use as a template for a new site link bridge object. - -You can use an instance of an existing site link bridge object as a template or you can construct a new site link bridge object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new site link bridge object. - -Method 1: Use an existing site link bridge object as a template for a new object. -To retrieve an instance of an existing Active Directory object, use the Get-ADReplicationSiteLinkBridge cmdlet. -Then provide this object to the Instance parameter of the New-ADReplicationSiteLinkBridge cmdlet to create a new site link bridge object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSiteLinkBridge -Identity "NorthAmerica-Asia" - -New-ADReplicationSiteLinkBridge -Name "SouthAmerica-Asia" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSiteLinkBridge and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSiteLinkBridge cmdlet to create the new site link bridge object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge - -$objectInstance.Description = "Between North America and Asia." - -New-ADReplicationSiteLinkBridge -Name "NorthAmerica-Asia" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSiteLinkBridge -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterSiteTransportProtocol -Specifies the valid InterSite Transport Protocol for use with this site link bridge. -Acceptable options for this parameter include the following: - -- IP -- SMTP - -```yaml -Type: ADInterSiteTransportProtocolType -Parameter Sets: (All) -Aliases: -Accepted values: IP, SMTP - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the replication site link bridge object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteLinksIncluded -Contains an array of site links that are included in this site link bridge. -Accepted values for this parameter are the distinguished name (DN), a GUID, or the name of a site link. -This parameter must contain two sites upon creation or else the Instance parameter must be included and used. - -```yaml -Type: ADReplicationSiteLink[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge -A site link bridge object that is a template for the new site link bridge object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge - -## NOTES -* By default, all site links are bridged (transitive) and creating a site link design is not required. We recommend that you keep transitivity enabled by not changing this default. However, you will need to disable bridging for all site links and complete a site link bridge design if either of the following is true: - - - Your IP network is not fully routed. - - - You need to control the replication flow of the changes made in Active Directory Domain Services (AD DS). - -## RELATED LINKS - -[Get-ADReplicationSiteLinkBridge](./Get-ADReplicationSiteLinkBridge.md) - -[Remove-ADReplicationSiteLinkBridge](./Remove-ADReplicationSiteLinkBridge.md) - -[Set-ADReplicationSiteLinkBridge](./Set-ADReplicationSiteLinkBridge.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADReplicationSubnet.md b/docset/winserver2012-ps/activedirectory/New-ADReplicationSubnet.md deleted file mode 100644 index fe55de7c4d..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADReplicationSubnet.md +++ /dev/null @@ -1,377 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adreplicationsubnet?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADReplicationSubnet - -## SYNOPSIS -Creates a new Active Directory replication subnet object. - -## SYNTAX - -``` -New-ADReplicationSubnet [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Description ] [-Instance ] [-Location ] [-Name] - [-OtherAttributes ] [-PassThru] [-Server ] [[-Site] ] - [] -``` - -## DESCRIPTION -The New-ADReplicationSubnet cmdlet creates a new Active Directory subnet object. -Subnet objects (class subnet) define network subnets in Active Directory. -A network subnet is a segment of a TCP/IP network to which a set of logical IP addresses is assigned. -Subnets group computers in a way that identifies their physical proximity on the network. -Subnet objects in Active Directory are used to map computers to sites. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADReplicationSubnet -Name "10.0.0.0/25" -``` - -Description - ------------ - -Create a new subnet named '10.0.0.0/25'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADReplicationSubnet -Name "10.10.0.0/22" -Site Asia -Location "Tokyo,Japan" -``` - -Description - ------------ - -Create a new subnet named '10.10.0.0/22' with 'Asia' as its associated site, and set the Location property to "Tokyo,Japan". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a subnet object to use as a template for a new subnet object. - -You can use an instance of an existing subnet object as a template or you can construct a new subnet object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new subnet object. - -Method 1: Use an existing subnet object as a template for a new subnet object. -To retrieve an instance of an existing subnet object, use the Get-ADReplicationSubnet cmdlet. -Then provide this object to the Instance parameter of the New-ADReplicationSubnet cmdlet to create a new subnet object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSubnet -Identity "10.0.0.0/25" - -New-ADReplicationSubnet -Name "12.0.0.0/25" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSubnet and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSubnet cmdlet to create the new subnet object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSubnet - -$objectInstance.Description = "Branch office subnet." - -New-ADReplicationSubnet -Name "10.0.0.0/25" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSubnet -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -A description of the physical location of this subnet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the subnet. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -Subnet names in Active Directory take the form "network/bits masked" (for example, the subnet object 172.16.72.0/22 has a subnet of 172.16.72.0 and a 22-bit subnet mask). - -The following example shows how to set this parameter to a name string. - --Name "172.16.72.0/22" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -The site associated with this subnet. - -```yaml -Type: ADReplicationSite -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet -A subnet object that is a template for the new subnet object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSubnet](./Get-ADReplicationSubnet.md) - -[Remove-ADReplicationSubnet](./Remove-ADReplicationSubnet.md) - -[Set-ADReplicationSubnet](./Set-ADReplicationSubnet.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADResourceProperty.md b/docset/winserver2012-ps/activedirectory/New-ADResourceProperty.md deleted file mode 100644 index 20d115ad2c..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADResourceProperty.md +++ /dev/null @@ -1,561 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adresourceproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADResourceProperty - -## SYNOPSIS -Creates a new resource property in Active Directory. - -## SYNTAX - -``` -New-ADResourceProperty [-WhatIf] [-Confirm] [-AppliesToResourceTypes ] [-AuthType ] - [-Credential ] [-Description ] [-DisplayName] [-Enabled ] - [-ID ] [-Instance ] [-IsSecured ] [-OtherAttributes ] - [-PassThru] [-ProtectedFromAccidentalDeletion ] - -ResourcePropertyValueType [-Server ] [-SharesValuesWith ] - [-SuggestedValues ] [] -``` - -## DESCRIPTION -The New-ADResourceProperty cmdlet creates a new resource property in the directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADResourceProperty Authors -ResourcePropertyValueType MS-DS-MultivaluedText -``` - -Description - ------------ - -Create a new resource property with display name 'Authors'. -The resource property allows the names of multiple authors to be specified. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$us = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("US", "United States of America", "United States of America"); -$jp = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("JP", "Japan", "Japan"); -New-ADResourceProperty Country -ResourcePropertyValueType MS-DS-MultivaluedChoice -SuggestedValues $us,$jp -``` - -Description - ------------ - -Create a new resource property with display name 'Country'. -The suggested values are set to 'US' and 'JP'. -Applications using this resource property would allow their users to specify one of the suggested values as this resource property's value. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADResourceProperty Country -ResourcePropertyValueType MS-DS-MultivaluedChoice -SharesValuesWith Country -``` - -Description - ------------ - -Create a new reference resource property with display name 'Country'. -It uses an existing claim type named 'Country' for its suggested values. -This enables the resource property to be always valid for comparisons with the referenced claim type in a central access rule. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>New-ADResourceProperty Authors -ResourcePropertyValueType MS-DS-MultivaluedText -ID Authors_60DB20331638 -``` - -Description - ------------ - -Create a new resource property with display name 'Authors', and set its ID to 'Authors_60DB20331638'. - -The ID should only be set manually in a multi-forest environment where the same resource property needs to work across forests. -By default, New-ADResourceProperty generates the ID automatically. -For resource properties to be considered identical across forests, their ID must be the same. - -## PARAMETERS - -### -AppliesToResourceTypes -Specifies the resource types to which this resource property is applied. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the resource property. -The display name of the resource property must be unique. - -The display name of a resource property can be used as an identity in other Active Directory cmdlets. -For example, if the display name of a resource property is "Country", then you can use 'Get-ADResourceProperty -Identity "Country"' to retrieve the resource property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Specifies if the resource property is enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ID -Specifies the resource property ID. -This is an optional parameter. -By default, New-ADResourceProperty generates the ID automatically. - -The ID should only be set manually in a multi-forest environment where the same resource properties need to work across forests. -For resource properties to be considered identical across forests, their ID must be the same. - -To specify the ID, the ID string must conform to the following format: - -1. Start with a prefix string of 1 to 15 characters in length. - -2. The prefix string must be followed by an underscore. - -3. The prefix string and underscore must be followed by a suffix string of 1 to 16 characters in length. - -4. All characters contained in either prefix or suffix strings must contain only valid filename characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Auto-generated -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a resource property object to use as a template for a new resource property object. - -You can use an instance of an existing resource property object as a template or you can construct a new resource property object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new resource property object. - -Method 1: Use an existing resource property object as a template for a new object. -To retrieve an instance of an existing resource property object, use a cmdlet such as Get-ADResourceProperty. -Then provide this object to the Instance parameter of the New-ADResourceProperty cmdlet to create a new resource property object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADResourceProperty -Identity "Country" - -New-ADResourceProperty -Name "Region" -Instance $ObjectInstance - -Method 2: Create a new ADResourceProperty and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADResourceProperty cmdlet to create the new resource property object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourceProperty - -$objectInstance.Description = "Non-Disclosure Agreement (NDA)" - -New-ADResourceProperty -Name "NDA" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADResourceProperty -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsSecured -Used to configure whether the resource property is secure or not. -Only secure resource properties can be used for authorization decisions or used within central access rules. -Unsecured resource properties cannot be used for these purposes. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePropertyValueType -The parameter specifies the value type for this resource property. -When a resource property is passed to a resource manager (e.g., File Server), the resource manager leverages the resource property value type to determine how the resource property should be handled. - -The full list of resource property value types can be retrieved by calling the Get-ADResourcePropertyValueType cmdlet. - -Example: Get-ADResourcePropertyValueType -Filter * | ft Name - -Below is a list of the built-in resource property value types available in Active Directory: - -- MS-DS-SinglevaluedChoice -- MS-DS-YesNo -- MS-DS-Number -- MS-DS-DateTime -- MS-DS-OrderedList -- MS-DS-Text -- MS-DS-MultivaluedText -- MS-DS-MultivaluedChoice - -```yaml -Type: ADResourcePropertyValueType -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharesValuesWith -Use this parameter to create a reference resource property. -Reference resource properties do not provide their own suggested values, but rather use the suggested values from the claim type object specified in this parameter. -This enables the resource property to always remain valid for use in comparisons to its referred claim type within a central access rule. - -```yaml -Type: ADClaimType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuggestedValues -Specifies one or more suggested values for the resource property. -An application may choose to present this list of suggested values for the user to choose from. -When RestrictValues is set to true, the application should restrict the user to pick values from this list only. - -Example: - -$us = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("US", "United States of America", "United States of America"); - -$jp = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("JP", "Japan", "Japan"); - -New-ADResourceProperty Country -ResourcePropertyValueType MS-DS-MultivaluedChoice -SuggestedValues $us,$jp - -```yaml -Type: ADSuggestedValueEntry[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourceProperty - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourceProperty - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADResourceProperty](./Get-ADResourceProperty.md) - diff --git a/docset/winserver2012-ps/activedirectory/New-ADResourcePropertyList.md b/docset/winserver2012-ps/activedirectory/New-ADResourcePropertyList.md deleted file mode 100644 index fba7a3785f..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADResourcePropertyList.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adresourcepropertylist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADResourcePropertyList - -## SYNOPSIS -Creates a new resource property list in Active Directory. - -## SYNTAX - -``` -New-ADResourcePropertyList [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Description ] [-Instance ] [-Name] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Server ] [] -``` - -## DESCRIPTION -The New-ADResourcePropertyList cmdlet creates a resource property list in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADResourcePropertyList "Corporate Resource Property List" -``` - -Description - ------------ - -Creates a new resource property list named "Corporate Resource Property List". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADResourcePropertyList "Corporate Resource Property List" -Description "For corporate documents." -``` - -Description - ------------ - -Creates a new resource property list named "Corporate Resource Property List" with the description "For corporate documents." - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList "Corporate Resource Property List" | New-ADResourcePropertyList "Finance Resource Property List" -``` - -Description - ------------ - -Create a new resource property list using the property values from a 'Corporate Resource Property List'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an resource property list object to use as a template for a new resource property list object. - -You can use an instance of an existing resource property list object as a template or you can construct a new resource property list object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new resource property list object. - -Method 1: Use an existing resource property list object as a template for a new object. -To retrieve an instance of an existing resource property list object, use a cmdlet such as Get-ADResourcePropertyList. -Then provide this object to the Instance parameter of the New-ADResourcePropertyList cmdlet to create a new resource property list object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADResourcePropertyList -Identity "Global Resource Property List" - -New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance - -Method 2: Create a new ADResourcePropertyList and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADResourcePropertyList cmdlet to create the new resource property list object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -$objectInstance.Description = "For finance use only." - -New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADResourcePropertyList -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/New-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/New-ADServiceAccount.md deleted file mode 100644 index c1b4100133..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADServiceAccount.md +++ /dev/null @@ -1,805 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADServiceAccount - -## SYNOPSIS -Creates a new Active Directory managed service account or group managed service account object. - -## SYNTAX - -### Group (Default) -``` -New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AuthType ] [-Certificates ] [-CompoundIdentitySupported ] - [-Credential ] [-Description ] [-DisplayName ] -DNSHostName - [-Enabled ] [-HomePage ] [-Instance ] - [-KerberosEncryptionType ] [-ManagedPasswordIntervalInDays ] [-Name] - [-OtherAttributes ] [-PassThru] [-Path ] - [-PrincipalsAllowedToDelegateToAccount ] - [-PrincipalsAllowedToRetrieveManagedPassword ] [-SamAccountName ] [-Server ] - [-ServicePrincipalNames ] [-TrustedForDelegation ] [] -``` - -### RestrictedToSingleComputer -``` -New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AccountPassword ] [-AuthType ] [-Certificates ] - [-Credential ] [-Description ] [-DisplayName ] [-Enabled ] - [-HomePage ] [-Instance ] [-KerberosEncryptionType ] - [-Name] [-OtherAttributes ] [-PassThru] [-Path ] [-RestrictToSingleComputer] - [-SamAccountName ] [-Server ] [-ServicePrincipalNames ] - [-TrustedForDelegation ] [] -``` - -### RestrictedToOutboundAuthenticationOnly -``` -New-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AuthType ] [-Certificates ] [-Credential ] [-Description ] - [-DisplayName ] [-Enabled ] [-HomePage ] [-Instance ] - [-KerberosEncryptionType ] [-Name] [-OtherAttributes ] - [-PassThru] [-Path ] [-RestrictToOutboundAuthenticationOnly] [-SamAccountName ] - [-Server ] [-ServicePrincipalNames ] [-TrustedForDelegation ] [] -``` - -## DESCRIPTION -The **New-ADServiceAccount** cmdlet creates a new Active Directory managed service account. -By default, the cmdlet creates a group managed service account. -To create a standalone managed service account which is linked to a specific computer, use the **RestrictToSingleComputer** parameter. -To create a group managed service account which can only be used in client roles, use the **RestrictToOutboundAuthenticationOnly** parameter. -This creates a group managed service account that can be used for outbound connections only and any attempts to connect to services using this account will fail because the account does not have enough information for authentication. -You can set commonly used managed service account property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be set by using the **OtherAttributes** parameter. - -The **Path** parameter specifies the container or organizational unit (OU) for the new managed service account object. -When you do not specify the **Path** parameter, the cmdlet creates an object in the default managed service accounts container for managed service account objects in the domain. - -The following methods explain different ways to create an object by using this cmdlet. - -- Method 1: Use the **New-ADServiceAccount** cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -- Method 2: Use a template to create the new object. -To do this, create a new managed service account object or retrieve a copy of an existing managed service account object and set the **Instance** parameter to this object. -The object provided to the **Instance** parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the **Instance** parameter description for this cmdlet. - -- Method 3: Use the **Import-Csv** cmdlet with the **New-ADServiceAccount** cmdlet to create multiple Active Directory managed service account objects. -To do this, use the **Import-CSV** cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -For more information, type `Get-Help Import-CSV`. -Then pass these objects through the pipeline to the **New-ADServiceAccount** cmdlet to create the managed service account objects. - -## EXAMPLES - -### Example 1: Create an enabled managed service account -```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -DNSHostName "Service01.contoso.com" -Enabled $True -``` - -This command creates an enabled managed service account in Active Directory Domain Services (AD DS). - -### Example 2: Create a managed service account and register its service principal name -```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -ServicePrincipalNames "MSSQLSVC/Machine3.corp.contoso.com" -DNSHostName "Service01.contoso.com" -``` - -This command creates a managed service account and registers its service principal name. - -### Example 3: Create a managed service account for a single computer -```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -RestrictToSingleComputer -``` - -This command creates a managed service account and restricts its use to a single computer. - -### Example 4: Create a managed service account for outbound authentication only -```powershell -PS C:\> New-ADServiceAccount -Name "Service01" -RestrictToOutboundAuthenticationOnly -``` - -This command creates a managed service account and restricts its use to outbound authentication. - -### Example 5: Create a new managed service account and register multiple service principal names -```Powershell -PS C:\> New-ADServiceAccount service1 -ServicePrincipalNames "HTTP/Machine3.corp.contoso.com,HTTP/Machine3.corp.contoso.com/contoso" -DNSHostName service1.contoso.com -``` - -## PARAMETERS - -### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the **AccountExpirationDate** property of an account object. -The LDAP display name (**ldapDisplayName**) for this property is accountExpires. - -Use the **DateTime** syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountNotDelegated -Indicates whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the **AccountNotDelegated** property for an Active Directory account. -This parameter also sets the **ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account Control (UAC) attribute. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountPassword -Specifies a new password value for the service account. -This value is stored as an encrypted string. - -The following conditions apply based on the manner in which the password parameter is used: - -- $Null password is specified. -Random password is set and the account is enabled unless it is requested to be disabled. -- No password is specified. -Random password is set and the account is enabled unless it is requested to be disabled. -- User password is specified. -Password is set and the account is enabled unless it is requested to be disabled, unless the password you provided does not meet password policy or was not set for other reasons, at which point the account is disabled. - -The new **ADServiceAccount** object will always either be disabled or have a user-requested or randomly-generated password. -There is no way to create an enabled service account object with a password that violates domain password policy, such as an empty password. - -```yaml -Type: SecureString -Parameter Sets: RestrictedToSingleComputer -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificates -Specifies an array of certificates. -The cmdlet modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the **Certificates** property of the account object. -The LDAP Display Name (**ldapDisplayName**) for this property is userCertificate. - -To add values: - -`-Certificates @{Add=value1,value2,...}` - -To remove values: - -`-Certificates @{Remove=value3,value4,...}` - -To replace values: - -`-Certificates @{Replace=value1,value2,...}` - -To clear all values: - -`-Certificates $Null` - -You can specify more than one operation by using a list separated by semicolons. -For example, use the following syntax to add and remove Certificate values: - -`-Certificates @{Add=value1,value2,...};@{Remove=value3,value4,...}` - -The operators are applied in the following sequence: - -- Remove -- Add -- Replace - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompoundIdentitySupported -Indicates whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: Boolean -Parameter Sets: Group -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the service account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type an administrative account name, such as Admin1 or Contoso\Admin1 or you can specify a **PSCredential** object. -If you specify a service account name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DNSHostName -Specifies the Domain Name System (DNS) host name. - -```yaml -Type: String -Parameter Sets: Group -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the **Description** property for the object. -The LDAP Display Name (**ldapDisplayName**) for this property is description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the **DisplayName** property of the object. -The LDAP Display Name (**ldapDisplayName**) for this property is displayName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether an account is enabled. -An enabled account requires a password. -This parameter sets the **Enabled** property for an account object. -This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory UAC attribute. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the **homePage** property of an Active Directory object. -The LDAP Display Name (**ldapDisplayName**) for this property is wWWHomePage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a service account object to use as a template for a new service account object. - -You can use an instance of an existing service account object as a template or you can construct a new service account object for template use. -You can construct a new service account using the Windows PowerShell command line or by using a script. - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set raises an error. - -```yaml -Type: ADServiceAccount -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosEncryptionType -Indicates whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: - -- None -- DES -- RC4 -- AES128 -- AES256 - -None will remove all encryption types from the account may result in the KDC being unable to issue service tickets for services using the account. - -DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. - -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: ADKerberosEncryptionType -Parameter Sets: (All) -Aliases: -Accepted values: None, DES, RC4, AES128, AES256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedPasswordIntervalInDays -Specifies the number of days for the password change interval. -If set to 0 then the default is used. -This can only be set on object creation. -After that the setting is read only. -This value returns the **msDS-ManagedPasswordInterval** of the group managed service account object. - -```yaml -Type: Int32 -Parameter Sets: Group -Aliases: - -Required: False -Position: Named -Default value: 30 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the **Name** property of the Active Directory object. -The LDAP Display Name (**ldapDisplayName**) of this property is name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAP Display Name (**ldapDisplayName**) defined for it in the Active Directory schema. - -To specify a single value for an attribute: - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value}` - -To specify multiple values for an attribute - -`-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}` - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - -`-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the X.500 path of the organizational unit (OU) or container where the new object is created. - -In many cases, a default value will be used for the **Path** parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules are evaluated. - -In AD DS environments, a default value for **Path** is set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the **Path** parameter defaults to the Users container. -- If none of the previous cases apply, the default value of **Path** is set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for **Path** is set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this is used. -For example: in **New-ADUser**, the **Path** parameter defaults to the Users container. -- If the target AD LDS instance has a default naming context, the default value of **Path** is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the **Path** parameter does not take any default value. - -Note: The Active Directory Provider cmdlets, such as **New-Item**, **Remove-Item**, **Remove-ItemProperty**, **Rename-Item**, and **Set-ItemProperty**, also contain a **Path** property. -However, for the provider cmdlets, the **Path** parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToDelegateToAccount -Specifies the accounts that can act on the behalf of users to services running as this managed service account or group-managed service account. -This parameter sets the **msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of the object. - -```yaml -Type: ADPrincipal[] -Parameter Sets: Group -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToRetrieveManagedPassword -Specifies the membership policy for systems that can use a group-managed service account. -For a service to run under a group managed service account, the system must be in the membership policy of the account. -This parameter sets the **msDS-GroupMSAMembership** attribute of a group-managed service account object. -This parameter should be set to the principals allowed to use this group-managed service account. - -```yaml -Type: ADPrincipal[] -Parameter Sets: Group -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RestrictToOutboundAuthenticationOnly -Indicates that the cmdlet creates a group-managed service account that on success can be used by a service for successful outbound authentication requests only. -This allows creating a group managed service account without the parameters required for successful inbound authentication. - -```yaml -Type: SwitchParameter -Parameter Sets: RestrictedToOutboundAuthenticationOnly -Aliases: -Accepted values: true - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictToSingleComputer -Indicates that the cmdlet creates a managed service account that can be used only for a single computer. -Managed service accounts that are linked to a single computer account were introduced in Windows Server 2008 R2. - -```yaml -Type: SwitchParameter -Parameter Sets: RestrictedToSingleComputer -Aliases: -Accepted values: true - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 15 characters or less. -This parameter sets the **SAMAccountName** for an account object. -The LDAP display name (**ldapDisplayName**) for this property is sAMAccountName. - -Note: If the specified **SAMAccountName** string does not end with a $ (dollar sign), one is appended if necessary. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services (AD LDS), AD DS, or Active Directory snapshot instance. - -Domain name values: - -- Fully qualified domain name (FQDN) -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for the *Server* parameter is determined by one of the following methods in the order that they are listed: - -- By using *Server* value from objects passed through the pipeline. -- By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. -- By using the domain of the computer running PowerShell. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalNames -Specifies the service principal names for the account. -This parameter sets the **ServicePrincipalNames** property of the account. -The LDAP display name (**ldapDisplayName**) for this property is servicePrincipalName. -This parameter uses the following syntax to add remove, replace or clear service principal name values. - -To add values: - -`-ServicePrincipalNames @{Add=value1,value2,...}` - -To remove values: - -`-ServicePrincipalNames @{Remove=value3,value4,...}` - -To replace values: - -`-ServicePrincipalNames @{Replace=value1,value2,...}` - -To clear all values: - -`-ServicePrincipalNames $Null` - -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove service principal names. - -`@{Add=value1,value2,...};@{Remove=value3,value4,...}` - -The operators are applied in the following sequence: - -- Remove -- Add -- Replace - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Indicates whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the **TrustedForDelegation** property of an account object. -This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216)s - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object that is a template for the new managed service account object is received by the **Instance** parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -Returns the new managed service account object when the **PassThru** parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. -* This cmdlet requires that you create a Microsoft Group Key Distribution Service (GKDS) root key first to begin using group managed service accounts in your Active Directory deployment. For more information on how to create the GKDS root key using Windows PowerShell, see [Create the Key Distribution Services KDS Root Key](https://go.microsoft.com/fwlink/?LinkId=253584). - -## RELATED LINKS - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Install-ADServiceAccount](./Install-ADServiceAccount.md) - -[Remove-ADServiceAccount](./Remove-ADServiceAccount.md) - -[Set-ADServiceAccount](./Set-ADServiceAccount.md) - -[Uninstall-ADServiceAccount](./Uninstall-ADServiceAccount.md) diff --git a/docset/winserver2012-ps/activedirectory/New-ADUser.md b/docset/winserver2012-ps/activedirectory/New-ADUser.md deleted file mode 100644 index ec7bdc4511..0000000000 --- a/docset/winserver2012-ps/activedirectory/New-ADUser.md +++ /dev/null @@ -1,1636 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/new-aduser?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADUser - -## SYNOPSIS -Creates a new Active Directory user. - -## SYNTAX - -``` -New-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-AccountPassword ] [-AllowReversiblePasswordEncryption ] [-AuthType ] - [-CannotChangePassword ] [-Certificates ] [-ChangePasswordAtLogon ] - [-City ] [-Company ] [-CompoundIdentitySupported ] [-Country ] - [-Credential ] [-Department ] [-Description ] [-DisplayName ] - [-Division ] [-EmailAddress ] [-EmployeeID ] [-EmployeeNumber ] - [-Enabled ] [-Fax ] [-GivenName ] [-HomeDirectory ] [-HomeDrive ] - [-HomePage ] [-HomePhone ] [-Initials ] [-Instance ] - [-KerberosEncryptionType ] [-LogonWorkstations ] [-Manager ] - [-MobilePhone ] [-Name] [-Office ] [-OfficePhone ] [-Organization ] - [-OtherAttributes ] [-OtherName ] [-PassThru] [-PasswordNeverExpires ] - [-PasswordNotRequired ] [-Path ] [-POBox ] [-PostalCode ] - [-PrincipalsAllowedToDelegateToAccount ] [-ProfilePath ] [-SamAccountName ] - [-ScriptPath ] [-Server ] [-ServicePrincipalNames ] - [-SmartcardLogonRequired ] [-State ] [-StreetAddress ] [-Surname ] - [-Title ] [-TrustedForDelegation ] [-Type ] [-UserPrincipalName ] - [] -``` - -## DESCRIPTION -The New-ADUser cmdlet creates a new Active Directory user. -You can set commonly used user property values by using the cmdlet parameters. - -Property values that are not associated with cmdlet parameters can be set by using the OtherAttributes parameter. -When using this parameter be sure to place single quotes around the attribute name as in the following example. - -New-ADUser -SamAccountName "glenjohn" -GivenName "Glen" -Surname "John" -DisplayName "Glen John" -Path 'CN=Users,DC=fabrikam,DC=local' -OtherAttributes @{'msDS-PhoneticDisplayName'="GlenJohn"} - -You must specify the SAMAccountName parameter to create a user. - -You can use the New-ADUser cmdlet to create different types of user accounts such as iNetOrgPerson accounts. -To do this in AD DS, set the Type parameter to the LDAP display name for the type of account you want to create. -This type can be any class in the Active Directory schema that is a subclass of user and that has an object category of person. - -The Path parameter specifies the container or organizational unit (OU) for the new user. -When you do not specify the Path parameter, the cmdlet creates a user object in the default container for user objects in the domain. - -The following methods explain different ways to create an object by using this cmdlet. - -Method 1: Use the New-ADUser cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters. - -Method 2: Use a template to create the new object. -To do this, create a new user object or retrieve a copy of an existing user object and set the Instance parameter to this object. -The object provided to the Instance parameter is used as a template for the new object. -You can override property values from the template by setting cmdlet parameters. -For examples and more information, see the Instance parameter description for this cmdlet. - -Method 3: Use the Import-CSV cmdlet with the New-ADUser cmdlet to create multiple Active Directory user objects. -To do this, use the Import-CSV cmdlet to create the custom objects from a comma-separated value (CSV) file that contains a list of object properties. -Then pass these objects through the pipeline to the New-ADUser cmdlet to create the user objects. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADUser GlenJohn -Certificate (new-object System.Security.Cryptography.X509Certificates.X509Certificate -ArgumentList "export.cer") -``` - -Description - ------------ - -Create a new user named 'GlenJohn' with a certificate imported from the file "export.cer". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADUser GlenJohn -OtherAttributes @{title="director";mail="glenjohn@fabrikam.com"} -``` - -Description - ------------ - -Create a new user named 'GlenJohn' and set the title and mail properties on the new object. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADUser GlenJohn -Type iNetOrgPerson -Path "DC=AppNC" -server lds.Fabrikam.com:50000 -``` - -Description - ------------ - -Create a new inetOrgPerson named 'GlenJohn' on an AD LDS instance. - -## PARAMETERS - -### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the AccountExpirationDate property of an account object. -The LDAP Display name (ldapDisplayName) for this property is accountExpires. - -Use the DateTime syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. -The following examples show commonly-used syntax to specify a DateTime object. - -"4/17/2006" - -"Monday, April 17, 2006" - -"2:22:45 PM" - -"Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -"4/17/2006 2:22 PM" - -"Monday, April 17, 2006 2:22 PM" - -"2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - -"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - -"2006-04-17T14:22:48.0000000" - -The following example shows how to set this parameter to the date May 1, 2012 at 5 PM. - --AccountExpirationDate "05/01/2012 5:00:00 PM" - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountNotDelegated -Specifies whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the AccountNotDelegated property for an Active Directory account. -This parameter also sets the ADS_UF_NOT_DELEGATED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the security context of the account is not delegated to a service. - --AccountNotDelegated $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AccountPassword -Specifies a new password value for an account. -This value is stored as an encrypted string. - -The following conditions apply based on the manner in which the password parameter is used: - -$null password is specified - No password is set and the account is disabled unless it is requested to be enabled - -No password is specified - No password is set and the account is disabled unless it is requested to be enabled - -User password is specified - Password is set and the account is disabled unless it is requested to be enabled - -Notes: - -User accounts, by default, are created without a password. -If you provide a password, an attempt will be made to set that password however, this can fail due to password policy restrictions. -The user account will still be created and you may use Set-ADAccountPassword to set the password on that account. -In order to ensure that accounts remain secure, user accounts will never be enabled unless a valid password is set or PasswordNotRequired is set to true. - -The account is created if the password fails for any reason. - -The following example shows one method to set this parameter. -This command will prompt you to enter the password. - --AccountPassword (Read-Host -AsSecureString "AccountPassword") - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowReversiblePasswordEncryption -Specifies whether reversible password encryption is allowed for the account. -This parameter sets the AllowReversiblePasswordEncryption property of the account. -This parameter also sets the ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --AllowReversiblePasswordEncryption $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CannotChangePassword -Specifies whether the account password can be changed. -This parameter sets the CannotChangePassword property of an account. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the account password can be changed. - --CannotChangePassword $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Certificates -Specifies the DER-encoded X.509v3 certificates of the account. These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. This parameter sets the Certificates property of the account object. The LDAP display name (ldapDisplayName) for this property is userCertificate. - -```yaml -Type: X509Certificate[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ChangePasswordAtLogon -Specifies whether a password must be changed during the next logon attempt. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -This parameter cannot be set to $true or 1 for an account that also has the PasswordNeverExpires property set to true. - -The following example shows how to set this parameter so that the password must be changed at logon. - --ChangePasswordAtLogon $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -City -Specifies the user's town or city. -This parameter sets the City property of a user. -The LDAP display name (ldapDisplayName) of this property is "l". - -The following example shows how set this parameter. - --City "Las Vegas" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Company -Specifies the user's company. -This parameter sets the Company property of a user object. -The LDAP display name (ldapDisplayName) of this property is "company". - -The following example shows how to set this parameter. - --Company "Contoso" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompoundIdentitySupported -Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account supports service tickets with device authorization data. - --SupportDeviceAuthz $true - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -Specifies the country or region code for the user's language of choice. -This parameter sets the Country property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "c". -This value is not used by Windows 2000. - -The following example shows how set this parameter. - --Country "IN" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Department -Specifies the user's department. -This parameter sets the Department property of a user. -The LDAP Display Name (ldapDisplayName) of this property is "department". - -The following example shows how to set this parameter. - --Department "Development" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Division -Specifies the user's division. -This parameter sets the Division property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "division". - -The following example shows how to set this parameter. - --Division "Software" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the user's e-mail address. -This parameter sets the EmailAddress property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "mail". - -The following example shows how to set this parameter. - --EmailAddress "saradavis@contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmployeeID -Specifies the user's employee ID. -This parameter sets the EmployeeID property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "employeeID". - -The following example shows how to set this parameter. - --EmployeeID "A123456" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EmployeeNumber -Specifies the user's employee number. -This parameter sets the EmployeeNumber property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "employeeNumber". - -The following example shows how set this parameter. - --EmployeeNumber "12345678" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Specifies if an account is enabled. -An enabled account requires a password. -This parameter sets the Enabled property for an account object. -This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to enable the account. - --Enabled $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Fax -Specifies the user's fax phone number. -This parameter sets the Fax property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "facsimileTelephoneNumber". - -The following example shows how to set this parameter. - --Fax "+1 (999) 555 1212" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GivenName -Specifies the user's given name. -This parameter sets the GivenName property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "givenName". - -The following example shows how to set this parameter. - --givenName "Sanjay" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomeDirectory -Specifies a user's home directory. -This parameter sets the HomeDirectory property of a user object. -The LDAP Display Name (ldapDisplayName) for this property is "homeDirectory". - -The following example shows how to set this parameter. - --HomeDirectory "\\\\users\saraDavisHomeDir" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomeDrive -Specifies a drive that is associated with the UNC path defined by the HomeDirectory property. -The drive letter is specified as "\:" where \ indicates the letter of the drive to associate. -The \ must be a single, uppercase letter and the colon is required. -This parameter sets the HomeDrive property of the user object. -The LDAP Display Name (ldapDisplayName) for this property is "homeDrive". - -The following example shows how to set this parameter. - --HomeDrive "D:" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the homePage property of an Active Directory object. -The LDAP Display Name (ldapDisplayName) for this property is "wWWHomePage". - -The following example shows how to set this parameter to a URL. - --HomePage "http://employees.contoso.com/sdavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HomePhone -Specifies the user's home telephone number. -This parameter sets the HomePhone property of a user. -The LDAP Display Name (ldapDisplayName) of this property is "homePhone". - -The following example shows how to set this parameter. - --HomePhone "+1 (999) 555 1212" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Initials -Specifies the initials that represent part of a user's name. -You can use this value for the user's middle initial. -This parameter sets the Initials property of a user. -The LDAP Display Name (ldapDisplayName) of this property is "initials". - -The following example shows how set this parameter. - --Initials "L" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a user object to use as a template for a new user object. - -You can use an instance of an existing user object as a template or you can construct a new user object for template use. -You can construct a new user object using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create user object templates. - -Method 1: Use an existing user object as a template for a new object. -To retrieve an instance of an existing user object, use a cmdlet such as Get-ADUser. -Then provide this object to the Instance parameter of the New-ADUser cmdlet to create a new user object. -You can override property values of the new object by setting the appropriate parameters. - -$userInstance = Get-ADUser -Identity "saraDavis" - -New-ADUser -SAMAccountName "ellenAdams" -Instance $userInstance -DisplayName "EllenAdams" - -Method 2: Create a new ADUser object and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADUser cmdlet to create the new Active Directory user object. - -$userInstance = new-object Microsoft.ActiveDirectory.Management.ADUser - -$userInstance.DisplayName = "Ellen Adams" - -New-ADUser -SAMAccountName "ellenAdams" -Instance $userInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADUser -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -None - -DES - -RC4 - -AES128 - -AES256 - -None, will remove all encryption types from the account resulting the KDC being unable to issue service tickets for services using the account. - -DES is a weak encryption type which is not supported by default since Windows 7 and Windows Server 2008 R2. - -The following example shows how to specify that an account supports service tickets with device authorization data. - --KerberosEncryptionTypes RC4|AES128|AES256 - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: ADKerberosEncryptionType -Parameter Sets: (All) -Aliases: -Accepted values: None, DES, RC4, AES128, AES256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogonWorkstations -Specifies the computers that the user can access. -To specify more than one computer, create a single comma-separated list. -You can identify a computer by using the Security Accounts Manager (SAM) account name (sAMAccountName) or the DNS host name of the computer. -The SAM account name is the same as the NetBIOS name of the computer. - -The LDAP display name (ldapDisplayName) for this property is "userWorkStations". - -The following example shows how to set this parameter by using SAMAccountName (NetBIOS name) and DNSHostName values. - --LogonWorkstations "saraDavisDesktop,saraDavisLapTop,projectA.corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Manager -Specifies the user's manager. -This parameter sets the Manager property of a user. -This parameter is set by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The LDAP Display Name (ldapDisplayName) of this property is "manager". - -The following example shows how to set this parameter. - --Manager saradavis - -```yaml -Type: ADUser -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MobilePhone -Specifies the user's mobile phone number. -This parameter sets the MobilePhone property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "mobile". - -The following example shows how to set this parameter. - --MobilePhone "+1 (999 ) 555 1212" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --Name "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Office -Specifies the location of the user's office or place of business. -This parameter sets the Office property of a user object. -The LDAP display name (ldapDisplayName) of this property is "physicalDeliveryOfficeName". - -The following example shows how to set this parameter. - --Office "D1042" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OfficePhone -Specifies the user's office telephone number. -This parameter sets the OfficePhone property of a user object. -The LDAP display name (ldapDisplayName) of this property is "telephoneNumber". - -The following example shows how to set this parameter. - --OfficePhone "+1 (999) 555 1212" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Organization -Specifies the user's organization. -This parameter sets the Organization property of a user object. -The LDAP display name (ldapDisplayName) of this property is "o". - -The following example shows how to set this parameter. - --Organization "Accounting" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OtherAttributes -Specifies object attribute values for attributes that are not represented by cmdlet parameters. -You can set one or more parameters at the same time with this parameter. -If an attribute takes more than one value, you can assign multiple values. -To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined for it in the Active Directory schema. - -Syntax: - -To specify a single value for an attribute: - --OtherAttributes @{'AttributeLDAPDisplayName'=value} - -To specify multiple values for an attribute - --OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...} - -You can specify values for more than one attribute by using semicolons to separate attributes. -The following syntax shows how to set values for multiple attributes: - --OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...} - -The following examples show how to use this parameter. - -To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"} - -To set values for favColors and dateOfBirth simultaneously, use the following syntax: - --OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OtherName -Specifies a name in addition to a user's given name and surname, such as the user's middle name. -This parameter sets the OtherName property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "middleName". - -The following example shows how to set this parameter. - --OtherName "Peter" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -POBox -Specifies the user's post office box number. -This parameter sets the POBox property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "postOfficeBox". - -The following example shows how to set this parameter. - --POBox "25662" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNeverExpires -Specifies whether the password of an account can expire. -This parameter sets the PasswordNeverExpires property of an account object. -This parameter also sets the ADS_UF_DONT_EXPIRE_PASSWD flag of the Active Directory User Account Control attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -Note: This parameter cannot be set to $true or 1 for an account that also has the ChangePasswordAtLogon property set to true. - -The following example shows how to set this parameter so that the password can expire. - --PasswordNeverExpires $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PasswordNotRequired -Specifies whether the account requires a password. -A password is not required for a new account. -This parameter sets the PasswordNotRequired property of an account object. - -The following example shows how to set this parameter to true. - --PasswordNotRequired $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the X.500 path of the Organizational Unit (OU) or container where the new object is created. - -In many cases, a default value will be used for the Path parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Path will be set in the following cases: - -- If the cmdlet is run from an Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive. -- If the cmdlet has a default path, this will be used. For example: in New-ADUser, the Path parameter would default to the Users container. -- If the target AD LDS instance has a default naming context, the default value of Path will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Path parameter will not take any default value. - -The following example shows how to set this parameter to an OU. - --Path "ou=mfg,dc=noam,dc=corp,dc=contoso,dc=com" - -Note: The Active Directory Provider cmdlets, such New-Item, Remove-Item, Remove-ItemProperty, Rename-Item and Set-ItemProperty also contain a Path property. -However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the user's postal code or zip code. -This parameter sets the PostalCode property of a user. -The LDAP Display Name (ldapDisplayName) of this property is "postalCode". - -The following example shows how to set this parameter. - --PostalCode "28712" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToDelegateToAccount -This parameter sets the msDS-AllowedToActOnBehalfOfOtherIdentity attribute of a computer account object. - -```yaml -Type: ADPrincipal[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProfilePath -Specifies a path to the user's profile. -This value can be a local absolute path or a Universal Naming Convention (UNC) path. -This parameter sets the ProfilePath property of the user object. -The LDAP display name (ldapDisplayName) for this property is "profilePath". - -The following examples show how to set this parameter to a local path and to a UNC path. --ProfilePath "E:\users\profiles\saraDavis" - --ProfilePath "\\\\users\profiles\saraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the SAMAccountName for an account object. -The LDAP display name (ldapDisplayName) for this property is "sAMAccountName". - -The following example shows how to specify this parameter. - --SAMAccountName "saradavis" - -Note: If the string value provided is not terminated with a '$' character, the system adds one if needed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScriptPath -Specifies a path to the user's log on script. -This value can be a local absolute path or a Universal Naming Convention (UNC) path. -This parameter sets the ScriptPath property of the user. -The LDAP display name (ldapDisplayName) for this property is "scriptPath". - -The following example shows how to set this parameter. - --ScriptPath "\\\\logonScripts\saradavisLogin" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalNames -Specifies the service principal names for the account. -This parameter sets the ServicePrincipalNames property of the account. -The LDAP display name (ldapDisplayName) for this property is servicePrincipalName. -To enter multiple values, use the following syntax: `,,...`. If the values contain spaces or otherwise require quotation marks, use the following syntax: `"","",...""`." - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SmartcardLogonRequired -Specifies whether a smart card is required to logon. -This parameter sets the SmartCardLoginRequired property for a user. -This parameter also sets the ADS_UF_SMARTCARD_REQUIRED flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that a smart card is required to logon to the account. - --SmartCardLogonRequired $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the user's or Organizational Unit's state or province. -This parameter sets the State property of a User or Organizational Unit object. -The LDAP display name (ldapDisplayName) of this property is "st". - -The following example shows how set this parameter. - --State "Nevada" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StreetAddress -Specifies the user's street address. -This parameter sets the StreetAddress property of a user object. -The LDAP display name (ldapDisplayName) of this property is "streetAddress". - -The following example shows how to set this parameter. - --StreetAddress "1200 Main Street" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Surname -Specifies the user's last name or surname. -This parameter sets the Surname property of a user object. -The LDAP display name (ldapDisplayName) of this property is "sn". - -The following example shows how to set this parameter. - --Surname "Patel" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Title -Specifies the user's title. -This parameter sets the Title property of a user object. -The LDAP display name (ldapDisplayName) of this property is "title". - -The following example shows how to set this parameter. - --Title "Manager" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the TrustedForDelegation property of an account object. -This value also sets the ADS_UF_TRUSTED_FOR_DELEGATION flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account is trusted for Kerberos delegation. - --TrustedForDelegation $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of object to create. -Set the Type parameter to the LDAP display name of the Active Directory Schema Class that represents the type of object that you want to create. -The selected type must be a subclass of the User schema class. -If this parameter is not specified it will default to "User". - -The following example shows how to use this parameter to create a new Active Directory InetOrgPerson object. - --Type "InetOrgPerson" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: User -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserPrincipalName -Each user account has a user principal name (UPN) in the format \@\. -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. -The UPN is independent of the user object's DN, so a user object can be moved or renamed without affecting the user logon name. -When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog box. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADUser -A user object that is a template for the new user object is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADUser -Returns the new user object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. -* This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADUser](./Get-ADUser.md) - -[Remove-ADUser](./Remove-ADUser.md) - -[Set-ADUser](./Set-ADUser.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessPolicy.md b/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessPolicy.md deleted file mode 100644 index 9c71698350..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessPolicy.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adcentralaccesspolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADCentralAccessPolicy - -## SYNOPSIS -Removes a central access policy from Active Directory. - -## SYNTAX - -``` -Remove-ADCentralAccessPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADCentralAccessPolicy cmdlet can be used to remove a central access policy from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADCentralAccessPolicy "Finance Policy" -``` - -Description - ------------ - -Removes the central access policy named "Finance Policy". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy -Filter 'Name -Like "Finance*"' | Remove-ADCentralAccessPolicy -``` - -Description - ------------ - -Get all resource property lists whose name starts with 'Finance' and then remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Policy,CN=Central Access Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -An Active Directory object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessPolicyMember.md b/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessPolicyMember.md deleted file mode 100644 index 9b1f282b26..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessPolicyMember.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adcentralaccesspolicymember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADCentralAccessPolicyMember - -## SYNOPSIS -Removes central access rules from a central access policy in Active Directory. - -## SYNTAX - -``` -Remove-ADCentralAccessPolicyMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Remove-ADCentralAccessPolicyMember cmdlet removes central access rules from a central access policy in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADCentralAccessPolicyMember "Finance Policy" -Members "Finance Documents Rule" -``` - -Description - ------------ - -Remove the resource property named 'Finance Documents Rule' from the central access policy named 'Finance Policy'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-ADCentralAccessPolicyMember "Finance Policy" "Finance Documents Rule","Corporate Documents Rule" -``` - -Description - ------------ - -Remove the central access rules named 'Finance Documents Rule' and 'Corporate Documents Rule' from the central access policy 'Finance Policy'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy -Filter "Name -like 'Corporate*'" | Remove-ADCentralAccessPolicyMember "Finance Documents Rule","Corporate Documents Rule" -``` - -Description - ------------ - -Gets the central access policies that begin with "Corporate" in its name, and then pipes that result to the Remove-ADCentralAccessPolicyMember, which then removes the central access rules named 'Finance Documents Rule' and 'Corporate Documents Rule' from the policies. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Policy,CN=Central Access Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Members -Specifies a set of central access rule (CAR) objects in a comma-separated list to add to a central access policy (CAP). - -To identify each object, use one of the following property values. -(Note: The identifier in parentheses is the LDAP display name.) - -Name - -Example: Finance Documents Rule - -Distinguished Name - -Example: CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -You can also provide objects to this parameter directly. - -The following examples show how to specify this parameter. - -This example specifies two CARs to add by specifying the distinguished name and the name properties. - --Members "CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com", "Corporate Documents Rule" - -This example specifies two CARs that are defined in the current Windows PowerShell session as input for the parameter. - --Members $carObject, $carObject2 - -You cannot pass objects through the pipeline to this parameter. - -```yaml -Type: ADCentralAccessRule[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -A ADCentralAccessPolicy object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.ADCentralAccessPolicy -Returns the modified ADCentralAccessPolicy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work with an Active Directory Snapshot. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessRule.md b/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessRule.md deleted file mode 100644 index 524a95cf24..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADCentralAccessRule.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adcentralaccessrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADCentralAccessRule - -## SYNOPSIS -Removes a central access rule from Active Directory. - -## SYNTAX - -``` -Remove-ADCentralAccessRule [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADCentralAccessRule cmdlet can be used to remove a central access rule from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADCentralAccessRule "Finance Documents Rule" -``` - -Description - ------------ - -Removes the specified central access rule ("Finance Documents Rule"). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADCentralAccessRule -Filter "ResourceCondition -like '*Department*'" | Remove-ADCentralAccessRule -``` - -Description - ------------ - -Removes the central access rules with 'Department' in their resource conditions. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessRule -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicyEntry -An Active Directory object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADClaimTransformPolicy.md b/docset/winserver2012-ps/activedirectory/Remove-ADClaimTransformPolicy.md deleted file mode 100644 index 5856aeb45a..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADClaimTransformPolicy.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adclaimtransformpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADClaimTransformPolicy - -## SYNOPSIS -Removes a claim transformation policy object from Active Directory. - -## SYNTAX - -``` -Remove-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADClaimTransformPolicy cmdlet can be used to remove a claim transformation policy object from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADClaimTransformPolicy DenyAllPolicy -``` - -Description - ------------ - -Removes the claims transformation policy with the name 'DenyAllPolicy'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADClaimTransformPolicy -Filter "Description -eq 'For testing only.'" | Remove-ADClaimTransformPolicy -``` - -Description - ------------ - -Gets all claims transformation policies that were marked in their description as "For testing only" and removes them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=DenyAllPolicy,CN=Claims Transformation Policies,CN=Claims Configuration,CN=Services,CN=Configuration, - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy -A claim transform policy object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADClaimType.md b/docset/winserver2012-ps/activedirectory/Remove-ADClaimType.md deleted file mode 100644 index fa46cd1152..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADClaimType.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adclaimtype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADClaimType - -## SYNOPSIS -Removes a claim type from Active Directory. - -## SYNTAX - -``` -Remove-ADClaimType [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Force] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADClaimType cmdlet can be used to remove a claim type from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADClaimType Title -``` - -Description - ------------ - -Remove the claim type with the name 'Title'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADClaimType -Filter "Enabled -eq `$False" | Remove-ADClaimType -``` - -Description - ------------ - -Get all the disabled claim types and remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Allows the cmdlet to remove objects that cannot otherwise be changed due to some attribute validation failure. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Employee Type,CN=Claim Types,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADClaimType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimType - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md b/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md deleted file mode 100644 index c15734100f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADComputer.md +++ /dev/null @@ -1,346 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adcomputer?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADComputer - -## SYNOPSIS -Removes an Active Directory computer. - -## SYNTAX - -``` -Remove-ADComputer [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADComputer cmdlet removes an Active Directory computer. - -The Identity parameter specifies the Active Directory computer to remove. -You can identify a computer by its distinguished name Members (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to a computer object variable, such as $\, or you can pass a computer object through the pipeline to the Identity parameter. -For example, you can use the Get-ADComputer cmdlet to retrieve a computer object and then pass the object through the pipeline to the Remove-ADComputer cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADComputer -Identity "FABRIKAM-SRV4" -``` - -Description - ------------ - -Remove one particular computer. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADComputer -Filter 'Location -eq "NA/HQ/Building A"' | Remove-ADComputer - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "CN=LabServer-01,CN=Computers,DC=Fabrikam,DC=com". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): a -``` - -Description - ------------ - -Remove all computers in a given location. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADComputer -Filter 'Location -eq "NA/HQ/Building A"' | Remove-ADComputer -confirm:$false -``` - -Description - ------------ - -Remove all computers from a given location and disables the confirm prompt. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADComputer "FABRIKAM-SRV4" | Remove-ADObject -Recursive -``` - -Description - ------------ - -Remove a computer and all leaf objects that are located underneath it in the directory. -(Note that only a few computer objects create child objects, such as servers running the Clustering service. -This example can be useful for removing those objects and any child objects owned by and associated with them.) - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager Account Name (sAMAccountName) - -Example: SaraDavisDesktop - -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a DN, the partition to search will be computed from that DN. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a computer object instance named "computerInstance". - --Identity $computerInstance - -```yaml -Type: ADComputer -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADComputerServiceAccount](./Get-ADComputerServiceAccount.md) - -[New-ADComputer](./New-ADComputer.md) - -[Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) - -[Set-ADComputer](./Set-ADComputer.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADComputerServiceAccount.md b/docset/winserver2012-ps/activedirectory/Remove-ADComputerServiceAccount.md deleted file mode 100644 index 87a6140619..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADComputerServiceAccount.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adcomputerserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADComputerServiceAccount - -## SYNOPSIS -Removes one or more service accounts from a computer. - -## SYNTAX - -``` -Remove-ADComputerServiceAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] - [-ServiceAccount] [] -``` - -## DESCRIPTION -The Remove-ADComputerServiceAccount cmdlet removes service accounts from an Active Directory computer. - -The Computer parameter specifies the Active Directory computer that contains the service accounts to remove. -You can identify a computer by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the Computer parameter to a computer object variable, such as $\, or pass a computer object through the pipeline to the Computer parameter. -For example, you can use the Get-ADComputer cmdlet to retrieve a computer object and then pass the object through the pipeline to the Remove-ADComputerServiceAccount cmdlet. - -The ServiceAccount parameter specifies the service accounts to remove. -You can identify a service account by its distinguished name (DN), GUID, security identifier (SID) or security accounts manager (SAM) account name. -You can also specify service account object variables, such as $\. -If you are specifying more than one service account, use a comma-separated list. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADComputerServiceAccount -Computer ComputerAcct1 -serviceAccount SvcAcct1 -``` - -Description - ------------ - -Remove a service account 'SvcAcct1' from a Computer Account 'ComputerAcct1'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-ADComputerServiceAccount -Computer ComputerAcct1 -serviceAccount SvcAcct1,SvcAcct2 -``` - -Description - ------------ - -Remove service accounts: 'SvcAcct1,SvcAcct2' from a Computer Account: 'ComputerAcct1'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager Account Name (sAMAccountName) - -Example: SaraDavisDesktop - -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a DN, the partition to search will be computed from that DN. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a computer object instance named "computerInstance". - --Identity $computerInstance - -```yaml -Type: ADComputer -Parameter Sets: (All) -Aliases: Computer - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccount -Specifies one or more Active Directory service accounts. -You can identify a service account by using one of the following property values: - -Distinguished Name - -Example: CN=serviceadmin,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: serviceadmin - -The following example shows how to specify a service account for this parameter using the SAM Account Name. - --ServiceAccount "serviceAdminEurope" - -```yaml -Type: ADServiceAccount[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the Computer parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -Returns an object that represents the modified computer object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) - -[Get-ADComputer](./Get-ADComputer.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy.md b/docset/winserver2012-ps/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy.md deleted file mode 100644 index c2af35efef..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADDomainControllerPasswordReplicationPolicy.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-addomaincontrollerpasswordreplicationpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADDomainControllerPasswordReplicationPolicy - -## SYNOPSIS -Removes users, computers, and groups from the allowed or denied list of a read-only domain controller password replication policy. - -## SYNTAX - -### AllowedPRP -``` -Remove-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] -AllowedList - [-AuthType ] [-Credential ] [-Identity] [-PassThru] - [-Server ] [] -``` - -### DeniedPRP -``` -Remove-ADDomainControllerPasswordReplicationPolicy [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] -DeniedList [-Identity] [-PassThru] - [-Server ] [] -``` - -## DESCRIPTION -The **Remove-ADDomainControllerPasswordReplicationPolicy** cmdlet removes one or more users, computers, and groups from the allowed or denied list of a read-only domain controller (RODC) password replication policy. - -The *Identity* parameter specifies the RODC that uses the allowed and denied lists to apply the password replication policy. -You can identify a domain controller by its GUID, IPV4Address, global IPV6Address, or DNS host name. -You can also identify a domain controller by the name of the server object that represents the domain controller, the distinguished name of the NTDS settings object or the server object, the GUID of the NTDS settings object or the server object under the configuration partition, or the distinguished name of the computer object that represents the domain controller. -You can also set the *Identity* parameter to a domain controller object variable, such as `$`, or pass a domain controller object through the pipeline operator to the *Identity* parameter. -For example, you can use the **Get-ADDomainController** cmdlet to retrieve a domain controller object and then pass the object through the pipeline operator to the **Remove-ADDomainControllerPasswordReplicationPolicy** cmdlet. -You must provide a read-only domain controller. - -The *AllowedList* parameters specify the users, computers and groups to remove from the allowed list. -Similarly, the *DeniedList* parameter specifies the users, computers and groups to remove from the denied list. -You must specify either one or both of the *AllowedList* and *DeniedList* parameters. -You can identify a user, computer or group by distinguished name (DN), GUID, security identifier (SID) or security accounts manager (SAM) account name. -You can also specify user, computer or group variables, such as `$`. -If you are specifying more than one item, use a comma-separated list. - -## EXAMPLES - -### Example 1: Remove specific users from the Allowed list on a RODC -``` -C:\PS>Remove-ADDomainControllerPasswordReplicationPolicy -Identity "FABRIKAM-RODC1" -AllowedList "JesperAaberg", "AdrianaAdams" -``` - -Remove the users with samAccountNames 'JesperAaberg' and 'AdrianaAdams' from the Allowed list on the RODC 'FABRIKAM-RODC1'. - -### Example 2: Remove specific users from the Denied list on a RODC -``` -C:\PS>Remove-ADDomainControllerPasswordReplicationPolicy -Identity "FABRIKAM-RODC1" -DeniedList "MichaelAllen", "ElizabethAndersen" -``` - -Remove the users with samAccountNames 'MichaelAllen' and 'ElizabethAndersen' from the Denied list on the RODC 'FABRIKAM-RODC1'. - -## PARAMETERS - -### -AllowedList -Specifies the users, computers, groups or other accounts to add to the list of accounts allowed to replicate their passwords to this RODC. -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A Security Accounts Manager (SAM) account name (sAMAccountName) - -```yaml -Type: ADPrincipal[] -Parameter Sets: AllowedPRP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -Specifies the credentials for the security context under which the task is performed. -If this security context doesn't have directory level permissions to perform the task, then an error is returned by the directory. -If running under the context of an Active Directory module for Windows PowerShell provider drive, the credentials information associated with the drive is used as the default value; otherwise, the currently logged on user security context is used. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeniedList -Specifies the users, computers, groups, or other accounts to add to the list of accounts that are denied the right to replicate their passwords to this RODC. -You can specify more than one value by using a comma-separated list. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -```yaml -Type: ADPrincipal[] -Parameter Sets: DeniedPRP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain controller object by providing one of the following values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -The acceptable values for this parameter are: - -- A GUID (objectGUID) -- An IPV4Address -- A Global IPV6Address -- A DNS Host Name (dNSHostName) -- A name of the server object -- A distinguished name of the NTDS Settings object -- A distinguished name of the server object that represents the domain controller -- A GUID of NTDS settings object under the configuration partition -- A GUID of server object under the configuration partition -- A distinguished name of the computer object that represents the domain controller - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADDomainController -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services, or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [About CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomainController -A read-only domain controller object is received by the *Identity* parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomainController -This cmdlet returns the modified read-only domain controller object when the *PassThru* parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with Active Directory Lightweight Directory Services (AD LDS). -* This cmdlet does not work with an Active Directory snapshot. -* This cmdlet does not work with a read-only domain controller. -* By default, this cmdlet has the *Confirm* parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify `-Confirm:$False` when using this cmdlet. - -## RELATED LINKS - -[Add-ADDomainControllerPasswordReplicationPolicy](./Add-ADDomainControllerPasswordReplicationPolicy.md) - -[Get-ADDomainController](./Get-ADDomainController.md) - -[Get-ADDomainControllerPasswordReplicationPolicy](./Get-ADDomainControllerPasswordReplicationPolicy.md) - -[AD DS Administration Cmdlets in Windows PowerShell](./activedirectory.md) diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADFineGrainedPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/Remove-ADFineGrainedPasswordPolicy.md deleted file mode 100644 index fa82e9ce63..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADFineGrainedPasswordPolicy.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adfinegrainedpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFineGrainedPasswordPolicy - -## SYNOPSIS -Removes an Active Directory fine grained password policy. - -## SYNTAX - -``` -Remove-ADFineGrainedPasswordPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADFineGrainedPasswordPolicy cmdlet removes an Active Directory fine grained password policy. - -The Identity parameter specifies the Active Directory fine grained password policy to remove. -You can identify a fine grained password policy by its distinguished name, or GUID. -You can also set the Identity parameter to a fine grained password object variable, such as $\, or you can pass a fine grained password policy object through the pipeline to the Identity parameter. -For example, you can use the Get-ADFineGrainedPasswordPolicy cmdlet to retrieve a fine grained password policy object and then pass the object through the pipeline to the Remove-ADFineGrainedPasswordPolicy cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFineGrainedPasswordPolicy MyPolicy -``` - -Description - ------------ - -Remove the Fine Grained Password Policy object named 'MyPolicy'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-ADFineGrainedPasswordPolicy -Identity 'CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM' -``` - -Description - ------------ - -Remove the Fine Grained Password Policy object with DistinguishedName 'CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicy -Filter "Name -like '*user*'" | Remove-ADFineGrainedPasswordPolicy -``` - -Description - ------------ - -Remove all File Grained Password Policy objects that contain user in their names. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name (distinguishedName) - -Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: PasswordPolicyLevel1 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a fine-grained password policy object instance named "fineGrainedPasswordPolicyInstance". - --Identity $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -A fine grained password policy object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADFineGrainedPasswordPolicySubject](./Add-ADFineGrainedPasswordPolicySubject.md) - -[Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) - -[Get-ADFineGrainedPasswordPolicySubject](./Get-ADFineGrainedPasswordPolicySubject.md) - -[New-ADFineGrainedPasswordPolicy](./New-ADFineGrainedPasswordPolicy.md) - -[Remove-ADFineGrainedPasswordPolicySubject](./Remove-ADFineGrainedPasswordPolicySubject.md) - -[Set-ADFineGrainedPasswordPolicy](./Set-ADFineGrainedPasswordPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADFineGrainedPasswordPolicySubject.md b/docset/winserver2012-ps/activedirectory/Remove-ADFineGrainedPasswordPolicySubject.md deleted file mode 100644 index 15f67e2427..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADFineGrainedPasswordPolicySubject.md +++ /dev/null @@ -1,372 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adfinegrainedpasswordpolicysubject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFineGrainedPasswordPolicySubject - -## SYNOPSIS -Removes one or more users from a fine grained password policy. - -## SYNTAX - -``` -Remove-ADFineGrainedPasswordPolicySubject [-WhatIf] [-Confirm] [-AuthType ] - [-Credential ] [-Identity] [-Partition ] [-PassThru] - [-Server ] [-Subjects] [] -``` - -## DESCRIPTION -The Remove-ADFineGrainedPasswordPolicySubject cmdlet removes one or more global security groups and users from a fine grained password policy. - -The Identity parameter specifies the fine grained password policy. -You can identify a fine grained password policy by its distinguished name or GUID. -You can also set the Identity parameter to a fine grained password policy object variable, such as $\, or pass a fine grained password policy object through the pipeline to the Identity parameter. -For example, you can use the Get-ADFineGrainedPasswordPolicy cmdlet to retrieve a fine grained password policy object and then pass the object through the pipeline to the Remove-ADFineGrainedPasswordPolicySubject cmdlet. - -The Subjects parameter specifies the users and groups to remove from the password policy. -You can identify a user or group by its distinguished name (DN), GUID, security identifier (SID), security accounts manager (SAM) account name, or canonical name. -You can also specify user or group object variables, such as $\. -If you are specifying more than one user or group, use a comma-separated list. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFineGrainedPasswordPolicySubject DlgtdAdminsPSO -Subjects BobKe,KimAb -``` - -Description - ------------ - -Remove the Fine-Grained Password Policy named 'DlgtdAdminsPSO' from two users, with SamAccountNames 'BobKe' and 'KimAb'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADFineGrainedPasswordPolicySubject DlgtdAdminsPSO | where {$_.Name -like "*Price"} | Remove-ADFineGrainedPasswordPolicySubject DlgtdAdminsPSO -``` - -Description - ------------ - -Remove any subjects that have names ending with 'Price' from the name list on which the Fine-Grained Password Policy named DlgtdAdminsPSO applies. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name (distinguishedName) - -Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: PasswordPolicyLevel1 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a fine-grained password policy object instance named "fineGrainedPasswordPolicyInstance". - --Identity $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subjects -Specifies one or more users or groups. -To specify more than one user or group, use a comma-separated list. -You can identify a user or group by one of the following property values. - -Distinguished Name (DN) - -Example: CN=SaraDavis,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -Note: The identifier in parentheses is the LDAP display name for the attribute. - -You can also provide objects to this parameter directly. - -The following example shows how to set this parameter to a list of users and groups by using a distinguished name and SAM account names. - --Subjects "CN=SaraDavis, CN=Users,DC=corp,DC=contoso,DC=com","donhall","saradavisreports" - -```yaml -Type: ADPrincipal[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -A fine grained password policy object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -Returns an object that represents the modified fine grained password policy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADFineGrainedPasswordPolicySubject](./Add-ADFineGrainedPasswordPolicySubject.md) - -[Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) - -[Get-ADFineGrainedPasswordPolicySubject](./Get-ADFineGrainedPasswordPolicySubject.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADGroup.md b/docset/winserver2012-ps/activedirectory/Remove-ADGroup.md deleted file mode 100644 index c52bf2801b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADGroup.md +++ /dev/null @@ -1,332 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adgroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADGroup - -## SYNOPSIS -Removes an Active Directory group. - -## SYNTAX - -``` -Remove-ADGroup [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADGroup cmdlet removes an Active Directory group object. -You can use this cmdlet to remove security and distribution groups. - -The Identity parameter specifies the Active Directory group to remove. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID), Security Accounts Manager (SAM) account name, or canonical name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADGroup cmdlet to retrieve a group object and then pass the object through the pipeline to the Remove-ADGroup cmdlet. - -If the ADGroup is being identified by its DN, the Partition parameter will be automatically determined. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - -- The cmdlet is run from an Active Directory provider drive. -- A default naming context or partition is defined for the AD LDS environment. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>remove-adgroup SanjaysReports - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "CN=SanjayReports,DC=Fabrikam,DC=com". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): -``` - -Description - ------------ - -Remove the group that has samAccountName 'SanjaysReports'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>get-adgroup -filter 'Name -like "Sanjay*"' | remove-adgroup - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "CN=SanjaysReports,DC=Fabrikam,DC=com". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): -``` - -Description - ------------ - -Get all groups whose name starts with 'Sanjay' and then remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a group object instance named "ADGroupInstance". - --Identity $ADGroupInstance - -```yaml -Type: ADGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[New-ADGroup](./New-ADGroup.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - -[Set-ADGroup](./Set-ADGroup.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADGroupMember.md b/docset/winserver2012-ps/activedirectory/Remove-ADGroupMember.md deleted file mode 100644 index 9e1865d623..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADGroupMember.md +++ /dev/null @@ -1,427 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adgroupmember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADGroupMember - -## SYNOPSIS -Removes one or more members from an Active Directory group. - -## SYNTAX - -``` -Remove-ADGroupMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-Partition ] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Remove-ADGroupMember cmdlet removes one or more users, groups, service accounts, or computers from an Active Directory group. - -The Identity parameter specifies the Active Directory group that contains the members to remove. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also specify a group object variable, such as $\, or pass a group object through the pipeline to the Identity parameter. -For example, you can use the Get-ADGroup cmdlet to retrieve a group object and then pass the object through the pipeline to the Remove-ADGroupMember cmdlet. - -The Members parameter specifies the users, computers and groups to remove from the group specified by the Identity parameter. -You can identify a user, computer or group by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also specify user, computer, and group object variables, such as $\. -If you are specifying more than one new member, use a comma-separated list. -You cannot pass user, computer, or group objects through the pipeline to this cmdlet. -To remove user, computer, or group objects from a group by using the pipeline, use the Remove-ADPrincipalGroupMembership cmdlet. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>remove-adgroupmember -Identity "DocumentReaders" -Members "WilsonPais" - -Confirm -Are you sure you want to perform this action? -Performing operation "Set" on Target "CN=DocumentReaders,CN=Users,DC=Fabrikam,DC=com". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): -``` - -Description - ------------ - -Remove the user with samAccountName 'WilsonPais' from the group 'DocumentReaders'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>remove-adgroupmember "DocumentReaders" "administrator","Wilson Pais" -``` - -Description - ------------ - -Remove the users with samAccountNames 'administrator' and 'WilsonPais' from the group 'DocumentReaders'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>get-adgroup -server localhost:60000 "CN=AccessControl,DC=AppNC" | remove-adgroupmember -Members "CN=GlenJohns,DC=AppNC" - -Confirm -Are you sure you want to perform this action? -Performing operation "Set" on Target "CN=AccessControl,DC=AppNC". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): -``` - -Description - ------------ - -Remove the user with DistinguishedName 'CN=GlenJohns,DC=AppNC' from the AccessControl group on an AD LDS instance using the pipeline. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a group object instance named "ADGroupInstance". - --Identity $ADGroupInstance - -```yaml -Type: ADGroup -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Members -Specifies a set of users, groups, and computers to remove from a group. -You can identify users, groups, and computers by specifying one of the following values. -Note: The identifier in parentheses is the LDAP display name. - -Distinguished Name - -Example: CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -You can also provide objects to this parameter directly. - -The following examples show how to specify this parameter. - -This example specifies a user and group to remove by specifying the distinguished name and the SAM Account Name property values. - --Members "CN=SaraDavis,CN=employees,CN=Users,DC=contoso,DC=com", "saradavisreports" - -This example specifies a user and a group object that are defined in the current Windows PowerShell session as input for the parameter. - --Members $userObject, $groupObject - -The objects specified for this parameter are processed as Microsoft.ActiveDirectory.Management.ADPrincipal objects. -Derived types, such as the following are also received by this parameter. - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADGroup - -You cannot pass objects through the pipeline to this parameter. - -```yaml -Type: ADPrincipal[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -Returns the modified group object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) - -[Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADObject.md b/docset/winserver2012-ps/activedirectory/Remove-ADObject.md deleted file mode 100644 index 7df45b5454..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADObject.md +++ /dev/null @@ -1,431 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADObject - -## SYNOPSIS -Removes an Active Directory object. - -## SYNTAX - -``` -Remove-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-IncludeDeletedObjects] [-Partition ] [-Recursive] [-Server ] - [] -``` - -## DESCRIPTION -The Remove-ADObject cmdlet removes an Active Directory object. -You can use this cmdlet to remove any type of Active Directory object. - -The Identity parameter specifies the Active Directory object to remove. -You can identify an object by its distinguished name (DN) or GUID. -You can also set the Identity parameter to an Active Directory object variable, such as $\, or pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADObject cmdlet to retrieve an object and then pass the object through the pipeline to the Remove-ADObject cmdlet. - -If the object you specify to remove has child objects, you must specify the Recursive parameter. - -For AD LDS environments, the Partition parameter must be specified except when: - Using a DN to identify objects: the partition will be auto-generated from the DN. -- Running cmdlets from an Active Directory provider drive: the current path will be used to set the partition. -- A default naming context or partition is specified. - -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADObject 'CN=AmyAl-LPTOP,CN=Computers,DC=FABRIKAM,DC=COM' - - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "CN=AmyAl-LPTOP,CN=Computers,DC=FABRIKAM,DC=COM". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Description - ------------ - -Remove the object identified by the DistinguishedName 'CN=AmyAl-LPTOP,CN=Computers,DC=FABRIKAM,DC=COM'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-ADObject "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -Recursive - - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Description - ------------ - -Deletes the container with DistinguishedName 'OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM' including the child objects. -Note: All the children of the container including the ones which are protected from accidental deletion are also deleted. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Remove-ADObject "65511e76-ea80-45e1-bc93-08a78d8c4853" -Confirm:$false -``` - -Description - ------------ - -Removes the object with objectGUID '65511e76-ea80-45e1-bc93-08a78d8c4853' without giving the confirmation prompt. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Remove-ADObject -Identity "CN=InternalApps,DC=AppNC" -server "FABRIKAM-SRV1:60000" - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "CN=InternalApps,DC=AppNC". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Description - ------------ - -removes the object with DistinguishedName 'CN=InternalApps,DC=AppNC' from an LDS instance. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADObject -Filter 'isDeleted -eq $true -and -not (isRecycled -eq $true) -and name -ne "Deleted Objects" -and lastKnownParent -eq "OU=Accounting,DC=Fabrikam,DC=com"' -IncludeDeletedObjects | Remove-ADObject -``` - -Description - ------------ - -Recycles all the objects in the recycle bin which used to be in the container 'OU=Accounting,DC=Fabrikam,DC=com'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IncludeDeletedObjects -Specifies to retrieve deleted objects and the deactivated forward and backward links. -When this parameter is specified, the cmdlet uses the following LDAP controls: - -Show Deleted Objects (1.2.840.113556.1.4.417) - -Show Deactivated Links (1.2.840.113556.1.4.2065) - -Note: If this parameter is not specified, the cmdlet will not return or operate on deleted objects. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recursive -Specifies that the cmdlet should remove the object and any children it contains. - -The following example shows how to specify this parameter. - --Recursive - -Note: Specifying this parameter it will remove all child objects even if there are objects marked with ProtectedFromAccidentalDeletion. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -An Active Directory object is received by the Identity parameter. -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work when connected to a Global Catalog port. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[New-ADObject](./New-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADOrganizationalUnit.md b/docset/winserver2012-ps/activedirectory/Remove-ADOrganizationalUnit.md deleted file mode 100644 index 203e011baf..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADOrganizationalUnit.md +++ /dev/null @@ -1,370 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adorganizationalunit?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADOrganizationalUnit - -## SYNOPSIS -Removes an Active Directory organizational unit. - -## SYNTAX - -``` -Remove-ADOrganizationalUnit [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-Recursive] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADOrganizationalUnit cmdlet removes an Active Directory organizational unit. - -The Identity parameter specifies the organizational unit to remove. -You can identify an organizational unit by its distinguished name (DN) or GUID. -You can also set the parameter to an organizational unit object variable, such as $\ or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADOrganizationalUnit cmdlet to retrieve the object and then pass the object through the pipeline to the Remove-ADOrganizationalUnit cmdlet. - -If the object you specify to remove has child objects, you must specify the Recursive parameter. - -If the ProtectedFromAccidentalDeletion property of the organizational unit object is set to true, the cmdlet returns a terminating error. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADOrganizationalUnit -Identity "OU=Accounting,DC=FABRIKAM,DC=COM" -Recursive - - -Are you sure you want to remove the item and all its children? -Performing recursive remove on Target: 'OU=Accounting,DC=Fabrikam,DC=com'. -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help -(default is "Y"):y -``` - -Description - ------------ - -Removes an OrganizationalUnit and all of it's children. -If the OrganizationalUnit is protected from deletion, then the OrganizationalUnit and it's children will not be deleted. -If the OrganizationalUnit is not protected but any of the children are, then both the OrganizationalUnit and the children will be deleted. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-ADOrganizationalUnit -Identity "1b228aa5-2c14-48b8-ad8a-2685dc22e055" -confirm:$false -``` - -Description - ------------ - -Removes an OrganizationalUnit using it's objectGUID as the Identity while suppressing the confirmation prompt. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Remove-ADOrganizationalUnit -Identity "OU=Accounting,DC=FABRIKAM,DC=COM" - -Confirm -Are you sure you want to perform this action? -Performing operation "Remove" on Target "OU=Accounting,DC=Fabrikam,DC=com". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help -(default is "Y"):y -``` - -Description - ------------ - -Removes the Accounting OrganizationalUnit. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Remove-ADOrganizationalUnit -Identity "OU=Managed,DC=AppNC" -server "FABRIKAM-SRV1:60000" -confirm:$false -``` - -Description - ------------ - -Removes an OrganizationalUnit from an LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of an Active Directory organizational unit object. -The parameter accepts the following identity formats. -The identifier in parentheses is the LDAP display name for the attribute that contains the identity. - -Distinguished Name - -Example: OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an organizational unit object instance named "OUinstance". - --Identity $OUInstance - -```yaml -Type: ADOrganizationalUnit -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recursive -Specifies that the cmdlet remove the organizational unit and any child items it contains. -You must specify this parameter to remove an organizational unit (OU) that is not empty. - -Note: Specifying this parameter it will remove all child objects under an OU that has been marked with ProtectedFromAccidentalDeletion. - -The following example shows how to specify this parameter. - --Recursive - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOrganizationalUnit -An organizational unit object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADOrganizationalUnit](./Get-ADOrganizationalUnit.md) - -[New-ADOrganizationalUnit](./New-ADOrganizationalUnit.md) - -[Set-ADOrganizationalUnit](./Set-ADOrganizationalUnit.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADPrincipalGroupMembership.md b/docset/winserver2012-ps/activedirectory/Remove-ADPrincipalGroupMembership.md deleted file mode 100644 index 4cf2db199b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADPrincipalGroupMembership.md +++ /dev/null @@ -1,409 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adprincipalgroupmembership?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADPrincipalGroupMembership - -## SYNOPSIS -Removes a member from one or more Active Directory groups. - -## SYNTAX - -``` -Remove-ADPrincipalGroupMembership [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-MemberOf] [-Partition ] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Remove-ADPrincipalGroupMembership cmdlet removes a user, group, computer, service account, or any other account object from one or more Active Directory groups. - -The Identity parameter specifies the user, group, or computer to remove. -You can identify the user, group, or computer by its distinguished name (DN), GUID, security identifier (SID) or SAM account name. -You can also specify a user, group, or computer object variable, such as $\, or pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADUser cmdlet to retrieve a user object and then pass the object through the pipeline to the Remove-ADPrincipalGroupMembership cmdlet. -Similarly, you can use Get-ADGroup or Get-ADComputer to get group, service account and computer objects to pass through the pipeline. - -This cmdlet collects all of the user, computer, service account and group objects from the pipeline, and then removes these objects from the specified group by using one Active Directory operation. - -The MemberOf parameter specifies the groups that you want to remove the member from. -You can identify a group by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also specify group object variable, such as $\. -To specify more than one group, use a comma-separated list. -You cannot pass group objects through the pipeline to the MemberOf parameter. -To remove a member from groups that are passed through the pipeline, use the Remove-ADGroupMember cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADPrincipalGroupMembership -Identity "Wilson Pais" -MemberOf "Administrators" - -Remove members from group -Do you want to remove all the specified member(s) from the specified group(s)? -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y -``` - -Description - ------------ - -Remove the user 'Wilson Pais' from the administrators group. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>get-aduser -server localhost:60000 -Identity "CN=GlenJohns,DC=AppNC" | remove-adprincipalgroupmembership -memberof "CN=AccessControl,DC=AppNC" -``` - -Description - ------------ - -Retrieve the user with DistinguishedName 'CN=GlenJohns,DC=AppNC' and remove it from the group with the DistinguishedName 'CN=AccessControl,DC=AppNC' using the pipeline. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory principal object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -- Microsoft.ActiveDirectory.Management.ADGroup -- Microsoft.ActiveDirectory.Management.ADUser -- Microsoft.ActiveDirectory.Management.ADComputer -- Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a principal object instance named "principalInstance". - --Identity $principalInstance - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MemberOf -Specifies the Active Directory groups to add a user, computer, or group to as a member. -You can identify a group by providing one of the following values. -Note: The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,CN=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -If you are specifying more than one group, use commas to separate the groups in the list. - -The following example shows how to specify this parameter by using SAM account name values. - --MemberOf "SaraDavisGroup", "JohnSmithGroup" - -```yaml -Type: ADGroup[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADPrincipal -A principal object that represents user, computer, or group is received by the Identity parameter. -Derived types, such as the following are also received by this parameter. - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADGroup - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADPrincipal -Returns a principal object that represents the modified user, computer or group object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Get-ADUser](./Get-ADUser.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSite.md b/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSite.md deleted file mode 100644 index ca3430eb8f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSite.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adreplicationsite?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADReplicationSite - -## SYNOPSIS -Deletes the specified replication site object from Active Directory. - -## SYNTAX - -``` -Remove-ADReplicationSite [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADReplicationSite deletes a specified replication site object from Active Directory. -If domain controllers are no longer needed in a network location, you can remove them from a site and then delete the site object. -Before deleting the site, you must remove all domain controllers from the site either by removing them entirely or by moving them to a new location. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADReplicationSite Europe -``` - -Description - ------------ - -Remove the site with name 'Europe'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSite -Filter "Description -eq 'For testing only.'" | Remove-ADReplicationSite -``` - -Description - ------------ - -Get the sites that are for testing only and remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSite -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSite -A site object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADReplicationSite](./Get-ADReplicationSite.md) - -[New-ADReplicationSite](./New-ADReplicationSite.md) - -[Set-ADReplicationSite](./Set-ADReplicationSite.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSiteLink.md b/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSiteLink.md deleted file mode 100644 index 82807303b7..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSiteLink.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adreplicationsitelink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADReplicationSiteLink - -## SYNOPSIS -Deletes an Active Directory site link used to manage replication. - -## SYNTAX - -``` -Remove-ADReplicationSiteLink [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADReplicationSiteLink cmdlet removes a site link object used to manage replication traffic between two sites in your Active Directory installation. -For more information on site links, see the following topic "Creating a Site Link Design" in the TechNet Library: http://go.microsoft.com/fwlink/?LinkId=221870 - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADReplicationSiteLink "Europe-Asia" -``` - -Description - ------------ - -Remove the site link with the name 'Europe-Asia'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink -Filter "SitesIncluded -eq 'NorthAmerica'" | Remove-ADReplicationSiteLink -``` - -Description - ------------ - -Get the site links that include NorthAmerica and remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica-SouthAmerica,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSiteLink -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink -A site link object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADReplicationSiteLink](./Get-ADReplicationSiteLink.md) - -[New-ADReplicationSiteLink](./New-ADReplicationSiteLink.md) - -[Set-ADReplicationSiteLink](./Set-ADReplicationSiteLink.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSiteLinkBridge.md b/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSiteLinkBridge.md deleted file mode 100644 index 24c2fa6dd0..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSiteLinkBridge.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adreplicationsitelinkbridge?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADReplicationSiteLinkBridge - -## SYNOPSIS -Deletes the specified replication site link bridge from Active Directory. - -## SYNTAX - -``` -Remove-ADReplicationSiteLinkBridge [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADReplicationSiteLinkBridge object deletes the specified replication site link bridge from Active Directory. -A site link bridge connects two or more site links and enables transitivity between site links. -Each site link in a bridge must have a site in common with another site link in the bridge. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -``` - -Description - ------------ - -Remove the site link bridge with name 'NorthAmerica-Asia'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLinkBridge -Filter "SiteLinksIncluded -eq 'Europe-Asia'" | Remove-ADReplicationSiteLinkBridge -``` - -Description - ------------ - -Get the site link bridges that include 'Europe-Asia' and remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica-Asia,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSiteLinkBridge -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge -A site link bridge object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADReplicationSiteLinkBridge](./Get-ADReplicationSiteLinkBridge.md) - -[New-ADReplicationSiteLinkBridge](./New-ADReplicationSiteLinkBridge.md) - -[Set-ADReplicationSiteLinkBridge](./Set-ADReplicationSiteLinkBridge.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSubnet.md b/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSubnet.md deleted file mode 100644 index ad4ed1eec9..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADReplicationSubnet.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adreplicationsubnet?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADReplicationSubnet - -## SYNOPSIS -Deletes the specified Active Directory replication subnet object from the directory. - -## SYNTAX - -``` -Remove-ADReplicationSubnet [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADReplicationSubnet cmdlet deletes the specified Active Directory replication subnet object from the directory. -Subnet objects (class subnet) define network subnets in Active Directory. -A network subnet is a segment of a TCP/IP network to which a set of logical IP addresses is assigned. -Subnets group computers in a way that identifies their physical proximity on the network. -Subnet objects in Active Directory are used to map computers to sites. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADReplicationSubnet "10.0.0.0/25" -``` - -Description - ------------ - -Remove the site link with name '10.0.0.0/25'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSubnet -Filter "Location -like '*Japan'" | Remove-ADReplicationSubnet -``` - -Description - ------------ - -Get all the subnets in Japan and remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=10.0.0.0/25,CN=Subnets,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSubnet -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet -A subnet object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADReplicationSubnet](./Get-ADReplicationSubnet.md) - -[New-ADReplicationSubnet](./New-ADReplicationSubnet.md) - -[Set-ADReplicationSubnet](./Set-ADReplicationSubnet.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADResourceProperty.md b/docset/winserver2012-ps/activedirectory/Remove-ADResourceProperty.md deleted file mode 100644 index d1dece9593..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADResourceProperty.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adresourceproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADResourceProperty - -## SYNOPSIS -Removes a resource property from Active Directory. - -## SYNTAX - -``` -Remove-ADResourceProperty [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADResourceProperty cmdlet removes a resource property from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADResourceProperty "Country" -``` - -Description - ------------ - -Removes the specified resource property. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the resource property. - -Distinguished Name - -Example: CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourceProperty -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourceProperty - -## OUTPUTS - -### None -This cmdlet does not work with an Active Directory Snapshot. - -This cmdlet does not work with a read-only domain controller. - -## NOTES -* By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADResourcePropertyList.md b/docset/winserver2012-ps/activedirectory/Remove-ADResourcePropertyList.md deleted file mode 100644 index f2fc6f7c6e..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADResourcePropertyList.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adresourcepropertylist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADResourcePropertyList - -## SYNOPSIS -Removes one or more resource property lists from Active Directory. - -## SYNTAX - -``` -Remove-ADResourcePropertyList [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADResourcePropertyList cmdlet removes one or more claim lists from Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADResourcePropertyList "Corporate Resource Property List" -``` - -Description - ------------ - -Remove the resource property list named 'Corporate Resource Property List'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList -Filter 'Name -Like "Branch*"' | Remove-ADResourcePropertyList -``` - -Description - ------------ - -Get all resource property lists whose name starts with 'Branch' and then remove them. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the resource property. - -Distinguished Name - -Example: CN=Global Resource Property List,CN=Resource Property Lists,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourcePropertyList -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADResourcePropertyListMember.md b/docset/winserver2012-ps/activedirectory/Remove-ADResourcePropertyListMember.md deleted file mode 100644 index d52db7e90c..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADResourcePropertyListMember.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adresourcepropertylistmember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADResourcePropertyListMember - -## SYNOPSIS -Removes one or more resource properties from a resource property list in Active Directory. - -## SYNTAX - -``` -Remove-ADResourcePropertyListMember [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Members] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Remove-ADResourcePropertyListMember cmdlet can be used to remove one or more resource properties from a resource property list in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADResourcePropertyListMember "Global Resource Property List" -Members Country -``` - -Description - ------------ - -Removes the resource property specified as a list member ("Country") from the specified resource property list ("Global Resource Property List"). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-ADResourcePropertyListMember "Corporate Resource Property List" Department,Country -``` - -Description - ------------ - -Removes the resource properties named 'Department' and 'Country' from the resource property list ("Corporate Resource Property List"). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList -Filter "Name -like 'Corporate*'" | Remove-ADResourcePropertyListMember Department,Country -``` - -Description - ------------ - -Gets the resource property lists that have a name that begins with "Corporate" and then pipes it to Remove-ADResourcePropertyListMember, which then removes the resource properties with the name 'Department' and 'Country' from it. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourcePropertyList -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Members -Specifies a set of ADResourceProperty objects in a comma-separated list to add to a resource property list. -To identify each object, use one of the following property values. -Note: The identifier in parentheses is the LDAP display name. - -Name - -Example: Country - -Distinguished Name - -Example: CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -You can also provide objects to this parameter directly. - -The following examples show how to specify this parameter. - -This example specifies two resource properties to add by specifying the distinguished name and the name properties. - --Members "CN=Country,CN=Resource Properties,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com", "Authors" - -This example specifies two resource property object that are defined in the current Windows PowerShell session as input for the parameter. - --Members $rpObject1, $rpObject2 - -You cannot pass objects through the pipeline to this parameter. - -```yaml -Type: ADResourceProperty[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList -An ADResourcePropertyList object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourcePropertyList -Returns the modified ADResourcePropertyList object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work with an Active Directory Snapshot. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/Remove-ADServiceAccount.md deleted file mode 100644 index cb5c505b97..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADServiceAccount.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADServiceAccount - -## SYNOPSIS -Remove an Active Directory managed service account or group managed service account object. - -## SYNTAX - -``` -Remove-ADServiceAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The Remove-ADServiceAccount cmdlet removes an Active Directory managed service account (MSA). -This cmdlet does not make changes to any computers that use the MSA. -After this operation, the MSA no longer exists in the directory, but computers will still be configured to use the MSA. - -The Identity parameter specifies the Active Directory MSA to remove. -You can identify a MSA by its distinguished name (DN), GUID, security identifier (SID) or security accounts manager (SAM) account name. -You can also set the Identity parameter to a MSA object variable, such as $\, or you can pass a MSA object through the pipeline to the Identity parameter. -For example, you can use the Get-ADServiceAccount cmdlet to retrieve a MSA object and then pass the object through the pipeline to the Remove-ADServiceAccount cmdlet. - -Note: Removing the service account is a different operation than uninstalling the service account locally. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADServiceAccount -Identity SQL-SRV1 -``` - -Description - ------------ - -Remove the managed service account named 'service1'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADServiceAccount -Filter "Name -like 'SQL*'" | Remove-ADServiceAccount -``` - -Description - ------------ - -Remove all managed service accounts with names that start with 'SQL'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: WebAccount$ - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "AccountInstance". - --Identity $AccountInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - By default, this cmdlet has the -Confirm parameter set, which prompts you to confirm before a removal of the specified object type can occur. -To bypass prompting for confirmation before removal, you can specify -Confirm:$false when using this cmdlet. - -## RELATED LINKS - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Install-ADServiceAccount](./Install-ADServiceAccount.md) - -[New-ADServiceAccount](./New-ADServiceAccount.md) - -[Set-ADServiceAccount](./Set-ADServiceAccount.md) - -[Uninstall-ADServiceAccount](./Uninstall-ADServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Remove-ADUser.md b/docset/winserver2012-ps/activedirectory/Remove-ADUser.md deleted file mode 100644 index 05c491f2d2..0000000000 --- a/docset/winserver2012-ps/activedirectory/Remove-ADUser.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/remove-aduser?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADUser - -## SYNOPSIS -Removes an Active Directory user. - -## SYNTAX - -``` -Remove-ADUser [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Identity] - [-Partition ] [-Server ] [] -``` - -## DESCRIPTION -The **Remove-ADUser** cmdlet removes an Active Directory user. - -The *Identity* parameter specifies the Active Directory user to remove. -You can identify a user by its distinguished name (DN), GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also set the *Identity* parameter to a user object variable, such as `$`, or you can pass a user object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADUser** cmdlet to retrieve a user object and then pass the object through the pipeline to the Remove-ADUser cmdlet. - -If the **ADUser** is being identified by its DN, the *Partition* parameter will be automatically determined. - -For AD LDS environments, the *Partition* parameter must be specified except in the following two conditions: - -- The cmdlet is run from an Active Directory provider drive. -- A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. - -## EXAMPLES - -### Example 1: Remove a specified user -```powershell -PS C:\> Remove-ADUser -Identity GlenJohn -``` - -This command removes the user with SAM account name GlenJohn. - -### Example 2: Remove a filtered list of users -```powershell -PS C:\> Search-ADAccount -AccountDisabled | where {$_.ObjectClass -eq 'user'} | Remove-ADUser -``` - -This command searches for any users that have disabled accounts and removes them. - -### Example 3: Remove a user by distinguished name -```powershell -PS C:\> Remove-ADUser -Identity "CN=Glen John,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -This command removes the user with the distinguished name CN=Glen John,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### Example 4: Get a user by distinguished name and remove it -```powershell -PS C:\> Get-ADUser -Identity "cn=glenjohn,dc=appnc" -Server Lds.Fabrikam.com:50000 | Remove-ADUser -``` - -This command gets the user with the distinguished name cn=glenjohn,dc=appnc from the AD LDS instance and removes it. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory user object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: - -- A Distinguished name -- A GUID (objectGUID) -- A Security Identifier (objectSid) -- A SAM account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADUser -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value will be used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for *Partition* will be set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* will be set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent (DSA) object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. - -Specify the AD DS instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADUser -A user object is received by the *Identity* parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. -* This cmdlet does not work with a read-only domain controller. -* By default, this cmdlet prompts for confirmation as it is defined with **High impact** and the default value of the **$ConfirmPreference** variable is **High**. To bypass prompting for confirmation before removal, you can specify `-Confirm:$False` when using this cmdlet. - -## RELATED LINKS - -[Get-ADUser](./Get-ADUser.md) - -[New-ADUser](./New-ADUser.md) - -[Set-ADUser](./Set-ADUser.md) - diff --git a/docset/winserver2012-ps/activedirectory/Rename-ADObject.md b/docset/winserver2012-ps/activedirectory/Rename-ADObject.md deleted file mode 100644 index 33c45ffa8b..0000000000 --- a/docset/winserver2012-ps/activedirectory/Rename-ADObject.md +++ /dev/null @@ -1,410 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/rename-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-ADObject - -## SYNOPSIS -Changes the name of an Active Directory object. - -## SYNTAX - -``` -Rename-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-NewName] [-Partition ] [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Rename-ADObject cmdlet renames an Active Directory object. -This cmdlet sets the Name property of an Active Directory object that has an LDAP Display Name (ldapDisplayName) of "name". -To modify the given name, surname and other name of a user, use the Set-ADUser cmdlet. -To modify the Security Accounts Manager (SAM) account name of a user, computer, or group, use the Set-ADUser, Set-ADComputer or Set-ADGroup cmdlet. - -The Identity parameter specifies the object to rename. -You can identify an object or container by its distinguished name (DN) or GUID. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADObject cmdlet to retrieve an object and then pass the object through the pipeline to the Rename-ADObject cmdlet. -You can also use the Get-ADGroup, Get-ADUser, Get-ADComputer, Get-ADServiceAccount, Get-ADOrganizationalUnit and Get-ADFineGrainedPasswordPolicy cmdlets to get an object that you can pass through the pipeline to this cmdlet. - -The NewName parameter defines the new name for the object and must be specified. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Rename-ADObject -Identity "CN=HQ,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM" -NewName UnitedKingdomHQ -``` - -Description - ------------ - -Rename the name of an existing site 'HQ' to the new name 'UnitedKingdomHQ'. -If the distinguished name is provided in the -Identity parameter, then the -Partition parameter is not required. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Rename-ADObject -Identity "4777c8e8-cd29-4699-91e8-c507705a0966" -NewName "AmsterdamHQ" -Partition "CN=Configuration,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Rename the object with objectGUID '4777c8e8-cd29-4699-91e8-c507705a096'6 to 'SiteNewName'. -Note -Partition parameter is required because the Naming Context of the site object is not known from the GUID provided to the -Identity parameter. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Rename-ADObject "OU=ManagedGroups,OU=Managed,DC=Fabrikam,DC=Com" -NewName Groups -``` - -Description - ------------ - -Rename the object with the DistinguishedName 'OU=ManagedGroups,OU=Managed,DC=Fabrikam,DC=Com' to 'Groups'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Rename-ADObject -Identity "4777c8e8-cd29-4699-91e8-c507705a0966" -NewName "DavidAhs" -``` - -Description - ------------ - -Rename the object with objectGUID '4777c8e8-cd29-4699-91e8-c507705a0966' to 'DavidAhs'. -Note that the -Partition parameter is not specified because the object is in the Default Naming Context of the domain. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Rename-ADObject "CN=Apps,DC=AppNC" -NewName "InternalApps" -server "FABRIKAM-SRV1:60000" -``` - -Description - ------------ - -Rename the container 'CN=Apps,DC=AppNC' to 'InternalApps' in an LDS instance. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --NewName "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -An Active Directory object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[Move-ADObject](./Move-ADObject.md) - -[New-ADObject](./New-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - -[Restore-ADObject](./Restore-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - - - diff --git a/docset/winserver2012-ps/activedirectory/Reset-ADServiceAccountPassword.md b/docset/winserver2012-ps/activedirectory/Reset-ADServiceAccountPassword.md deleted file mode 100644 index 812acef98e..0000000000 --- a/docset/winserver2012-ps/activedirectory/Reset-ADServiceAccountPassword.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/reset-adserviceaccountpassword?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-ADServiceAccountPassword - -## SYNOPSIS -Resets the password for a standalone managed service account. -Reset is not supported for group managed service accounts. - -## SYNTAX - -``` -Reset-ADServiceAccountPassword [-WhatIf] [-Confirm] [-AuthType ] [-Identity] - [-Partition ] [] -``` - -## DESCRIPTION -The Reset-ADServiceAccountPassword cmdlet resets the password for the standalone managed service account (MSA) on the local computer. -This cmdlet needs to be run on the computer where the standalone MSA is installed. - -The Identity parameter specifies the Active Directory standalone MSA that receives the password reset. -You can identify a MSA by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to a MSA object variable, such as $\, or pass a MSA object through the pipeline to the Identity parameter. -For example, you can use the Get-ADServiceAccount cmdlet to retrieve a standalone MSA object and then pass the object through the pipeline to the Reset-ADServiceAccountPassword cmdlet. - -Note: When you reset the password for a computer, you also reset all of the standalone MSA passwords for that computer. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Reset-ADServiceAccountPassword ServiceAccount1 -``` - -Description - ------------ - -Reset the password on the standalone managed service account 'ServiceAccount1' - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: WebAccount$ - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "AccountInstance". - --Identity $AccountInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Restore-ADObject.md b/docset/winserver2012-ps/activedirectory/Restore-ADObject.md deleted file mode 100644 index bdbabb82a6..0000000000 --- a/docset/winserver2012-ps/activedirectory/Restore-ADObject.md +++ /dev/null @@ -1,433 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/restore-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-ADObject - -## SYNOPSIS -Restores an Active Directory object. - -## SYNTAX - -``` -Restore-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-NewName ] [-Partition ] [-PassThru] [-Server ] - [-TargetPath ] [] -``` - -## DESCRIPTION -The Restore-ADObject cmdlet restores a deleted Active Directory object. - -The NewName parameter specifies the new name for the restored object. -If the NewName parameter is not specified, the value of the Active Directory attribute with an LDAP display name of "msDS-lastKnownRDN" is used. -The TargetPath parameter specifies the new location for the restored object. -If the TargetPath is not specified, the value of the Active Directory attribute with an LDAP display name of "lastKnownParent" is used. - -The Identity parameter specifies the Active Directory object to restore. -You can identify an object by its distinguished name (DN) or GUID. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADObject cmdlet to retrieve a deleted object by specifying the IncludeDeletedObjects parameter. -You can then pass the object through the pipeline to the Restore-ADObject cmdlet. - -Note: You can get the distinguished names of deleted objects by using the Get-ADObject cmdlet with the -IncludedeDeletedObjects parameter specified. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Restore-ADObject -Identity "613dc90a-2afd-49fb-8bd8-eac48c6ab59f" -NewName "Kim Abercrombie" -TargetPath "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Restores the ADObject while setting the 'msDS-LastKnownRDN' attribute of the deleted object to -NewName parameter and setting the 'lastKnownRDN' to the -TargetPath parameter. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Restore-ADObject -Identity "CN=Kim Abercrombie\0ADEL:613dc90a-2afd-49fb-8bd8-eac48c6ab59f,CN=Deleted Objects,DC=FABRIKAM,DC=COM" -NewName "Kim Abercrombie" -TargetPath "OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Restores the ADObject while setting the 'msDS-LastKnownRDN' attribute of the deleted object to -NewName parameter and setting the 'lastKnownRDN' to the -TargetPath parameter. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADObject -Filter 'samaccountname -eq "kimabercrombie"' -IncludeDeletedObjects | Restore-ADObject -``` - -Description - ------------ - -Find a deleted user whose samaccountname is kimabercrombie, and restore it. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Restore-ADObject -Identity '6bb3bfe9-4355-48ee-b3b6-4fda6917d31d' -Server server1:50000 -``` - -Description - ------------ - -Restore an AD-LDS object using ObjectGUID. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-ADObject -Filter 'msds-lastknownrdn -eq "user1"' -Server server1:50000 -IncludeDeletedObjects -SearchBase "o=app1,c=us" | Restore-ADObject -``` - -Description - ------------ - -Restore an AD-LDS object using msds-LastKnownRDN. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name of the object. -This parameter sets the Name property of the Active Directory object. -The LDAP Display Name (ldapDisplayName) of this property is "name". - -The following example shows how to set this parameter to a name string. - --NewName "SaraDavis" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPath -Specifies the new location for the object. -This location must be the path to a container or organizational unit. - -The following example shows how to specify a target path by providing the distinguished name. - --TargetPath "ou=sales,dc=corp,dc=contoso,dc=com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -An Active Directory object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -Returns the restored object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[Move-ADObject](./Move-ADObject.md) - -[New-ADObject](./New-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - -[Rename-ADObject](./Rename-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - - - diff --git a/docset/winserver2012-ps/activedirectory/Search-ADAccount.md b/docset/winserver2012-ps/activedirectory/Search-ADAccount.md deleted file mode 100644 index 732babed8c..0000000000 --- a/docset/winserver2012-ps/activedirectory/Search-ADAccount.md +++ /dev/null @@ -1,631 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/search-adaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Search-ADAccount - -## SYNOPSIS -Gets Active Directory user, computer, or service accounts. - -## SYNTAX - -### AccountDisabled -``` -Search-ADAccount [-AccountDisabled] [-AuthType ] [-ComputersOnly] [-Credential ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [-UsersOnly] [] -``` - -### AccountExpired -``` -Search-ADAccount [-AccountExpired] [-AuthType ] [-ComputersOnly] [-Credential ] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [-UsersOnly] [] -``` - -### AccountExpiring -``` -Search-ADAccount [-AccountExpiring] [-AuthType ] [-ComputersOnly] [-Credential ] - [-DateTime ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [-TimeSpan ] [-UsersOnly] [] -``` - -### AccountInactive -``` -Search-ADAccount [-AccountInactive] [-AuthType ] [-ComputersOnly] [-Credential ] - [-DateTime ] [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] - [-SearchScope ] [-Server ] [-TimeSpan ] [-UsersOnly] [] -``` - -### LockedOut -``` -Search-ADAccount [-AuthType ] [-ComputersOnly] [-Credential ] [-LockedOut] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [-UsersOnly] [] -``` - -### PasswordExpired -``` -Search-ADAccount [-AuthType ] [-ComputersOnly] [-Credential ] [-PasswordExpired] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [-UsersOnly] [] -``` - -### PasswordNeverExpires -``` -Search-ADAccount [-AuthType ] [-ComputersOnly] [-Credential ] [-PasswordNeverExpires] - [-ResultPageSize ] [-ResultSetSize ] [-SearchBase ] [-SearchScope ] - [-Server ] [-UsersOnly] [] -``` - -## DESCRIPTION -The Search-ADAccount cmdlet retrieves one or more user, computer, or service accounts that meet the criteria specified by the parameters. -Search criteria include account and password status. -For example, you can search for all accounts that have expired by specifying the AccountExpired parameter. -Similarly, you can search for all accounts with an expired password by specifying the PasswordExpired parameter. -You can limit the search to user accounts by specifying the UsersOnly parameter. -Similarly, when you specify the ComputersOnly parameter, the cmdlet only retrieves computer accounts. - -Some search parameters, such as AccountExpiring and AccountInactive use a default time that you can change by specifying the DateTime or TimeSpan parameter. -The DateTime parameter specifies a distinct time. -The TimeSpan parameter specifies a time range from the current time. -For example, to search for all accounts that expire in 10 days, specify the AccountExpiring and TimeSpan parameter and set the value of TimeSpan to "10.00:00:00". -To search for all accounts that expire before December 31, 2012, set the DateTime parameter to "12/31/2012". - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Search-ADAccount -AccountDisabled | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -Guest user -krbtgt user -krbtgt_51399 user -AmyAl-LPTOP computer -DeepakAn-DSKTOP computer -``` - -Description - ------------ - -Returns all users, computers and service accounts that are disabled. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Search-ADAccount -AccountDisabled -UsersOnly | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -Guest user -krbtgt user -krbtgt_51399 user -``` - -Description - ------------ - -Returns all users that are disabled. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Search-ADAccount -AccountExpired | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -Greg Chapman user -Claus Hansen user -Tomasz Bochenek user -``` - -Description - ------------ - -Returns all users, computers and service accounts that are expired. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Search-ADAccount -AccountExpiring -TimeSpan 6.00:00:00 | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -Iulian Calinov user -John Campbell user -Garth Fort user -``` - -Description - ------------ - -Returns all users, computers and service accounts that will expire in the next 6 days. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Search-ADAccount -AccountInactive -TimeSpan 90.00:00:00 | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -FABRIKAM-RODC1 computer -Guest user -krbtgt user -krbtgt_51399 user -Almudena Benito user -Aaron Con user -Adina Hagege user -Aaron Nicholls user -Aaron M. Painter user -Jeff Phillips user -Flemming Pedersen use -``` - -Description - ------------ - -Returns all accounts that have been inactive for the last 90 days. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Search-ADAccount -PasswordExpired | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -Stan Orme user -Danni Ortman user -Matej Potokar user -``` - -Description - ------------ - -Returns all accounts where the password has expired. - -### -------------------------- EXAMPLE 7 -------------------------- -``` -C:\PS>Search-ADAccount -PasswordNeverExpires | FT Name,ObjectClass -A - - -Name ObjectClass ----- ----------- -Guest user -Toni Poe user -Anders Riis user -Fabien Hernoux user -``` - -Description - ------------ - -Returns all accounts with a password that will never expire. - -### -------------------------- EXAMPLE 8 -------------------------- -``` -C:\PS>Search-ADAccount -LockedOut | FT Name,ObjectClass -A - -Name ObjectClass ----- ----------- -Toni Poe user -``` - -Description - ------------ - -Returns all accounts that have been locked out. - -### -------------------------- EXAMPLE 9 -------------------------- -``` -C:\PS>Search-ADAccount -AccountDisabled -ComputersOnly | FT Name,ObjectClass -A - -Name ObjectClass ----- ----------- -TPOE-PC1 computer -``` - -Description - ------------ - -Returns all disabled computer accounts. - -### -------------------------- EXAMPLE 10 -------------------------- -``` -C:\PS>Search-ADAccount -AccountExpiring -DateTime "3/18/2009" | FT Name,ObjectClass -A - -Name ObjectClass ----- ----------- -Anders Riis user -``` - -Description - ------------ - -Returns all accounts which expire on the 18th of March, 2009. - -### -------------------------- EXAMPLE 11 -------------------------- -``` -C:\PS>Search-AdAccount -AccountDisabled -SearchBase "DC=AppNC" -Server "FABRIKAM-SRV1:60000" - -Enabled : False -Name : SanjayPatel -UserPrincipalName : -PasswordNeverExpires : -LockedOut : False -ObjectGUID : d671de28-6e40-42a7-b32c-63d336de296d -ObjectClass : user -SID : S-1-510474493-936115905-2231798853-1260534229-4171027843-767619944 -PasswordExpired : False -LastLogonDate : -DistinguishedName : CN=SanjayPatel,OU=AccountDeptOU,DC=AppNC -AccountExpirationDate : -``` - -Description - ------------ - -Returns all users, computers and service accounts that are disabled in the LDS instance: "FABRIKAM-SRV1:60000". - -## PARAMETERS - -### -AccountDisabled -Returns account objects that are disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: AccountDisabled -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountExpired -Returns account objects that are expired. - -```yaml -Type: SwitchParameter -Parameter Sets: AccountExpired -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountExpiring -Returns account objects that will expire in the specified TimeSpan. - -```yaml -Type: SwitchParameter -Parameter Sets: AccountExpiring -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountInactive -Returns all accounts that have been inactive in the specified TimeSpan. - -```yaml -Type: SwitchParameter -Parameter Sets: AccountInactive -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -The type of authentication to run the cmdlet. Allowed values are -Negotiate -Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputersOnly -Limits the search only to computer objects. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -PSCredential object representing the credentials of the user to use to run the cmdlet. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateTime -Enter a DateTime object, such as one that the Get-Date cmdlet returns, or a string that can be converted to a date and time, such as "April 19, 2012 15:00", "12/31", or "3am". DateTime objects, and strings that are converted to DateTime objects, are automatically adjusted to be compatible with the date and time formats selected for the local computer in Region and Language in Control Panel. - -```yaml -Type: DateTime -Parameter Sets: AccountExpiring, AccountInactive -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockedOut -Returns all account objects that have been locked out. - -```yaml -Type: SwitchParameter -Parameter Sets: LockedOut -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordExpired -Returns all account objects that have expired password. - -```yaml -Type: SwitchParameter -Parameter Sets: PasswordExpired -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNeverExpires -Returns all account objects which password never expires. - -```yaml -Type: SwitchParameter -Parameter Sets: PasswordNeverExpires -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultPageSize -Specifies the number of objects to include in one page for an Active Directory Domain Services query. - -The default is 256 objects per page. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResultSetSize -Specifies the maximum number of objects to return for an Active Directory Domain Services query. If you want to receive all of the objects, set this parameter to $Null (null value). You can use Ctrl+C to stop the query and return of objects. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchBase -Specifies an Active Directory path to search under. - -When you run a cmdlet from an Active Directory provider drive, the default value of this parameter is the current path of the drive. - -When you run a cmdlet outside of an Active Directory provider drive against an AD DS target, the default value of this parameter is the default naming context of the target domain. - -When you run a cmdlet outside of an Active Directory provider drive against an AD LDS target, the default value is the default naming context of the target LDS instance if one has been specified by setting the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. If no default naming context has been specified for the target AD LDS instance, then this parameter has no default value. - -When the value of the SearchBase parameter is set to an empty string and you are connected to a GC port, all partitions will be searched. If the value of the SearchBase parameter is set to an empty string and you are not connected to a GC port, an error will be thrown. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SearchScope -Specifies the scope of an Active Directory search. -The acceptable values for this parameter are: - -- Base or 0 -- OneLevel or 1 -- Subtree or 2 - -A Base query searches only the current path or object. -A OneLevel query searches the immediate children of that path or object. -A Subtree query searches the current path or object and all children of that path or object. - -```yaml -Type: ADSearchScope -Parameter Sets: (All) -Aliases: -Accepted values: Base, OneLevel, Subtree - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -- Fully qualified domain name (FQDN) -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for the *Server* parameter is determined by one of the following methods in the order that they are listed: - -- By using *Server* value from objects passed through the pipeline. -- By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. -- By using the domain of the computer running PowerShell. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeSpan -Enter a timespan object, such as one that the New-TimeSpan cmdlet returns or a string that can be converted to a timespan object, such as "30:00:00". - -```yaml -Type: TimeSpan -Parameter Sets: AccountExpiring, AccountInactive -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsersOnly -Limits the search to only user objects. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -Returns one or more account objects that meet the conditions set by the parameters. - -## NOTES - -## RELATED LINKS - -[Clear-ADAccountExpiration](./Clear-ADAccountExpiration.md) - -[Disable-ADAccount](./Disable-ADAccount.md) - -[Enable-ADAccount](./Enable-ADAccount.md) - -[Get-ADAccountResultantPasswordReplicationPolicy](./Get-ADAccountResultantPasswordReplicationPolicy.md) - -[Set-ADAccountControl](./Set-ADAccountControl.md) - -[Set-ADAccountExpiration](./Set-ADAccountExpiration.md) - -[Set-ADAccountPassword](./Set-ADAccountPassword.md) - -[Unlock-ADAccount](./Unlock-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADAccountControl.md b/docset/winserver2012-ps/activedirectory/Set-ADAccountControl.md deleted file mode 100644 index 0cc10da091..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADAccountControl.md +++ /dev/null @@ -1,721 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adaccountcontrol?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADAccountControl - -## SYNOPSIS -Modifies user account control (UAC) values for an Active Directory account. - -## SYNTAX - -``` -Set-ADAccountControl [-WhatIf] [-Confirm] [-AccountNotDelegated ] - [-AllowReversiblePasswordEncryption ] [-AuthType ] [-CannotChangePassword ] - [-Credential ] [-DoesNotRequirePreAuth ] [-Enabled ] - [-HomedirRequired ] [-Identity] [-MNSLogonAccount ] [-Partition ] - [-PassThru] [-PasswordNeverExpires ] [-PasswordNotRequired ] [-Server ] - [-TrustedForDelegation ] [-TrustedToAuthForDelegation ] [-UseDESKeyOnly ] - [] -``` - -## DESCRIPTION -The Set-ADAccountControl cmdlet modifies the user account control (UAC) values for an Active Directory user or computer account. -UAC values are represented by cmdlet parameters. -For example, set the PasswordExpired parameter to change whether an account is expired and to modify the ADS_UF_PASSWORD_EXPIRED UAC value. - -The Identity parameter specifies the Active Directory account to modify. - -You can identify an account by its distinguished name (DN), GUID, security identifier (SID) or security accounts manager (SAM) account name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an account object through the pipeline to the Identity parameter. -For example, you can use the Search-ADAccount cmdlet to retrieve an account object and then pass the object through the pipeline to the Set-ADAccountControl cmdlet. -Similarly, you can use Get-ADUser, Get-ADComputer or Get-ADServiceAccount cmdlets to retrieve account objects that you can pass through the pipeline to this cmdlet. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADAccountControl JimmyBi -PasswordNotRequired $false -``` - -Description - ------------ - -Sets the flag on userAccountControl to make sure that a password is required for logon. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADAccountControl 'CN=Jimmy Bischoff,OU=HumanResources,OU=UserAccounts,DC=FABRIKAM,DC=COM' -CannotChangePassword $true -``` - -Description - ------------ - -Sets the security descriptor of the user to make sure they cannot change their own password. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-ADAccountControl SQLAdmin1 -AccountNotDelegated $true -``` - -Description - ------------ - -Sets the flag on userAccountControl to make sure that the account cannot be delegated. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Set-ADAccountControl 'CN=IIS01 SvcAccount,OU=ServiceAccounts,OU=Managed,DC=FABRIKAM,DC=COM' -TrustedToAuthForDelegation $true -``` - -Description - ------------ - -Sets the flag on userAccountControl to make sure that the account is now trusted to authenticate for delegation. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Set-ADAccountControl -Identity "FABRIKAM-SRV1" -TrustedForDelegation $true -``` - -Description - ------------ - -The specified computer is now set to be trusted for delegation. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>Set-ADAccountControl DickBe -PasswordNeverExpires $true -``` - -Description - ------------ - -Sets the password of the user to never expire. - -### -------------------------- EXAMPLE 7 -------------------------- -``` -C:\PS>Set-ADAccountControl 'CN=Dick Beekman,OU=HumanResources,OU=UserAccounts,DC=FABRIKAM,DC=COM' -HomedirRequired $true -``` - -Description - ------------ - -Sets the user account to require a Home Directory. - -## PARAMETERS - -### -AccountNotDelegated -Specifies whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the AccountNotDelegated property for an Active Directory account. -This parameter also sets the ADS_UF_NOT_DELEGATED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the security context of the account is not delegated to a service. - --AccountNotDelegated $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowReversiblePasswordEncryption -Specifies whether reversible password encryption is allowed for the account. -This parameter sets the AllowReversiblePasswordEncryption property of the account. -This parameter also sets the ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --AllowReversiblePasswordEncryption $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CannotChangePassword -Modifies the ability of an account to change its password. -To disallow password change by the account set this to $true.. -This parameter changes the Boolean value of the CannotChangePassword property of an account. - -The following example shows how to specify the PasswordCannotChange parameter. - --CannotChangePassword $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoesNotRequirePreAuth -Specifies whether Kerberos pre-authentication is required to logon using the user or computer account. -This parameter sets the ADS_UF_DONT_REQUIRE_PREAUTH flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that Kerberos pre-authentication is required to logon to the account. - --DoesNotRequirePreAuth $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies if an account is enabled. -An enabled account requires a password. -This parameter sets the Enabled property for an account object. -This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to enable the account. - --Enabled $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomedirRequired -Specifies whether a home directory is required for the account. -This parameter sets the ADS_UF_HOMEDIR_REQUIRED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that a home directory is not required for the account. - --HomedirRequired $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute.4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MNSLogonAccount -Specifies whether the account is a Majority Node Set (MNS) logon account. -This parameter also sets the ADS_UF_MNS_LOGON_ACCOUNT flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -You can use MNS logon accounts to configure a multi-node cluster without using a shared disk drive. - -The following example shows how to set this parameter to identify this account as an MNS account. - --MSNLogonAccount $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNeverExpires -Specifies whether the password of an account can expire. -This parameter sets the PasswordNeverExpires property of an account object. -This parameter also sets the ADS_UF_DONT_EXPIRE_PASSWD flag of the Active Directory User Account Control attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -Note: This parameter cannot be set to $true or 1 for an account that also has the ChangePasswordAtLogon property set to true. - -The following example shows how to set this parameter so that the password can expire. - --PasswordNeverExpires $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNotRequired -Specifies whether the account requires a password. -This parameter sets the PasswordNotRequired property of an account, such as a user or computer account. -This parameter also sets the ADS_UF_PASSWD_NOTREQD flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that as password is not required for the account. - --PasswordNotRequired $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the TrustedForDelegation property of an account object. -This value also sets the ADS_UF_TRUSTED_FOR_DELEGATION flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account is trusted for Kerberos delegation. - --TrustedForDelegation $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedToAuthForDelegation -Specifies whether an account is enabled for delegation. -When this parameter is set to true, a service running under such an account can impersonate a client on other remote servers on the network. -This parameter sets the ADS_UF_TRUSTED_TO_AUTHENTICATE_FOR_DELEGATION flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the account is enabled for delegation. - --TrustedToAuthForDelegation $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDESKeyOnly -Specifies whether an account is restricted to use only Data Encryption Standard (DES) encryption types for keys. -This parameter sets the - -ADS_UF_USE_DES_KEY_ONLY flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that an account must use DES encryption types for keys. - --UseDESKeyOnly $true - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work when connected to Global Catalog port. - -## RELATED LINKS - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Get-ADUser](./Get-ADUser.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADAccountExpiration.md b/docset/winserver2012-ps/activedirectory/Set-ADAccountExpiration.md deleted file mode 100644 index ad10a9fa76..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADAccountExpiration.md +++ /dev/null @@ -1,461 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adaccountexpiration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADAccountExpiration - -## SYNOPSIS -Sets the expiration date for an Active Directory account. - -## SYNTAX - -``` -Set-ADAccountExpiration [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [[-DateTime] ] [-Identity] [-Partition ] [-PassThru] [-Server ] - [-TimeSpan ] [] -``` - -## DESCRIPTION -The Set-ADAccountExpiration cmdlet sets the expiration time for a user, computer or service account. -To specify an exact time, use the DateTime parameter. -To specify a time period from the current time, use the TimeSpan parameter. - -The Identity parameter specifies the Active Directory account to modify. - -You can identify an account by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an account object through the pipeline to the Identity parameter. -For example, you can use the Search-ADAccount cmdlet to retrieve an account object and then pass the object through the pipeline to the Set-ADAccountExpiration cmdlet. -Similarly, you can use Get-ADUser, Get-ADComputer or Get-ADServiceAccount cmdlets to retrieve account objects that you can pass through the pipeline to this cmdlet. - -For AD LDS environments, the Partition parameter must be specified except in the following two conditions: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADAccountExpiration KarenBe -DateTime "10/18/2008" -``` - -Description - ------------ - -Sets the account with SamAccountName: KarenBe to expire on the 18th of October, 2008. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADGroupMember BO1Accounts | where {$_.objectClass -eq "user"} | Set-ADAccountExpiration -timespan 60.0:0 -``` - -Description - ------------ - -Sets the expiration date of all the user accounts who are a member of the group: BO1Accounts to 60 days from now. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateTime -Species the expiration time for the account by using a DateTime value. -The following examples show commonly-used syntax to specify a DateTime value. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. - -"4/17/2006" - -"Monday, April 17, 2006" - -"2:22:45 PM" - -"Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -"4/17/2006 2:22 PM" - -"Monday, April 17, 2006 2:22 PM" - -"2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - -"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - -"2000-04-17T14:22:48.0000000" - -The following example shows how to set the DateTime parameter to June 18, 2012 at 2:00:00 AM. - --DateTime "6/18/2012 2:00:00 AM" - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeSpan -Specifies a time interval that begins at the current time. -The account expires at the end of the time interval. - -Specify the time interval in the following format. - -\[-\]D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: - --10675199:02:48:05.4775808 and 10675199:02:48:05.4775807. - -The following examples show how to set this parameter. - -Set the time to 2 days - --TimeSpan "2" - -Set the time to 4 hours - --TimeSpan "4:00" - -Set the time to 5 minutes - --TimeSpan "0:5" - -Set the time to 45 seconds - --TimeSpan "0:0:45" - -For example, to set an account to expire in 10 days, specify the TimeSpan parameter as follows. - --TimeSpan "10" - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Clear-ADAccountExpiration](./Clear-ADAccountExpiration.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Get-ADUser](./Get-ADUser.md) - -[Search-ADAccount](./Search-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADAccountPassword.md b/docset/winserver2012-ps/activedirectory/Set-ADAccountPassword.md deleted file mode 100644 index 61f2914986..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADAccountPassword.md +++ /dev/null @@ -1,461 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adaccountpassword?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADAccountPassword - -## SYNOPSIS -Modifies the password of an Active Directory account. - -## SYNTAX - -``` -Set-ADAccountPassword [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-NewPassword ] [-OldPassword ] [-Partition ] - [-PassThru] [-Reset] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADAccountPassword cmdlet sets the password for a user, computer or service account. - -The Identity parameter specifies the Active Directory account to modify. - -You can identify an account by its distinguished name (DN), GUID, security identifier (SID) or security accounts manager (SAM) account name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Search-ADAccount cmdlet to retrieve an account object and then pass the object through the pipeline to the Set-ADAccountPassword cmdlet. -Similarly, you can use Get-ADUser, Get-ADComputer or Get-ADServiceAccount, for standalone MSAs, cmdlets to retrieve account objects that you can pass through the pipeline to this cmdlet. - -Note: Group MSAs cannot set password since they are changed at predetermined intervals. - -For Active Directory Lightweight Directory Services (AD LDS) environments, the Partition parameter must be specified except in the following two instances: - --The cmdlet is run from an Active Directory provider drive. - --A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADAccountPassword 'CN=Jeremy Los,OU=Accounts,DC=Fabrikam,DC=com' -Reset -NewPassword (ConvertTo-SecureString -AsPlainText "p@ssw0rd" -Force) -``` - -Description - ------------ - -Sets the password of the user account with DistinguishedName: 'CN=Jeremy Los,OU=Accounts,DC=Fabrikam,DC=com' to 'p@ssw0rd'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADAccountPassword -Identity tmakovec -OldPassword (ConvertTo-SecureString -AsPlainText "p@ssw0rd" -Force) -NewPassword (ConvertTo-SecureString -AsPlainText "qwert@12345" -Force) -``` - -Description - ------------ - -Sets the password of the user account with SamAccountName: tmakovec to 'qwert@12345'. -Using -NewPassword with a value, without providing an -OldPassword parameter value, will also reset the password. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-ADAccountPassword -Identity saradavi - -Please enter the current password for 'CN=Sara Davis,CN=Users,DC=Fabrikam,DC=com' -Password:********** -Please enter the desired password for 'CN=Sara Davis,CN=Users,DC=Fabrikam,DC=com' -Password:*********** -Repeat Password:*********** -``` - -Description - ------------ - -Sets the password of the user account with DistinguishedName: 'CN=Sara Davis,CN=Users,DC=Fabrikam,DC=com' (user is prompted for old and new password). - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$newPassword = (Read-Host -Prompt "Provide New Password" -AsSecureString); Set-ADAccountPassword -Identity mollyd -NewPassword $newPassword -Reset - -Provide New Password: ********** -``` - -Description - ------------ - -Prompts the user for a new password that is stored in a temporary variable named $newPassword, then uses it to reset the password for the user account with SamAccountName: mollyd. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -PS C:\Users\administrator.FABRIKAM> set-adaccountpassword "CN=Molly Dempsey,OU=AccountDeptOU,DC=AppNC" -server "dsp13a24:60000" - - -Please enter the current password for 'CN=mollyd,OU=AccountDeptOU,DC=AppNC' -Password:********** -Please enter the desired password for 'CN=mollyd,OU=AccountDeptOU,DC=AppNC' -Password:********** -Repeat Password:********** -``` - -Description - ------------ - -Sets the password of the user account with DistinguishedName: 'CN=mollyd,OU=AccountDeptOU,DC=AppNC' in the AD LDS instance: "dsp13a24:60000" (user is prompted for old and new password). - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory user object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM account name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=SaraDavis,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a user object instance named "userInstance". - --Identity $userInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewPassword -Specifies a new password value. -This value is stored as an encrypted string. - -The following example shows how to set this parameter. -This command will prompt you and wait for a password. - --NewPassword (Read-Host -AsSecureString "New Password") - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OldPassword -Specifies the most recent password value. -This value is processed as a encrypted string. - -The following example shows how to set this parameter. -This command will prompt you and wait for a password. - --OldPassword (Read-Host -AsSecureString "Old Password") - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reset -Specifies to reset the password on an account. -When you use this parameter, you must set the NewPassword parameter. -You do not need to specify the OldPassword parameter. - -The following example shows how to use this parameter to set a new password. -This command will prompt you then wait for a password. - --Reset -NewPassword (Read-Host -AsSecureString "New Password") - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The WhatIf switch causes the command to simulate its results. Using this switch allows you to view changes that would occur, without having to commit those changes. - -> [!NOTE] -> -WhatIf command functionality was first fixed in the Windows 1607 RSAT package. If using an RSAT package prior to the Windows 1607 RSAT package, this parameter will not function. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. -This cmdlet does not work when connected to Global Catalog port. - -## RELATED LINKS - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Get-ADUser](./Get-ADUser.md) - -[Search-ADAccount](./Search-ADAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessPolicy.md b/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessPolicy.md deleted file mode 100644 index 2de31d785f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessPolicy.md +++ /dev/null @@ -1,490 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adcentralaccesspolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADCentralAccessPolicy - -## SYNOPSIS -Modifies a central access policy in Active Directory. - -## SYNTAX - -### Identity -``` -Set-ADCentralAccessPolicy [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-Description ] [-Identity] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Remove ] [-Replace ] [-Server ] - [] -``` - -### Instance -``` -Set-ADCentralAccessPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADCentralAccessPolicy cmdlet can be used to modify a central access policy in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADCentralAccessPolicy "Finance Policy" -Description "For the Finance Department." -``` - -Description - ------------ - -Updates the central access policy named "Finance Policy" to include the description "For the Finance Department." - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADCentralAccessPolicy "Finance Policy" | Set-ADCentralAccessPolicy -Description "For the Finance Department." -``` - -Description - ------------ - -Gets the central access policy named "Finance Policy", and then sets its description to "For the Finance Department." - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Policy,CN=Central Access Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of a central access policy object to use to update the actual central access policy object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding central access policy object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update central access policy objects that have been retrieved by using the Get-ADCentralAccessPolicy cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADCentralAccessPolicy cmdlet to retrieve an instance of the object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADCentralAccessPolicy cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$objectInstance = Get-ADCentralAccessPolicy -Identity "Finance Policy" - -Step 2: Modify one or more properties of the object instance. - -$objectInstance.Description = "For finance only." - -Step3: Save your changes to the object - -Set-ADCentralAccessPolicy -Instance $objectInstance - -```yaml -Type: ADCentralAccessPolicy -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -A ADCentralAccessPolicy object is received by the Identity parameter. - -A ADCentralAccessPolicy object that was retrieved by using the Get-ADCentralAccessPolicy cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicy -Returns the modified ADCentralAccessPolicy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md b/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md deleted file mode 100644 index 595d89790f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADCentralAccessRule.md +++ /dev/null @@ -1,584 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adcentralaccessrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADCentralAccessRule - -## SYNOPSIS -Modifies a central access rule in Active Directory. - -## SYNTAX - -### Identity -``` -Set-ADCentralAccessRule [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-CurrentAcl ] [-Description ] [-Identity] - [-PassThru] [-ProposedAcl ] [-ProtectedFromAccidentalDeletion ] [-Remove ] - [-Replace ] [-ResourceCondition ] [-Server ] [] -``` - -### Instance -``` -Set-ADCentralAccessRule [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADCentralAccessRule cmdlet can be used to modify a central access rule in a central access policy that is stored in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$departmentResourceProperty = Get-ADResourceProperty Department -$resourceCondition = "(@RESOURCE." + $departmentResourceProperty.Name + " Contains {`"Finance`"})" -Set-ADCentralAccessRule "Finance Documents Rule" -ResourceCondition $resourceCondition -``` - -Description - ------------ - -Set the central access rule named "Finance Documents Rule" with a new resource condition. -The resource condition scopes the resources to ones containing the value 'Finance' in their 'Department' resource property. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$countryClaimType = Get-ADClaimType Country; -$departmentClaimType = Get-ADClaimType Department; -$countryResourceProperty = Get-ADResourceProperty Country; -$departmentResourceProperty = Get-ADResourceProperty Department; -$financeException = Get-ADGroup FinanceException; -$financeAdmin = Get-ADGroup FinanceAdmin; - -$resourceCondition = "(@RESOURCE." + $departmentResourceProperty.Name + " Contains {`"Finance`"})" - -$currentAcl = "O:SYG:SYD:AR(A;;FA;;;OW)(A;;FA;;;BA)(A;;0x1200a9;;;" + $financeException.SID.Value + ")(A;;0x1301bf;;;" + $financeAdmin.SID.Value + ")(A;;FA;;;SY)(XA;;0x1200a9;;;AU;((@USER." + $countryClaimType.Name + " Any_of @RESOURCE." + $countryResourceProperty.Name + ") && (@USER." + $departmentClaimType.Name + " Any_of @RESOURCE." + $departmentResourceProperty.Name + ")))"; - -Set-ADCentralAccessRule "Finance Documents Rule" -ResourceCondition $resourceCondition -CurrentAcl $currentAcl -``` - -Description - ------------ - -Set the central access rule named "Finance Documents Rule" with a new resource condition and new permissions. - -The new rule specifies that documents should only be read by members of the Finance department. -Members of the Finance department should only be able to access documents in their own country/region. -Only Finance Administrators should have write access. -The rule allows an exception for members of the FinanceException group. -This group will have read access. - -Targeting: - -Resource.Department Contains Finance - -Access rules: - -Allow Read User.Country=Resource.Country AND User.department = Resource.Department - -Allow Full control User.MemberOf(FinanceAdmin) - -Allow Read User.Country=Resource.Country AND User.department = Resource.Department - -Allow Read User.MemberOf(FinanceException) - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADCentralAccessRule "Finance Documents Rule" | Set-ADCentralAccessRule -Description "For finance documents." -``` - -Description - ------------ - -Get the central access rule named "Finance Documents Rule", and set the description to "For finance documents." - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CurrentAcl -This parameter specifies the currently effective ACL of the central access rule. -The current ACL grants access to target resources once the central access policy containing this rule is published. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Finance Documents Rule,CN=Central Access Rules,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADCentralAccessRule -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of an central access rule object to use to update the actual central access rule object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding central access rule object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update central access rule objects that have been retrieved by using the Get-ADCentralAccessRule cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADCentralAccessRule cmdlet to retrieve an instance of the object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADCentralAccessRule cmdlet saves the changes to the central access rule object. - -Step 1: Retrieve a local instance of the object. - -$objectInstance = Get-ADCentralAccessRule -Identity "Finance Documents Rule" - -Step 2: Modify one or more properties of the object instance. - -$objectInstance.Description = "For finance documents." - -Step 3: Save your changes to the object - -Set-ADCentralAccessRule -Instance $objectInstance - -```yaml -Type: ADCentralAccessRule -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProposedAcl -Specifies the proposed ACL of the central access rule. -The proposed ACL allows an administrator to audit the results of access requests to target resources specified in the resource condition without affecting the current system. -To view the logs, go to Event Viewer or other audit tools to view the logs. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceCondition -Specifies the resource condition of the central access rule. -The resource condition specifies a list of criteria to scope the resources. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicyEntry -A ADCentralAccessPolicyEntry object is received by the Identity parameter. - -A ADCentralAccessPolicyEntry object that was retrieved by using the Get-ADCentralAccessPolicyEntry cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADCentralAccessPolicyEntry -Returns the modified ADCentralAccessPolicyEntry object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADClaimTransformLink.md b/docset/winserver2012-ps/activedirectory/Set-ADClaimTransformLink.md deleted file mode 100644 index 4132633a60..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADClaimTransformLink.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adclaimtransformlink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADClaimTransformLink - -## SYNOPSIS -Applies a claims transformation to one or more cross-forest trust relationships in Active Directory. - -## SYNTAX - -``` -Set-ADClaimTransformLink [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-PassThru] [-Policy] [-Server ] - -TrustRole [] -``` - -## DESCRIPTION -The Set-ADClaimTransformLink cmdlet can be used to apply a claims transformation to one or more cross-forest trust relationships in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADClaimTransformPolicy DenyAllPolicy -DenyAll; -Set-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusted -Set-ADClaimTransformLink "corp.contoso.com" -Policy DenyAllPolicy -TrustRole Trusting -``` - -Description - ------------ - -Apply the claims transformation policy 'DenyAllPolicy' to the trust "corp.contoso.com". -The rule is applied to where this domain acts as both the trusted and trusting domain in the trust. -Effectively, the rule is applied to both claims coming in to this domain from its trust partner, and claims flowing out of this domain towards its trust partner. - -Since the specified transformation rule denies all claims to be sent or received, this domain will now deny all claims from being sent to or received from the other domain (the trust partner). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department; -Get-ADTrust "corp.contoso.com" | Set-ADClaimTransformLink -Policy AllowAllExceptCompanyAndDepartmentPolicy -TrustRole Trusted -``` - -Description - ------------ - -Apply th the claims transformation policy 'AllowAllExceptCompanyAndDepartmentPolicy' to the trust "corp.contoso.com". -The rule is applied to where this domain acts as the trusted domain in the trust. -Effectively, the rule is applied to claims flowing out of this domain towards its trust partner. - -Since the specified transformation rule allows all claims to be sent or received except 'Company' and 'Department', this domain will now allow all claims except the two from being sent to the other domain (the trust partner). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>New-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ce6e1cc00e9524", Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);'; Set-ADClaimTransformLink "corp.contoso.com" -Policy HumanResourcesToHrPolicy -TrustRole Trusting -``` - -Description - ------------ - -Apply the claims transformation policy ' HumanResourcesToHrPolicy' to the trust "corp.contoso.com". -The rule is applied to where this domain acts as the trusting domain in the trust. -Effectively, the rule is applied to claims coming in to this domain from its trust partner. - -Since the specified transformation rule transforms the value 'Human Resources' into 'HR' in the claim ad://ext/Department:88ce6e1cc00e9524', this domain will now transform the claim value received from the other domain (the trust partner) from 'Human Resources' to 'HR'. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=fabrikam.com,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to a group object instance named "ADTrustInstance". - --Identity $ADTrustInstance - -```yaml -Type: ADTrust -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Policy -Specifies the claims transformation policy to apply to the cross-forest trust relationship. -This parameter does not receive pipeline input. - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustRole -An enumeration of the link types. -Used to specify which links on the trust relationships should the claims transformation apply to. -Allowable values are: Trusted and Trusting. - -```yaml -Type: ADTrustRole -Parameter Sets: (All) -Aliases: -Accepted values: Trusted, Trusting - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADTrust -A trust object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADTrust - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADClaimTransformPolicy.md b/docset/winserver2012-ps/activedirectory/Set-ADClaimTransformPolicy.md deleted file mode 100644 index bb8e926859..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADClaimTransformPolicy.md +++ /dev/null @@ -1,620 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adclaimtransformpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADClaimTransformPolicy - -## SYNOPSIS -Sets the properties of a claims transformation policy in Active Directory. - -## SYNTAX - -### AllowAllExcept -``` -Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add ] -AllowAllExcept - [-AuthType ] [-Clear ] [-Credential ] [-Description ] - [-Identity] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Remove ] [-Replace ] [-Server ] [] -``` - -### DenyAllExcept -``` -Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] -DenyAllExcept [-Description ] - [-Identity] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Remove ] [-Replace ] [-Server ] [] -``` - -### Identity -``` -Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-Description ] [-Identity] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Remove ] [-Replace ] [-Rule ] - [-Server ] [] -``` - -### AllowAll -``` -Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add ] [-AllowAll] [-AuthType ] - [-Clear ] [-Credential ] [-Description ] [-Identity] - [-PassThru] [-ProtectedFromAccidentalDeletion ] [-Remove ] [-Replace ] - [-Server ] [] -``` - -### DenyAll -``` -Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-DenyAll] [-Description ] [-Identity] - [-PassThru] [-ProtectedFromAccidentalDeletion ] [-Remove ] [-Replace ] - [-Server ] [] -``` - -### Instance -``` -Set-ADClaimTransformPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADClaimTransformPolicy cmdlet can be used to set the properties of a claims transformation policy in Active Directory. -A claims transformation policy object contains a set of rules authored in the transformation rule language. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADClaimTransformPolicy DenyAllPolicy -DenyAll -``` - -Description - ------------ - -Sets the transformation rule on the claims transformation policy named 'DenyAllPolicy' to deny all claims, both those that are sent as well as those that are received. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADClaimTransformPolicy AllowAllExceptCompanyAndDepartmentPolicy -AllowAllExcept Company,Department -``` - -Description - ------------ - -Set the transformation rule on the claims transformation policy named 'AllowAllExceptCompanyAndDepartmentPolicy' to allow all claims to be sent or received except for the claims Company and Department. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-ADClaimTransformPolicy HumanResourcesToHrPolicy -Rule 'C1:[Type=="ad://ext/Department:88ce6e1cc00e9524", Value=="Human Resources", ValueType=="string"] => issue(Type=C1.Type, Value="HR", ValueType=C1.ValueType);' -``` - -Description - ------------ - -Sets the transformation rule on the claims transformation policy named 'HumanResourcesToHrPolicy' to transform the value 'Human Resources' to 'HR' in the claim 'ad://ext/Department:88ce6e1cc00e9524'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$rule = Get-Content C:\rule.txt -Set-ADClaimTransformPolicy MyRule -Rule $rule -``` - -Description - ------------ - -Set the transformation rule on the claims transformation policy named 'MyRule' with the rule specified in C:\rule.txt. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAll -When this parameter is specified, the policy sets a claims transformation rule that allows all claims to be sent or received. - -```yaml -Type: SwitchParameter -Parameter Sets: AllowAll -Aliases: -Accepted values: true - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowAllExcept -When this parameter is specified, the policy sets a claims transformation rule that allows all claims to be sent or received except for the specified claim types. - -```yaml -Type: ADClaimType[] -Parameter Sets: AllowAllExcept -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyAll -When this parameter is specified, the policy sets a claims transformation rule that denies all claims to be sent or received. - -```yaml -Type: SwitchParameter -Parameter Sets: DenyAll -Aliases: -Accepted values: true - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyAllExcept -When this parameter is specified, the claims transformation policy sets a claims transformation rule that denies all claims to be sent or received except for the specified claim types. - -```yaml -Type: ADClaimType[] -Parameter Sets: DenyAllExcept -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies one of the following as valid identities for the ADClaimTransformPolicy object: - -Distinguished Name - -Example: CN=DenyAllPolicy,CN=Claims Transformation Policies,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an Active Directory object to use as a template for a new claims transformation policy object. - -You can use an instance of an existing claims transformation policy object as a template or you can construct a new claims transformation policy object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new claims transformation policy object. - -Method 1: Use an existing claims transformation policy object as a template for a new object. -To retrieve an instance of an existing claims transformation policy object, use a cmdlet such as Get-ADClaimTransformPolicy. -Then provide this object to the Instance parameter of the New-ADClaimTransformPolicy cmdlet to create a new claims transformation policy object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADClaimTransformPolicy -Identity "Allow All except Finance Policy" - -New-ADClaimTransformPolicy -Name "Allow All Except Pii Policy" -Instance $ObjectInstance - -Method 2: Create a new ADClaimTransformPolicy and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADClaimTransformPolicy cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy - -$objectInstance.Description = "For finance only." - -New- DClaimTransformPolicy -Name "Deny All except Finance Policy" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADClaimTransformPolicy -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: AllowAllExcept, DenyAllExcept, Identity, AllowAll, DenyAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Rule -Represents the claims transformation rule. -To specify the rule, you can either (1) type the rule in a text file, and then pass the file to the cmdlet (recommended), or (2) type the rule inline. - -For example, the following commands demonstrate how to create a new claims transformation policy object with the rule specified in a text file named Rule.txt located in a temporary folder C:\temp. - -$rule = Get-Content C:\temp\rule.txt; - -New-ADClaimTransformPolicy MyRule -Rule $rule - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy -A claim transform policy object is received by the Identity parameter. - -A claim transform policy object that was retrieved by using the Get-ADClaimTransformPolicycmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTransformPolicy -Returns the modified claim transform policy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADClaimType.md b/docset/winserver2012-ps/activedirectory/Set-ADClaimType.md deleted file mode 100644 index 95845a7897..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADClaimType.md +++ /dev/null @@ -1,703 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adclaimtype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADClaimType - -## SYNOPSIS -Modify a claim type in Active Directory. - -## SYNTAX - -### Identity (Default) -``` -Set-ADClaimType [-WhatIf] [-Confirm] [-Add ] [-AppliesToClasses ] [-AuthType ] - [-Clear ] [-Credential ] [-Description ] [-DisplayName ] - [-Enabled ] [-Identity] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Remove ] [-Replace ] [-RestrictValues ] [-Server ] - [-SuggestedValues ] [] -``` - -### SourceTransformPolicy -``` -Set-ADClaimType [-WhatIf] [-Confirm] [-Add ] [-AppliesToClasses ] [-AuthType ] - [-Clear ] [-Credential ] [-Description ] [-DisplayName ] - [-Enabled ] [-Identity] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Remove ] [-Replace ] [-RestrictValues ] [-Server ] - [-SourceTransformPolicy] [-SuggestedValues ] [] -``` - -### SourceOID -``` -Set-ADClaimType [-WhatIf] [-Confirm] [-Add ] [-AppliesToClasses ] [-AuthType ] - [-Clear ] [-Credential ] [-Description ] [-DisplayName ] - [-Enabled ] [-Identity] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Remove ] [-Replace ] [-RestrictValues ] [-Server ] - -SourceOID [] -``` - -### SourceAttribute -``` -Set-ADClaimType [-WhatIf] [-Confirm] [-Add ] [-AppliesToClasses ] [-AuthType ] - [-Clear ] [-Credential ] [-Description ] [-DisplayName ] - [-Enabled ] [-Identity] [-PassThru] [-ProtectedFromAccidentalDeletion ] - [-Remove ] [-Replace ] [-RestrictValues ] [-Server ] - -SourceAttribute [-SuggestedValues ] [] -``` - -### Instance -``` -Set-ADClaimType [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADClaimType cmdlet can be used to modify a claim type in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADClaimType Title -SourceAttribute title -``` - -Description - ------------ - -Sets the user claim type with display name 'Title' to source from the Active Directory attribute 'title'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$fullTime = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("FTE", "Full-Time", "Full-time employee"); -$intern = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Intern", "Intern", "Student employee"); -$contractor = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Contractor", "Contractor", "Contract employee"); -Set-ADClaimType "Employee Type" -SuggestedValues $fullTime,$intern,$contractor -``` - -Description - ------------ - -Sets the suggested values of the user claim type with display name 'Employee Type' to 'FTE', 'Intern', and 'Contractor. -Applications using this claim type would allow their users to specify one of the suggested values as this claim type's value. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-ADclaimType "Bitlocker Enabled" -SourceOID "1.3.6.1.4.1.311.67.1.1" -Enabled $FALSE -``` - -Description - ------------ - -Set the source OID of the claim type with display name 'Bitlocker Enabled' to '1.3.6.1.4.1.311.67.1.1'. -Disable the claim type. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -PS C:\>Set-ADClaimType SourceForest -SourceTransformPolicy -``` - -Description - ------------ - -Sets the claim type named 'SourceForest' to source from the claims transformation policy engine. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppliesToClasses -Specifies the names, GUIDs or DNs of the schema classes to which this claim type is applied. - -```yaml -Type: String[] -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the claim type. -The display name of the claim type must be unique. -The display name of a claim type can be used as an identity in other Active Directory cmdlets. -For example, if the display name of a claim type is "Employee Type", then you can use 'Get-ADClaimType -Identity "Employee Type"' to retrieve the claim type. - -```yaml -Type: String -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies if the claim type is enabled. - -```yaml -Type: Boolean -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Country,CN=Claim Types,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADClaimType -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an claim type object to use as a template for a new claim type object. - -You can use an instance of an existing claim type object as a template or you can construct a new claim type object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new claim type object. - -Method 1: Use an existing claim type object as a template for a new object. -To retrieve an instance of an existing claim type object, use a cmdlet such as Get-ADClaimType. -Then provide this object to the Instance parameter of the New-ADClaimType cmdlet to create a new claim type object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADClaimType -Identity "Employee Type" - -New-ADClaimType -Name " Employee Type" -Instance $ObjectInstance - -Method 2: Create a new claim type and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADClaimType cmdlet to create the new claim type object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADClaimType - -$objectInstance.Description = Employee Type can be full-time, intern or contractor." - -New-ADClaimType -Name "Employee Type" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADClaimType -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestrictValues -This parameter is used to specify whether the claim type may have values outside of the SuggestedValues. -If this is set to true, then the claim should only have values specified in the SuggestedValues. -Note that Active Directory does not enforce this restriction. -It is up to the applications that use these claims to enforce the restriction. - -```yaml -Type: Boolean -Parameter Sets: Identity, SourceTransformPolicy, SourceOID, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceAttribute -Specifies an Active Directory attribute from which this claim type is based, and from which the claim value is obtained. -The input must be the distinguished name (DN), Name, or GUID of the attribute definition in the schema. - -Acceptable values include attributes of the following schema class objects: - -- User, InetOrgPerson, Computer, ManagedServiceAccount, GroupManagedServiceAccount, and Auxiliary class objects - -Except: - -- Attributes marked as defunct in the schema -- Blocked attributes such as dBCSPwd, lmPwdHistory, and unicodePwd -- Attributes that are not replicated -- Attributes that are not available on read-only domain controllers -- Attributes with syntaxes not based on the following -- String Object (DS-DN) -- String (Unicode) -- Boolean -- Integer -- Large Integer -- String (OID) -- String (SD) - -```yaml -Type: String -Parameter Sets: SourceAttribute -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceOID -Use to configure a certificate-based claim type source. -For example, use this parameter to create certificate-based claim types when you want to use smartcard logon claims for authorization decisions. -This parameter uses the string representation of an object identifier (OID) from the issuance policy found in the certificate and on the certificate template when using Active Directory Certificate Services. -An example of an OID is "1.3.6.1.4.1.311.47.2.5". - -```yaml -Type: String -Parameter Sets: SourceOID -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceTransformPolicy -Indicates that the claim type is sourced from the claims transformation policy engine. - -```yaml -Type: SwitchParameter -Parameter Sets: SourceTransformPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuggestedValues -Specifies one or more suggested values for the claim type. -An application may choose to present this list of suggested values for the user to choose from. -When RestrictValues is set to true, the application should restrict the user to pick values from this list only. - -Example: - -$fullTime = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("FTE", "Full-Time", "Full-time employee"); - -$intern = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Intern", "Intern", "Student employee"); - -$contractor = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("Contractor", "Contractor", "Contract employee"); - -New-ADClaimType "Employee Type" -SourceAttribute employeeType -SuggestedValues $fullTime,$intern,$contractor - -```yaml -Type: ADSuggestedValueEntry[] -Parameter Sets: Identity, SourceTransformPolicy, SourceAttribute -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimType - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimType - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADComputer.md b/docset/winserver2012-ps/activedirectory/Set-ADComputer.md deleted file mode 100644 index 37970038cf..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADComputer.md +++ /dev/null @@ -1,1268 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adcomputer?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADComputer - -## SYNOPSIS -Modifies an Active Directory computer object. - -## SYNTAX - -### Identity -``` -Set-ADComputer [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-Add ] [-AllowReversiblePasswordEncryption ] [-AuthType ] - [-CannotChangePassword ] [-Certificates ] [-ChangePasswordAtLogon ] - [-Clear ] [-CompoundIdentitySupported ] [-Credential ] - [-Description ] [-DisplayName ] [-DNSHostName ] [-Enabled ] - [-HomePage ] [-Identity] [-KerberosEncryptionType ] - [-Location ] [-ManagedBy ] [-OperatingSystem ] [-OperatingSystemHotfix ] - [-OperatingSystemServicePack ] [-OperatingSystemVersion ] [-Partition ] [-PassThru] - [-PasswordNeverExpires ] [-PasswordNotRequired ] - [-PrincipalsAllowedToDelegateToAccount ] [-Remove ] [-Replace ] - [-SAMAccountName ] [-Server ] [-ServicePrincipalNames ] - [-TrustedForDelegation ] [-UserPrincipalName ] [] -``` - -### Instance -``` -Set-ADComputer [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADComputer** cmdlet modifies the properties of an Active Directory computer object. -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the *Add*, *Replace*, *Clear*, and *Remove* parameters. - -The *Identity* parameter specifies the Active Directory computer to modify. -You can identify a computer by its distinguished name, GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADComputer** cmdlet to retrieve a computer object and then pass the object through the pipeline to Set-ADComputer. - -The *Instance* parameter provides a way to update a computer by applying the changes made to a copy of the computer object. -When you set the *Instance* parameter to a copy of an Active Directory computer object that has been modified, the **Set-ADComputer** cmdlet makes the same changes to the original computer object. -To get a copy of the object to modify, use the Get-ADComputer object. -When you specify the *Instance* parameter you should not pass the *Identity* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - -## EXAMPLES - -### Example 1: Modify the SPN value for a specified Active Directory computer -``` -PS C:\> Set-ADComputer -Identity "USER01-SRV1" -ServicePrincipalName @{Replace="MSSQLSVC/USER01-SRV1.USER01.COM:1456","MSOLAPSVC.3/USER01-SRV1.USER01.COM:analyze"} -``` - -This command modifies the service principal name (SPN) value for the computer specified by the *Identity* parameter. - -### Example 2: Set the location for a specified Active Directory computer -``` -PS C:\> Set-ADComputer -Identity "USER02-SRV1" -Location "NA/HQ/Building A" -``` - -This command sets the location for the computer specified by the *Identity* parameter. - -### Example 3: Set an attribute for a specified Active Directory computer using a SAM account name -``` -PS C:\> Set-ADComputer -Identity "USER03-SRV1" -ManagedBy "CN=SQL Administrator 01,OU=UserAccounts,OU=Managed,DC=USER03,DC=COM" -``` - -This command sets the **ManagedBy** attribute value for the computer specified by the *Identity* parameter using the SAM account name of the user. - -### Example 4: Set multiple attributes of an Active Directory computer -``` -PS C:\> $Comp = Get-ADComputer -Identity "USER04-SRV1" -PS C:\> $Comp.Location = "NA/HQ/Building A" -PS C:\> $Comp.ManagedBy = "CN=SQL Administrator 01,OU=UserAccounts,OU=Managed,DC=USER04,DC=COM" -PS C:\> Set-ADComputer -Instance $Comp -``` - -This command sets the **Location** and **ManagedBy** attributes of a computer. - -## PARAMETERS - -### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the AccountExpirationDate property of an account object. -The LDAP Display name (ldapDisplayName) for this property is accountExpires. - -Use the DateTime syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. -The following examples show commonly-used syntax to specify a DateTime object. - -"4/17/2006" - -"Monday, April 17, 2006" - -"2:22:45 PM" - -"Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -"4/17/2006 2:22 PM" - -"Monday, April 17, 2006 2:22 PM" - -"2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - -"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - -"2006-04-17T14:22:48.0000000" - -The following example shows how to set this parameter to the date May 1, 2012 at 5 PM. - --AccountExpirationDate "05/01/2012 5:00:00 PM" - -```yaml -Type: DateTime -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountNotDelegated -Specifies whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the AccountNotDelegated property for an Active Directory account. -This parameter also sets the ADS_UF_NOT_DELEGATED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the security context of the account is not delegated to a service. - --AccountNotDelegated $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowReversiblePasswordEncryption -Specifies whether reversible password encryption is allowed for the account. -This parameter sets the AllowReversiblePasswordEncryption property of the account. -This parameter also sets the ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --AllowReversiblePasswordEncryption $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CannotChangePassword -Specifies whether the account password can be changed. -This parameter sets the CannotChangePassword property of an account. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the account password can be changed. - --CannotChangePassword $false - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificates -Modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the Certificates property of the account object. -The LDAP Display Name (ldapDisplayName) for this property is "userCertificate". - -Syntax: - -To add values: - --Certificates @{Add=value1,value2,...} - -To remove values: - --Certificates @{Remove=value3,value4,...} - -To replace values: - --Certificates @{Replace=value1,value2,...} - -To clear all values: - --Certificates $null - -You can specify more than one operation by using a list separated by semicolons. -For example, use the following syntax to add and remove Certificate values - --Certificates @{Add=value1,value2,...;Remove=value3,value4,...} - -The operators will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -The following example shows how to create a certificate by using the New-Object cmdlet, and then add it to a user account. -When this cmdlet is run, \ is replaced by the password used to add the certificate. - -$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate certificate1.cer \ - -Set-ADUser saradavis -Certificates @{Add=$cert} - -The following example shows how to add a certificate that is specified as a byte array. - -Set-ADUser saradavis -Certificates @{Add= \[Byte\[\]\](0xC5,0xEE,0x53,...)} - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChangePasswordAtLogon -Specifies whether a password must be changed during the next logon attempt. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -This parameter cannot be set to $true or 1 for an account that also has the PasswordNeverExpires property set to true. - -The following example shows how to set this parameter so that the password must be changed at logon. - --ChangePasswordAtLogon $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompoundIdentitySupported -Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account supports service tickets with device authorization data. - --SupportDeviceAuthz $true - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DNSHostName -Specifies the fully qualified domain name (FQDN) of the computer. -This parameter sets the DNSHostName property for a computer object. -The LDAP Display Name for this property is "dNSHostName". - -The following example shows how to set this parameter to a FQDN. - --DNSHostName "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies if an account is enabled. -An enabled account requires a password. -This parameter sets the Enabled property for an account object. -This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to enable the account. - --Enabled $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the homePage property of an Active Directory object. -The LDAP Display Name (ldapDisplayName) for this property is "wWWHomePage". - -The following example shows how to set this parameter to a URL. - --HomePage "http://employees.contoso.com/sdavis" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory computer object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager Account Name (sAMAccountName) - -Example: SaraDavisDesktop - -The cmdlet searches the default naming context or partition to find the object. -If the identifier given is a DN, the partition to search will be computed from that DN. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a computer object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saraDavisDesktop,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a computer object instance named "computerInstance". - --Identity $computerInstance - -```yaml -Type: ADComputer -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of a computer object to use to update the actual Active Directory computer object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update computer objects that have been retrieved by using the Get-ADComputer cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADComputer cmdlet to retrieve an instance of the ADComputer object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADComputer cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$computerInstance = Get-ADComputer -Identity saraDavisDesktop - -Step 2: Modify one or more properties of the object instance. - -$computerInstance.Description = "Sara Davis Computer" - -Step3: Save your changes to saraDavisDesktop. - -Set-ADComputer -Instance $computerInstance - -```yaml -Type: ADComputer -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -None - -DES - -RC4 - -AES128 - -AES256 - -None, will remove all encryption types from the account which may result in the KDC being unable to issue service tickets for services using the account. - -DES is a weak encryption type which is not supported by default since Windows 7 and Windows Server 2008 R2. - -The following example shows how to specify that an account supports service tickets with device authorization data. - --KerberosEncryptionTypes RC4|AES128|AES256 - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: ADKerberosEncryptionType -Parameter Sets: Identity -Aliases: -Accepted values: None, DES, RC4, AES128, AES256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Specifies the location of the computer, such as an office number. -This parameter sets the Location property of a computer. -The LDAP display name (ldapDisplayName) of this property is "location". - -The following example shows how to set this parameter. - --Location "Test Lab A" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystem -Specifies an operating system name. -This parameter sets the OperatingSystem property of the computer object. -The LDAP Display Name (ldapDisplayName) for this property is "operatingSystem". - -The following example shows how to set this parameter. - --OperatingSystem "Windows Server 2008 Enterprise" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystemHotfix -Specifies an operating system hotfix name. -This parameter sets the operatingSystemHotfix property of the computer object. -The LDAP display name for this property is "operatingSystemHotfix". - -The following example shows how to specify this parameter. - --operatingSystemHotfix "523466" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystemServicePack -Specifies the name of an operating system service pack. -This parameter sets the OperatingSystemServicePack property of the computer object. -The LDAP display name (ldapDisplayName) for this property is "operatingSystemServicePack". - -The following example shows how to specify this parameter. - --OperatingSystemServicePack "Service Pack 2" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystemVersion -Specifies an operating system version. -This parameter sets the OperatingSystemVersion property of the computer object. -The LDAP display name (ldapDisplayName) for this property is "operatingSystemVersion". - -The following example shows how to specify this parameter. - --OperatingSystemVersion "6.0 (6001)" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNeverExpires -Specifies whether the password of an account can expire. -This parameter sets the PasswordNeverExpires property of an account object. -This parameter also sets the ADS_UF_DONT_EXPIRE_PASSWD flag of the Active Directory User Account Control attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -Note: This parameter cannot be set to $true or 1 for an account that also has the ChangePasswordAtLogon property set to true. - -The following example shows how to set this parameter so that the password can expire. - --PasswordNeverExpires $false - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNotRequired -Specifies whether the account requires a password. -This parameter sets the PasswordNotRequired property of an account, such as a user or computer account. -This parameter also sets the ADS_UF_PASSWD_NOTREQD flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that as password is not required for the account. - --PasswordNotRequired $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToDelegateToAccount -Specifies the accounts which can act on the behalf of users to services running as this computer account. -This parameter sets the msDS-AllowedToActOnBehalfOfOtherIdentity attribute of a computer account object. - -```yaml -Type: ADPrincipal[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SAMAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the SAMAccountName for an account object. -The LDAP display name (ldapDisplayName) for this property is "sAMAccountName". - -The following example shows how to specify this parameter. - --SAMAccountName "saradavis" - -Note: If the string value provided is not terminated with a '$' character, the system adds one if needed. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalNames -Specifies the service principal names for the account. -This parameter sets the ServicePrincipalNames property of the account. -The LDAP display name (ldapDisplayName) for this property is servicePrincipalName. -This parameter uses the following syntax to add remove, replace or clear service principal name values. - -Syntax: - -To add values: - --ServicePrincipalNames @{Add=value1,value2,...} - -To remove values: - --ServicePrincipalNames @{Remove=value3,value4,...} - -To replace values: - --ServicePrincipalNames @{Replace=value1,value2,...} - -To clear all values: - --ServicePrincipalNames $null - -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove service principal names. - -@{Add=value1,value2,...;Remove=value3,value4,...} - -The operators will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -The following example shows how to add and remove service principal names. - --ServicePrincipalNames-@{Add="SQLservice\accounting.corp.contoso.com:1456";Remove="SQLservice\finance.corp.contoso.com:1456"} - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the TrustedForDelegation property of an account object. -This value also sets the ADS_UF_TRUSTED_FOR_DELEGATION flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account is trusted for Kerberos delegation. - --TrustedForDelegation $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -Each user account has a user principal name (UPN) in the format \@\. -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. -The UPN is independent of the user object's DN, so a user object can be moved or renamed without affecting the user logon name. -When logging on using a UPN, users no longer have to choose a domain from a list on the logon dialog box. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADComputer -A computer object is received by the Identity parameter. - -A computer object that was retrieved by using the Get-ADComputer cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADComputer -Returns the modified computer object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work when connected to Global Catalog port. - -## RELATED LINKS - -[Add-ADComputerServiceAccount](./Add-ADComputerServiceAccount.md) - -[Get-ADComputer](./Get-ADComputer.md) - -[Get-ADComputerServiceAccount](./Get-ADComputerServiceAccount.md) - -[New-ADComputer](./New-ADComputer.md) - -[Remove-ADComputer](./Remove-ADComputer.md) - -[Remove-ADComputerServiceAccount](./Remove-ADComputerServiceAccount.md) diff --git a/docset/winserver2012-ps/activedirectory/Set-ADDefaultDomainPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/Set-ADDefaultDomainPasswordPolicy.md deleted file mode 100644 index 40b6ea7854..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADDefaultDomainPasswordPolicy.md +++ /dev/null @@ -1,487 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-addefaultdomainpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADDefaultDomainPasswordPolicy - -## SYNOPSIS -Modifies the default password policy for an Active Directory domain. - -## SYNTAX - -``` -Set-ADDefaultDomainPasswordPolicy [-WhatIf] [-Confirm] [-AuthType ] [-ComplexityEnabled ] - [-Credential ] [-Identity] [-LockoutDuration ] - [-LockoutObservationWindow ] [-LockoutThreshold ] [-MaxPasswordAge ] - [-MinPasswordAge ] [-MinPasswordLength ] [-PassThru] [-PasswordHistoryCount ] - [-ReversibleEncryptionEnabled ] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADDefaultDomainPasswordPolicy** cmdlet modifies the properties of the default password policy for a domain. -You can modify property values by using the cmdlet parameters. - -The *Identity* parameter specifies the domain whose default password policy you want modify. -You can identify a domain by its distinguished name, GUID, Security Identifier (SID), DNS domain name, or NETBIOS name. -You can also set the parameter to an **ADDomain** object variable, or pass an **ADDomain** object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADDomain** cmdlet to retrieve a domain object and then pass the object through the pipeline to the **Set-ADDefaultDomainPasswordPolicy** cmdlet. - -## EXAMPLES - -### Example 1: Set the default password policy for a specified domain -```powershell -PS C:\> Set-ADDefaultDomainPasswordPolicy -Identity fabrikam.com -LockoutDuration 00:40:00 -LockoutObservationWindow 00:20:00 -ComplexityEnabled $True -ReversibleEncryptionEnabled $False -MaxPasswordAge 10.00:00:00 -``` - -This command sets the default domain password policy for a domain specified by using the *Identity* parameter. -Note: setting **MaxPwdAge** to 0 will convert it to never, which is Int64.MinValue or -9223372036854775808 in the directory. - -### Example 2: Set the default domain policy for the current logged on user domain -```powershell -PS C:\> Get-ADDefaultDomainPasswordPolicy -Current LoggedOnUser | Set-ADDefaultDomainPasswordPolicy -LockoutDuration 00:40:00 -LockoutObservationWindow 00:20:00 -ComplexityEnabled $true -ReversibleEncryptionEnabled $false -MinPasswordLength 12 -``` - -This command sets the default domain password policy for the current logged on user domain. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplexityEnabled -Specifies whether password complexity is enabled for the password policy. -If enabled, the password must contain two of the following three character types: - -- Uppercase characters (A, B, C, D, E, ...) -- Lowercase characters (a, b, c, d, e, ...) -- Numerals (0, 1, 2, 3, ...) -- Special characters (#, $, *, %, ...) - -This parameter sets the **ComplexityEnabled** property of a password policy. -The acceptable values for this parameter are: - -- $False or 0. -Disables password complexity. -- $True or 1. -Enables password complexity. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the **Get-Credential** cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain object by providing one of the following property values. -The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. -All values are for the **domainDNS** object that represents the domain. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A DNS domain name -- A NetBIOS domain name - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a domain object instance. - -```yaml -Type: ADDefaultDomainPasswordPolicy -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LockoutDuration -Specifies the length of time that an account is locked after the number of failed login attempts exceeds the lockout threshold. -You cannot login to an account that is locked until the lockout duration time period has expired. -This parameter sets the **lockoutDuration** property of a password policy object. -The LDAP display name (**ldapDisplayName**) of this property is lockoutDuration. - -The lockout duration must be greater than or equal to the lockout observation time for a password policy. -Use the *LockOutObservationWindow* parameter to set the lockout observation time. - -Specify the lockout duration time interval in the following format: - -D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F = Fractions of a second (0 to 9999999) - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0.00:30:00 (30 Minutes) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockoutObservationWindow -Specifies the maximum time interval between two unsuccessful login attempts before the number of unsuccessful login attempts is reset to 0. -An account is locked when the number of unsuccessful login attempts exceeds the password policy lockout threshold. -This parameter sets the **lockoutObservationWindow** property of a password policy object. -The LDAP display name (**ldapDisplayName**) of this property is lockoutObservationWindow. - -The lockout observation window must be smaller than or equal to the lockout duration for a password policy. -Use the *LockoutDuration* parameter to set the lockout duration time. - -Specify the time interval in the following format: - -D:H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F = Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0:0:0:0.0 and 10675199:02:48:05.4775807. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0.00.30.00 (30 Minutes) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockoutThreshold -Specifies the number of unsuccessful login attempts that are permitted before an account is locked out. -This number increases when the time between unsuccessful login attempts is less than the time specified for the lockout observation time window. -This parameter sets the **LockoutThreshold** property of a password policy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordAge -Specifies the maximum length of time that you can have the same password. -After this time period, the password expires and you must create a new one. - -This parameter sets the **maxPasswordAge** property of a password policy. -The LDAP display name (**ldapDisplayName**) for this property is maxPwdAge. - -Specify the time interval in the following format: - -D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F = Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0 and 10675199:02:48:05.4775807. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 42.00:00:00 (42 days) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinPasswordAge -Specifies the minimum length of time before you can change a password. - -This parameter sets the **minPasswordAge** property of a password policy. -The LDAP display name (**ldapDisplayName**) for this property is minPwdAge. - -Specify the time interval in the following format. - -D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F = Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0 and 10675199:02:48:05.4775807. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 1.00:00:00 (1day) -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinPasswordLength -Specifies the minimum number of characters that a password must contain. -This parameter sets the **MinPasswordLength** property of the password policy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 7 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -Specifies the number of previous passwords to save. -A user cannot reuse a password in the list of saved passwords. -This parameter sets the **PasswordHistoryCount** property for a password policy. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 24 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReversibleEncryptionEnabled -Specifies whether the directory must store passwords using reversible encryption. -This parameter sets the **ReversibleEncryption** property for a password policy. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: $true -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory snapshot instance. - -Specify the Active Directory Domain Services instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the Active Directory Domain Services Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomain -A domain object is received by the *Identity* parameter. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - -* This cmdlet does not work with an Active Directory Snapshot. - -* This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADDefaultDomainPasswordPolicy](./Get-ADDefaultDomainPasswordPolicy.md) - -[AD DS Administration Cmdlets in Windows PowerShell](./ActiveDirectory.md) diff --git a/docset/winserver2012-ps/activedirectory/Set-ADDomain.md b/docset/winserver2012-ps/activedirectory/Set-ADDomain.md deleted file mode 100644 index f4771cd62d..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADDomain.md +++ /dev/null @@ -1,594 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-addomain?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADDomain - -## SYNOPSIS -Modifies an Active Directory domain. - -## SYNTAX - -### Identity -``` -Set-ADDomain [-WhatIf] [-Confirm] [-Add ] [-AllowedDNSSuffixes ] [-AuthType ] - [-Clear ] [-Credential ] [-Identity] - [-LastLogonReplicationInterval ] [-ManagedBy ] [-PassThru] [-Remove ] - [-Replace ] [-Server ] [] -``` - -### Instance -``` -Set-ADDomain [-WhatIf] [-Confirm] [-AllowedDNSSuffixes ] [-AuthType ] - [-Credential ] -Instance [-LastLogonReplicationInterval ] - [-ManagedBy ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADDomain** cmdlet modifies the properties of an Active Directory domain. -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the *Add*, *Replace*, *Clear*, and *Remove* parameters. - -The *Identity* parameter specifies the domain to modify. -You can identify a domain by its distinguished name, GUID, security identifier (SID), DNS domain name, or NetBIOS name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an object through the pipeline to the *Identity* parameter. -For example, you can use the Get-ADDomain cmdlet to retrieve a domain object and then pass the object through the pipeline to the **Set-ADDomain** cmdlet. - -The *Instance* parameter provides a way to update a domain object by applying the changes made to a copy of the domain object. -When you set the *Instance* parameter to a copy of an Active Directory domain object that has been modified, the **Set-ADDomain** cmdlet makes the same changes to the original domain object. -To get a copy of the object to modify, use the Get-ADDomain object. -When you specify the *Instance* parameter you should not pass the *Identity* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - -## EXAMPLES - -### Example 1: Set the value of a property in a domain -``` -PS C:\>Set-ADDomain -Identity USER01 -AllowedDNSSuffixes @{Replace="USER01.com","corp.USER01.com"} -``` - -This command sets the value of **AllowedDNSSuffixes** to {"USER01.com","corp.USER01.com"} in domain USER01. - -### Example 2: Set the value of a property in a domain -``` -PS C:\> Set-ADDomain -Identity USER01 -AllowedDNSSuffixes @{Add="corp.USER01.com"} -``` - -This command adds the value corp.USER01.com to the **AllowedDNSSuffixes** in domain USER01. - -### Example 3: Set the ManagedBy property in a domain -``` -PS C:\> Set-ADDomain -Identity USER01 -ManagedBy 'CN=Domain Admins,CN=Users,DC=USER01,DC=COM' -``` - -This command sets the **ManagedBy** property in domain USER01 to CN=Domain Admins,CN=Users,DC=USER01,DC=COM. - -### Example 4: Set the time in days for replication for the current logged on user -``` -PS C:\> Get-ADDomain | Set-ADDomain -LastLogonReplicationInterval "10" -``` - -This command sets the **LastLogonReplicationInterval** of the current logged on user domain to 10. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedDNSSuffixes -Modifies the list of domain name server (DNS) suffixes that are allowed in a domain. -This parameter sets the value of the msDS-AllowedDNSSuffixes attribute of the domainDNS object. -This parameter uses the following syntax to add, remove, replace, or clear DNS suffix values. - -To add values: - --AllowedDNSSuffixes @{Add=value1,value2,...} - -To remove values: - --AllowedDNSSuffixes @{Remove=value3,value4,...} - -To replace values: - --AllowedDNSSuffixes @{Replace=value1,value2,...} - -To clear all values: - --AllowedDNSSuffixes $null - -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove DNS suffix values: - -@{Add=value1,value2,...};@{Remove=value3,value4,...} - -The operators will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -The following example shows how to add and remove DNS suffixes for a domain. - --AllowedDNSSuffixes@{Add= "corp.contoso.com,contoso.com"};@{Remove="corpnet.contoso.com"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -All values are for the domainDNS object that represents the domain. - -Distinguished Name - -Example: DC=redmond,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370- - -DNS domain name - -Example: redmond.corp.contoso.com - -NetBIOS domain name - -Example: redmond - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a domain object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "DC=redmond,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a domain object instance named "domainInstance". - --Identity $domainInstance - -```yaml -Type: ADDomain -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of a domain object to use to update the actual Active Directory domain object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update domain objects that have been retrieved by using the Get-ADDomain cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADDomain cmdlet to retrieve an instance of the ADDomain object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADDomain cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$domainInstance = Get-ADDomain -Identity "contosoDomain" - -Step 2: Modify one or more properties of the object instance. - -$domainInstance.ManagedBy = "saraDavisGroup" - -Step3: Save your changes to contosoDomain. - -Set-ADDomain -Instance $domainInstance - -```yaml -Type: ADDomain -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastLogonReplicationInterval -Specifies the time, in days, within which the last logon time of an account must be replicated across all domain controllers in the domain. -This parameter sets the LastLogonReplicationInterval property for a domain. -The LDAP display name (ldapDisplayName) for this property is msDS-LogonTimeSyncInterval. -The last logon replication interval must be at least one day. -Setting the last logon replication interval to a low value can significantly increase domain-wide replication. - -The following example shows how to set this parameter to 10 days. - --LastLogonReplicationInterval "10" - -Note: This value does not apply when the domain mode is set to the value "Windows2000". - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomain -A domain object is received by the Identity parameter. - -A domain object that was retrieved by using the Get-ADDomain cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomain -Returns the modified domain object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADDomain](./Get-ADDomain.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADDomainMode.md b/docset/winserver2012-ps/activedirectory/Set-ADDomainMode.md deleted file mode 100644 index 06014e1be7..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADDomainMode.md +++ /dev/null @@ -1,342 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-addomainmode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADDomainMode - -## SYNOPSIS -Sets the domain mode for an Active Directory domain. - -## SYNTAX - -``` -Set-ADDomainMode [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-DomainMode] [-Identity] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADDomainMode cmdlet sets the domain mode for a domain. -You specify the domain mode by setting the DomainMode parameter. - -The domain mode can be set to the following values that are listed in order of functionality from lowest to highest. - -Windows2000Domain - -Windows2003InterimDomain - -Windows2003Domain - -Windows2008Domain - -Windows2008R2Domain - -You can change the domain mode to a mode with higher functionality only. -For example, if the domain mode for a domain is set to Windows 2003, you can use this cmdlet to change the mode to Windows 2008. -However, in the same situation, you cannot use this cmdlet to change the domain mode from Windows 2003 to Windows 2000. - -The Identity parameter specifies the Active Directory domain to modify. -You can identify a domain by its distinguished name (DN), GUID, security identifier (SID), DNS domain name, or NetBIOS name. -You can also set the Identity parameter to a domain object variable such as $\, or you can pass a domain object through the pipeline to the Identity parameter. -For example, you can use the Get-ADDomain cmdlet to retrieve a domain object and then pass the object through the pipeline to the Set-ADDomainMode cmdlet. - -The Set-ADDomainMode always prompts for permission unless you specify -confirm:$false. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADDomainMode -Identity fabrikam.com -DomainMode Windows2003Domain -``` - -Description - ------------ - -Set the DomainMode property of the fabrikam.com domain to Windows2003Domain. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$pdc = Get-ADDomainController -Discover -Service PrimaryDC -Set-ADDomainMode -Identity $pdc.Domain -Server $pdc.HostName[0] -DomainMode Windows2003Domain -``` - -Description - ------------ - -Set the DomainMode of the current logged on user's domain to Windows2003Domain. -The Set operation targets the PrimaryDC FSMO to apply the update. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainMode -Specifies the domain mode for an Active Directory domain. -You can set the domain mode to one of the following values that are listed in order of functionality from least to most. - -Windows2000Domain or 0 - -Windows2003InterimDomain or 1 - -Windows2003Domain or 2 - -Windows2008Domain or 3 - -Windows2008R2Domain or 4 - -The following example shows how to set this parameter to Windows 2008 R2. - --DomainMode Windows2008R2Domain - -```yaml -Type: ADDomainMode -Parameter Sets: (All) -Aliases: -Accepted values: Windows2000Domain, Windows2003InterimDomain, Windows2003Domain, Windows2008Domain, Windows2008R2Domain, Windows2012Domain, UnknownDomain - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory domain object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -All values are for the domainDNS object that represents the domain. - -Distinguished Name - -Example: DC=redmond,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370- - -DNS domain name - -Example: redmond.corp.contoso.com - -NetBIOS domain name - -Example: redmond - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a domain object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "DC=redmond,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a domain object instance named "domainInstance". - --Identity $domainInstance - -```yaml -Type: ADDomain -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADDomain -A domain object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADDomain -Returns the modified domain object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - - This cmdlet does not work when connected to Global Catalog port. - -## RELATED LINKS - -[Get-ADDomain](./Get-ADDomain.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADFineGrainedPasswordPolicy.md b/docset/winserver2012-ps/activedirectory/Set-ADFineGrainedPasswordPolicy.md deleted file mode 100644 index b9fdda4aa3..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADFineGrainedPasswordPolicy.md +++ /dev/null @@ -1,915 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adfinegrainedpasswordpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFineGrainedPasswordPolicy - -## SYNOPSIS -Modifies an Active Directory fine grained password policy. - -## SYNTAX - -### Identity -``` -Set-ADFineGrainedPasswordPolicy [-WhatIf] [-Confirm] [-Add ] [-AuthType ] - [-Clear ] [-ComplexityEnabled ] [-Credential ] [-Description ] - [-DisplayName ] [-Identity] [-LockoutDuration ] - [-LockoutObservationWindow ] [-LockoutThreshold ] [-MaxPasswordAge ] - [-MinPasswordAge ] [-MinPasswordLength ] [-PassThru] [-PasswordHistoryCount ] - [-Precedence ] [-ProtectedFromAccidentalDeletion ] [-Remove ] - [-Replace ] [-ReversibleEncryptionEnabled ] [-Server ] [] -``` - -### Instance -``` -Set-ADFineGrainedPasswordPolicy [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADFineGrainedPasswordPolicy** cmdlet modifies the properties of an Active Directory fine-grained password policy. -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the *Add*, *Replace*, *Clear*, and *Remove* parameters. - -The *Identity* parameter specifies the Active Directory fine-grained password policy to modify. -You can identify a fine-grained password policy by its distinguished name, GUID or name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADFineGrainedPasswordPolicy** cmdlet to retrieve a fine-grained password policy object and then pass the object through the pipeline operator to the **Set-ADFineGrainedPasswordPolicy** cmdlet. - -The *Instance* parameter provides a way to update a fine-grained password policy object by applying the changes made to a copy of the object. -When you set the *Instance* parameter to a copy of an Active Directory fine-grained password policy object that has been modified, the **Set-ADFineGrainedPasswordPolicy** cmdlet makes the same changes to the original fine-grained password policy object. -To get a copy of the object to modify, use the Get-ADFineGrainedPasswordPolicy object. -The *Identity* parameter is not allowed when you use the *Instance* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - -## EXAMPLES - -### Example 1: Update properties on a fine-grained password policy object -``` -PS C:\>Set-ADFineGrainedPasswordPolicy -Identity MyPolicy -Precedence 100 -LockoutDuration 00:40:00 -LockoutObservationWindow 00:20:00 -ComplexityEnabled $True -ReversibleEncryptionEnabled $false -MinPasswordLength 12 -``` - -This command updates the **Precedence**, **LockoutDuration**, **LockoutObservationWindow**, **ComplexityEnabled**, **ReversibleEncryptionEnabled**, and **MinPasswordLength** properties on the **FineGrainedPasswordPolicy** object with name MyPolicy. - -### Example 2: Set a property on a fine-grained password policy using distinguished name -``` -PS C:\>Set-ADFineGrainedPasswordPolicy -Identity 'CN=MyPolicy,CN=Password Settings Container,CN=System,DC=FABRIKAM,DC=COM' -MinPasswordLength 12 -``` - -This command sets the **MinPasswordLength** property on the **FineGrainedPasswordPolicy** object with distinguished name CN=MyPolicy,CN=Password Settings Container,CN=System,DC=USER01,DC=COM. - -### Example 3: Get a fine-grained password policy then update a set of properties -``` -PS C:\>$FGPP = Get-ADFineGrainedPasswordPolicy -Identity MyPolicy -PS C:\> $FGPP.LockoutObservationWindow = [TimeSpan]::Parse("0.00:15:00") -PS C:\> $FGPP.LockoutThreshold = 10 -PS C:\> $FGPP.MinPasswordLength = 8 -PS C:\> $FGPP.PasswordHistoryCount = 24 -PS C:\> Set-ADFineGrainedPasswordPolicy -Instance $FGPP -``` - -This example gets the **FineGrainedPasswordPolicy** object with name MyPolicy, updates a set of properties on the object, and then writes the modifications back to the directory using the **Instance** parameter. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComplexityEnabled -Specifies whether password complexity is enabled for the password policy. -If enabled, the password must contain two of the following three character types: - -Uppercase characters (A, B, C, D, E, ...) - -Lowercase characters (a, b, c, d, e, ...) - -Numerals (0, 1, 2, 3, ...) - -This parameter sets the ComplexityEnabled property of a password policy. - -Possible values for this parameter include: - -$false or 0 - Disables password complexity - -$true or 1 - Enables password complexity - -The following example shows how to set this parameter to true. - --ComplexityEnabled $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory fine-grained password policy object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name (distinguishedName) - -Example: CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Name (name) - -Example: PasswordPolicyLevel1 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a fine-grained password policy object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=Strict Password Policy,CN=Password Settings Container,CN=System,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a fine-grained password policy object instance named "fineGrainedPasswordPolicyInstance". - --Identity $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of a fine-grained password policy object to use to update the actual Active Directory fine-grained password policy object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update fine-grained password policy objects that have been retrieved by using the Get-ADFineGrainedPasswordPolicy cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADFineGrainedPasswordPolicy cmdlet to retrieve an instance of the ADFineGrainedPasswordPolicy object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADFineGrainedPasswordPolicy cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$fineGrainedPasswordPolicyInstance = Get-ADFineGrainedPasswordPolicy -Identity PasswordPolicyLevel2 - -Step 2: Modify one or more properties of the object instance. - -$fineGrainedPasswordPolicyInstance.Precedence = 250 - -Step3: Save your changes to PasswordPolicyLevel2. - -Set-ADFineGrainedPasswordPolicy -Instance $fineGrainedPasswordPolicyInstance - -```yaml -Type: ADFineGrainedPasswordPolicy -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockoutDuration -Specifies the length of time that an account is locked after the number of failed login attempts exceeds the lockout threshold. -You cannot login to an account that is locked until the lockout duration time period has expired. -This parameter sets the lockoutDuration property of a password policy object. -The LDAP display name (ldapDisplayName) of this property is "msDS-LockoutDuration". - -The lockout duration must be greater than or equal to the lockout observation time for a password policy. -Use the LockOutObservationWindow parameter to set the lockout observation time. - -Specify the lockout duration time interval in the following format. - -D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F= Fractions of a second (0 to 9999999) - -The following examples show how to set this parameter. - -Set the time to 2 days - --LockoutDuration "2" - -Set the time to 4 hours - --LockoutDuration "4:00" - -Set the time to 5 minutes - --LockoutDuration "0:5" - -Set the time to 45 seconds - -LockoutDuration "0:0:45" - -```yaml -Type: TimeSpan -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockoutObservationWindow -Specifies the maximum time interval between two unsuccessful login attempts before the number of unsuccessful login attempts is reset to 0. -An account is locked when the number of unsuccessful login attempts exceeds the password policy lockout threshold. -This parameter sets the lockoutObservationWindow property of a password policy object. -The LDAP Display Name (ldapDisplayName) of this property is "msDS-lockoutObservationWindow". - -The lockout observation window must be smaller than or equal to the lockout duration for a password policy. -Use the LockoutDuration parameter to set the lockout duration time. - -Specify the time interval in the following format. - -D:H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0:0:0:0.0 and 10675199:02:48:05.4775807. - -The following examples show how to set this parameter. - -Set the time to 2 days - --LockoutObservationWindow "2" - -Set the time to 4 hours - --LockoutObservationWindow "4:00" - -Set the time to 5 minutes - --LockoutObservationWindow "0:5" - -Set the time to 45 seconds - --LockoutObservationWindow "0:0:45" - -```yaml -Type: TimeSpan -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockoutThreshold -Specifies the number of unsuccessful login attempts that are permitted before an account is locked out. -This number increases when the time between unsuccessful login attempts is less than the time specified for the lockout observation time window. -This parameter sets the LockoutThreshold property of a password policy. - -The following example shows how to set the lockout threshold to 3 login attempts. - --LockoutThreshold 3 - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxPasswordAge -Specifies the maximum length of time that you can have the same password. -After this time period, the password expires and you must create a new one. - -This parameter sets the maxPasswordAge property of a password policy. -The LDAP Display Name (ldapDisplayName) for this property is "maxPwdAge". - -Specify the time interval in the following format. - -D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0 and 10675199:02:48:05.4775807. - -The following examples show how to set this parameter. - -Set the time span to 2 days - -MaxPasswordAge "2" - -Set the time span to 4 hours - -MaxPasswordAge "4:00" - -Set the time span to 5 minutes - -MaxPasswordAge "0:5" - -Set the time span to 45 seconds - -MaxPasswordAge "0:0:45" - -```yaml -Type: TimeSpan -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinPasswordAge -Specifies the minimum length of time before you can change a password. - -This parameter sets the minPasswordAge property of a password policy. -The LDAP Display Name (ldapDisplayName) for this property is "minPwdAge". - -Specify the time interval in the following format. - -D.H:M:S.F - -where: - -D = Days (0 to 10675199) - -H = Hours (0 to 23) - -M = Minutes (0 to 59) - -S = Seconds (0 to 59) - -F= Fractions of a second (0 to 9999999) - -Note: Time values must be between the following values: 0 and 10675199:02:48:05.4775807. - -The following examples show how to set this parameter. - -Set the time span to 2 days - --MinPasswordAge "2" - -Set the time span to 4 hours - --MinPasswordAge "4:00" - -Set the time span to 5 minutes - --MinPasswordAge "0:5" - -Set the time span to 45 seconds - --MinPasswordAge "0:0:45" - -```yaml -Type: TimeSpan -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinPasswordLength -Specifies the minimum number of characters that a password must contain. -This parameter sets the MinPasswordLength property of the password policy. - -The following example shows how to set this parameter. - --MinPasswordLength 15 - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordHistoryCount -Specifies the number of previous passwords to save. -A user cannot reuse a password in the list of saved passwords. -This parameter sets the PasswordHistoryCount property for a password policy. - -The following example shows how to set this parameter to save 10 previous passwords. - --PasswordHistoryCount 10 - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Precedence -Specifies a value that defines the precedence of a fine-grained password policy among all fine-grained password policies. -This parameter sets the Precedence property for a fine-grained password policy. -The LDAP display name (ldapDisplayName) for this property is "msDS-PasswordSettingsPrecedence". - -This value determines which password policy to use when more than one password policy applies to a user or group. -When there is a conflict, the password policy that has the lower Precedence property value has higher priority. -For example, if PasswordPolicy1 has a Precedence property value of 200 and PasswordPolicy2 has a Precedence property value of 100, PasswordPolicy2 is used. - -Typically, password policy precedence values are assigned in multiples of 10 or 100, making it easier to add policies at a later time. -For example, if you set the initial precedence values for your policies to 100 and 200, you can add another policy that has precedence value of 150. - -If the specified Precedence parameter is already assigned to another password policy object, the cmdlet returns a terminating error. - -The following example shows how to set this parameter. - --Precedence 100 - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReversibleEncryptionEnabled -Specifies whether the directory must store passwords using reversible encryption. -This parameter sets the ReversibleEncryption property for a password policy. -Possible values for this parameter include the following: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ReversibleEncryptionEnabled $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -A fine grained password policy object is received by the Identity parameter. - -A fine grained password policy object that was retrieved by using the Get-ADFineGrainedPasswordPolicy cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy -Returns the modified fine grained password policy object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADFineGrainedPasswordPolicy](./Get-ADFineGrainedPasswordPolicy.md) - -[New-ADFineGrainedPasswordPolicy](./New-ADFineGrainedPasswordPolicy.md) - -[Remove-ADFineGrainedPasswordPolicy](./Remove-ADFineGrainedPasswordPolicy.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADForest.md b/docset/winserver2012-ps/activedirectory/Set-ADForest.md deleted file mode 100644 index ae293a238e..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADForest.md +++ /dev/null @@ -1,446 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adforest?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADForest - -## SYNOPSIS -Modifies an Active Directory forest. - -## SYNTAX - -``` -Set-ADForest [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] [-Identity] - [-PassThru] [-Server ] [-SPNSuffixes ] [-UPNSuffixes ] [] -``` - -## DESCRIPTION -The Set-ADForest cmdlet modifies the properties of an Active Directory forest. -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the Add, Replace, Clear and Remove parameters. - -The Identity parameter specifies the Active Directory forest to modify. -You can identify a forest by its fully qualified domain name (FQDN), GUID, DNS host name, or NetBIOS name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADForest cmdlet to retrieve a forest object and then pass the object through the pipeline to the Set-ADForest cmdlet. - -The Instance parameter provides a way to update a forest object by applying the changes made to a copy of the object. -When you set the Instance parameter to a copy of an Active Directory forest object that has been modified, the Set-ADForest cmdlet makes the same changes to the original forest object. -To get a copy of the object to modify, use the Get-ADForest object. -The Identity parameter is not allowed when you use the Instance parameter. -For more information about the Instance parameter, see the Instance parameter description. - -The following examples show how to modify the UPNSuffixes property of a forest object by using three methods: - --By specifying the Identity and the UPNSuffixes parameters - --By passing a forest object through the pipeline and specifying the UPNSuffixes parameter - --By specifying the Instance parameter. - -Method 1: Modify the UPNSuffixes property for the fabrikam.com forest by using the Identity and UPNSuffixes parameters. - -Set-ADForest -Identity fabrikam.com -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"} - -Method 2: Modify the UPNSuffixes property for the fabrikam.com forest by passing the fabrikam.com forest through the pipeline and specifying the UPNSuffixes parameter. - -Get-ADForest -Identity fabrikam.com | Set-ADForest -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"} - -Method 3: Modify the UPNSuffixes property for the fabrikam.com forest by using the Windows PowerShell command line to modify a local instance of the fabrikam.com forest. -Then set the Instance parameter to the local instance. - -$forest = Get-ADForest -Identity fabrikam.com - -$forest.UPNSuffixes = "fabrikam.com","fabrikam","corp.fabrikam.com" - -Set-ADForest -Instance $forest. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADForest -Identity fabrikam.com -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"} -``` - -Description - ------------ - -Set the UPNSuffixes property on the fabrikam.com forest. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADForest -Identity fabrikam.com -SPNSuffixes @{add="corp.fabrikam.com"} -``` - -Description - ------------ - -Add corp.fabrikam.com to the SPNSuffixes property on the forest fabrikam.com - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADForest | Set-ADForest -SPNSuffixes @{Add="corp.fabrikam.com";Remove="fabrikam"} -``` - -Description - ------------ - -Get the forest of the current logged on user and update the SPNSuffixes property. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-ADForest | Set-ADForest -UPNSuffixes $null -``` - -Description - ------------ - -Get the forest of the current logged on user and clear the UPNSuffixes property. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory forest object by providing one of the following attribute values. -The identifier in parentheses is the LDAP display name for the attribute. - -Fully qualified domain name - -Example: corp.contoso.com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -DNS host name - -Example: dnsServer.corp.contoso.com - -NetBIOS name - -Example: corp - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a forest object instance. - -This example shows how to set the parameter to a fully qualified domain name. - --Identity "corp.contoso.com" - -This example shows how to set this parameter to a forest object instance named "forestInstance". - --Identity $forestInstance - -```yaml -Type: ADForest -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SPNSuffixes -Modifies the list of service principal name (SPN) suffixes of the forest. -This parameter sets the multi-valued msDS-SPNSuffixes property of the cross-reference container. -This parameter uses the following syntax to add remove, replace, or clear SPN suffix values. - -Syntax: - -To add values: - --SPNSuffixes @{Add=value1,value2,...} - -To remove values: - --SPNSuffixes @{Remove=value3,value4,...} - -To replace values: - --SPNSuffixes @{Replace=value1,value2,...} - -To clear all values: - --SPNSuffixes $null - -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove SPN suffix values - -@{Add=value1,value2,...};@{Remove=value3,value4,...} - -The operators will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -The following example shows how to add and remove SPNSuffixes for a forest. - --@{Add="ContosoEurope", "ContosoAsia"};@{Remove="Contoso"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UPNSuffixes -Modifies the list of user principal name (UPN) suffixes of the forest. -This parameter sets the multi-valued msDS-UPNSuffixes property of the cross-reference container. -This parameter uses the following syntax to add remove, replace, or clear UPN suffix values. - -Syntax: - -To add values: - --UPNSuffixes @{Add=value1,value2,...} - -To remove values: - --UPNSuffixes @{Remove=value3,value4,...} - -To replace values: - --UPNSuffixes @{Replace=value1,value2,...} - -To clear all values: - --UPNSuffixes $null - -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove UPN suffix values - -@{Add=value1,value2,...};@{Remove=value3,value4,...} - -The operators will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -The following example shows how to add and remove UPN suffixes for a forest. - --UPNSuffixes @{Add="Fabrikam.Com", "Corp.Fabrikam.Com"}; @{Remove="NA.Fabrikam.Com","Europe.Fabrikam.Com"} - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADForest -A forest object is received by the Identity parameter. - -A forest object that was retrieved by using the Get-ADForest cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADForest -Returns the modified forest object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADForest](./Get-ADForest.md) - -[Set-ADForestMode](./Set-ADForestMode.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADForestMode.md b/docset/winserver2012-ps/activedirectory/Set-ADForestMode.md deleted file mode 100644 index 7b036517bb..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADForestMode.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adforestmode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADForestMode - -## SYNOPSIS -Sets the forest mode for an Active Directory forest. - -## SYNTAX - -``` -Set-ADForestMode [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-ForestMode] [-Identity] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADForestMode cmdlet sets the Forest mode for an Active Directory forest. -You specify the forest mode by setting the ForestMode parameter. -The forest mode can be set to the following values that are listed in order of functionality from lowest to highest. - -Windows2000Forest - -Windows2003InterimForest - -Windows2003Forest - -Windows2008Forest - -Windows2008R2Forest - -The Identity parameter specifies the Active Directory forest to modify. -You can identify a forest by its fully qualified domain name (FQDN), GUID, DNS host name, or NetBIOS name. -You can also specify the forest by passing a forest object through the pipeline. -For example, you can use the Get-ADForest cmdlet to retrieve a forest object and then pass the object through the pipeline to the Set-ADForestMode. - -Set-ADForestMode will prompt for confirmation by default. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADForestMode -Identity fabrikam.com -ForestMode Windows2003Forest -``` - -Description - ------------ - -Set the ForestMode to Windows2003Forest in the forest fabrikam.com. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$currentForest = Get-ADForest -Set-ADForestMode -Identity $currentForest -Server $currentForest.SchemaMaster -ForestMode Windows2008R2Forest -``` - -Description - ------------ - -Set the forest mode of the current logged on user's forest. -The Set operation targets the Schema Master FSMO to apply the update. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForestMode -Specifies the forest mode for an Active Directory forest. -The possible values for this parameter are: Windows2000Forest or 0 - -Windows2003InterimForest or 1 - -Windows2003Forest or 2 - -Windows2008Forest or 3 - -Windows2008R2Forest or 4 - -The values are listed in order of functionality from least to most. - -The following example shows how to set this parameter. - --ForestMode Windows2008R2Forest - -```yaml -Type: ADForestMode -Parameter Sets: (All) -Aliases: -Accepted values: Windows2000Forest, Windows2003InterimForest, Windows2003Forest, Windows2008Forest, Windows2008R2Forest, Windows2012Forest, UnknownForest - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory forest object by providing one of the following attribute values. -The identifier in parentheses is the LDAP display name for the attribute. - -Fully qualified domain name - -Example: corp.contoso.com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -DNS host name - -Example: dnsServer.corp.contoso.com - -NetBIOS name - -Example: corp - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to a forest object instance. - -This example shows how to set the parameter to a fully qualified domain name. - --Identity "corp.contoso.com" - -This example shows how to set this parameter to a forest object instance named "forestInstance". - --Identity $forestInstance - -```yaml -Type: ADForest -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADForest -A forest object is received by the Identity parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADForest -Returns the modified forest object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller - -## RELATED LINKS - -[Get-ADForest](./Get-ADForest.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADGroup.md b/docset/winserver2012-ps/activedirectory/Set-ADGroup.md deleted file mode 100644 index 144abb3f36..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADGroup.md +++ /dev/null @@ -1,725 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adgroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADGroup - -## SYNOPSIS -Modifies an Active Directory group. - -## SYNTAX - -### Identity -``` -Set-ADGroup [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-Description ] [-DisplayName ] - [-GroupCategory ] [-GroupScope ] [-HomePage ] [-Identity] - [-ManagedBy ] [-Partition ] [-PassThru] [-Remove ] [-Replace ] - [-SamAccountName ] [-Server ] [] -``` - -### Instance -``` -Set-ADGroup [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] -Instance - [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADGroup** cmdlet modifies the properties of an Active Directory group. -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the *Add*, *Replace*, *Clear*, and *Remove* parameters. - -The *Identity* parameter specifies the Active Directory group to modify. -You can identify a group by its distinguished name, GUID, security identifier, or Security Account Manager (SAM) account name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass a group object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADGroup** cmdlet to get a group object and then pass the object through the pipeline to the **Set-ADGroup** cmdlet. - -The *Instance* parameter provides a way to update a group object by applying the changes made to a copy of the object. -When you set the *Instance* parameter to a copy of an Active Directory group object that has been modified, the **Set-ADGroup** cmdlet makes the same changes to the original group object. -To get a copy of the object to modify, use the **Get-ADGroup** cmdlet. -The *Identity* parameter is not allowed when you use the *Instance* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - - -## EXAMPLES - -### Example 1: Set a property for a group -``` -PS C:\>Set-ADGroup -Server localhost:60000 -Identity "CN=AccessControl,DC=AppNC" -Description "Access Group" -Passthru -DistinguishedName : CN=AccessControl,DC=AppNC -GroupCategory : Security -GroupScope : DomainLocal -Name : AccessControl -ObjectClass : group -ObjectGUID : d65f5e8f-36da-4390-9840-8b9fde6282fc -SID : S-1-510474493-936115905-2782881406-1264922549-3814061485-1557022459 -``` - -This command sets the **Description** property of the group named AccessControl to Access Group on an Active Directory Application Mode (ADAM) instance. - -### Example 2: Set the description for filtered groups -``` -PS C:\>Get-ADGroup -Filter 'name -like "Access*"' | Set-ADGroup -Description "Access Group" -``` - -This command modifies the **Description** property on all groups that have a name that starts with Access by using the pipeline operator. - -### Example 3: Set a property by specifying an instance -``` -PS C:\>$Group = Get-ADGroup -Server localhost:60000 -Identity "CN=AccessControl,DC=AppNC" -PS C:\> $Group.Description = "Access Group" -PS C:\> Set-ADGroup -Instance $Group -Passthru -DistinguishedName : CN=AccessControl,DC=AppNC -GroupCategory : Security -GroupScope : DomainLocal -Name : AccessControl -ObjectClass : group -ObjectGUID : d65f5e8f-36da-4390-9840-8b9fde6282fc -SID : S-1-510474493-936115905-2782881406-1264922549-3814061485-1557022459 -``` - -This example sets the **Description** property on the AccessControl group by using the **Instance** parameter. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupCategory -Specifies the category of the group. -Possible values of this parameter are: - -Distribution or 0 - -Security or 1 - -This parameter sets the GroupCategory property of the group. -This parameter value combined with other group values sets the LDAP Display Name (ldapDisplayName) attribute named "groupType". - -The following example shows how to specify that a group is a security group. - --GroupCategory security - -```yaml -Type: ADGroupCategory -Parameter Sets: Identity -Aliases: -Accepted values: Distribution, Security - -Required: False -Position: Named -Default value: Security -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupScope -Specifies the group scope of the group. -Possible values of this parameter are: - -DomainLocal or 0 - -Global or 1 - -Universal or 2 - -This parameter sets the GroupScope property of a group object to the specified value. -The LDAP display name of this property is "groupType". - -The following example shows two ways to set this parameter to DomainLocal. - --GroupScope DomainLocal - --GroupScope 0 - -```yaml -Type: ADGroupScope -Parameter Sets: Identity -Aliases: -Accepted values: DomainLocal, Global, Universal - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the homePage property of an Active Directory object. -The LDAP Display Name (ldapDisplayName) for this property is "wWWHomePage". - -The following example shows how to set this parameter to a URL. - --HomePage "http://employees.contoso.com/sdavis" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory group object by providing one of the following values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -Security Accounts Manager (SAM) Account Name (sAMAccountName) - -Example: saradavisreports - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavisreports,OU=europe,CN=users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a group object instance named "ADGroupInstance". - --Identity $ADGroupInstance - -```yaml -Type: ADGroup -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of a group object to use to update the actual Active Directory group object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update group objects that have been retrieved by using the Get-ADGroup cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADGroup cmdlet to retrieve an instance of the ADGroup object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADGroup cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$groupInstance = Get-ADGroup -Identity "SaraDavisReports" - -Step 2: Modify one or more properties of the object instance. - -$groupInstance.GroupScope= "Global" - -Step3: Save your changes to "SaraDavisReports". - -Set-ADGroup -Instance $groupInstance - -```yaml -Type: ADGroup -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the SAMAccountName for an account object. -The LDAP display name (ldapDisplayName) for this property is "sAMAccountName". - -The following example shows how to specify this parameter. - --SAMAccountName "saradavis" - -Note: If the string value provided is not terminated with a '$' character, the system adds one if needed. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -A group object is received by the Identity parameter. - -A group object that was retrieved by using the Get-ADGroup cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADGroup -Returns the modified group object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Add-ADGroupMember](./Add-ADGroupMember.md) - -[Add-ADPrincipalGroupMembership](./Add-ADPrincipalGroupMembership.md) - -[Get-ADGroup](./Get-ADGroup.md) - -[Get-ADGroupMember](./Get-ADGroupMember.md) - -[Get-ADPrincipalGroupMembership](./Get-ADPrincipalGroupMembership.md) - -[New-ADGroup](./New-ADGroup.md) - -[Remove-ADGroup](./Remove-ADGroup.md) - -[Remove-ADGroupMember](./Remove-ADGroupMember.md) - -[Remove-ADPrincipalGroupMembership](./Remove-ADPrincipalGroupMembership.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADObject.md b/docset/winserver2012-ps/activedirectory/Set-ADObject.md deleted file mode 100644 index a7b4a1e372..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADObject.md +++ /dev/null @@ -1,636 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADObject - -## SYNOPSIS -Modifies an Active Directory object. - -## SYNTAX - -### Identity -``` -Set-ADObject [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-Description ] [-DisplayName ] [-Identity] - [-Partition ] [-PassThru] [-ProtectedFromAccidentalDeletion ] [-Remove ] - [-Replace ] [-Server ] [] -``` - -### Instance -``` -Set-ADObject [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] -Instance - [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADObject** cmdlet modifies the properties of an Active Directory object. -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the *Add*, *Replace*, *Clear*, and *Remove* parameters. - -The *Identity* parameter specifies the Active Directory object to modify. -You can identify an object by its distinguished name or GUID. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADObject** cmdlet to retrieve an object and then pass the object through the pipeline to the **Set-ADObject** cmdlet. - -The *Instance* parameter provides a way to update an object by applying the changes made to a copy of the object. -When you set the *Instance* parameter to a copy of an Active Directory object that has been modified, the **Set-ADObject** cmdlet makes the same changes to the original object. -To get a copy of the object to modify, use the **Get-ADObject** object. -The *Identity* parameter is not allowed when you use the *Instance* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - -For Active Directory Lightweight Directory Services (AD LDS) environments, the *Partition* parameter must be specified except in the following two conditions: - -- The cmdlet is run from an Active Directory provider drive. -- A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### Example 1: Set a property on an object by distinguished name -``` -PS C:\> Set-ADObject -Identity 'CN=PattiFu Direct Reports,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM' -Description "Distribution List of Patti Fuller Direct Reports" -``` - -This command sets the **Description** property on the object with the distinguished name CN=PattiFu Direct Reports,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### Example 2: Add a site to a property for an object -``` -PS C:\> Set-ADObject -Identity 'CN=DEFAULTIPSITELINK,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM' -Add @{siteList='CN=BO3,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM'} -Partition 'CN=Configuration,DC=FABRIKAM,DC=COM' -``` - -This command adds the site CN=BO3,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM to the property **siteList** on the object with the distinguished name CN=DEFAULTIPSITELINK,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM. - -### Example 3: Add URLs to an object property -``` -PS C:\> $UrlValues = @() -PS C:\> $UrlValues += "www.contoso.com" -PS C:\> $UrlValues += "www.fabrikam.com" -PS C:\> Set-ADObject -Identity "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Add @{url=$UrlValues} -``` - -This command adds two new URLs to the **urlValues** property in the object with the GUID cdadd380-d3a8-4fd1-9d30-5cf72d94a056. - -### Example 4: Set values for a multi-valued attribute -``` -PS C:\> $UrlValues = @() -PS C:\> $UrlValues += "www.contoso.com" -PS C:\> $UrlValues += "www.fabrikam.com" -PS C:\> Set-ADObject -Identity "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Replace @{url=$UrlValues;description="Patti Fuller"} -``` - -This command replaces the old values of the multi-valued attribute **url** with the new values and sets the value of the attribute **description**. - -### Example 5: Remove a value from an attribute -``` -PS C:\> Set-ADObject -Identity "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Remove @{url="www.contoso.com"} -Replace @{description="Patti Fuller (European Manager)"} -``` - -This command removes the specified value from the **url** attribute and sets the value of the **description** attribute. - -### Example 6: Set a UAC bit on an object -``` -PS C:\> $MyComp = Get-ADObject -Identity "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Properties "userAccountControl","description" -PS C:\> $MyComp.userAccountControl = $MyComp.userAccountControl -bor 50 -PS C:\> $MyComp.description = "Setting a new UAC on the object" -PS C:\> Set-ADObject -Instance $MyComp -``` - -This command sets a new User Access Control (UAC) bit on an object by updating the **userAccountControl** attribute, and sets the value of the **description** attribute. - -### Example 7: Protect an object from accidental deletion -``` -PS C:\> Set-ADObject -Identity "CN=InternalApps,DC=AppNC" -protectedFromAccidentalDeletion $True -Server "FABRIKAM-SRV1:60000" -``` - -This command sets container CN=InternalApps,DC=AppNC in an AD LDS instance to be protected from accidental deletion. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of an Active Directory object to use to update the actual Active Directory object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update Active Directory objects that have been retrieved by using the Get-ADObject cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADObject cmdlet to retrieve an instance of the object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADObject cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$objectInstance = Get-ADObject -Identity "CN=someObject, DC=contoso,DC=com" - -Step 2: Modify one or more properties of the object instance. - -$objectInstance.Description = "New Description" - -Step3: Save your changes to the object - -Set-ADObject -Instance $objectInstance - -```yaml -Type: ADObject -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -An Active Directory object is received by the Identity parameter. -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -An object that was retrieved by using the Get-ADObject cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADObject -Returns the modified object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[New-ADObject](./New-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADOrganizationalUnit.md b/docset/winserver2012-ps/activedirectory/Set-ADOrganizationalUnit.md deleted file mode 100644 index 404f78c57c..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADOrganizationalUnit.md +++ /dev/null @@ -1,770 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adorganizationalunit?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADOrganizationalUnit - -## SYNOPSIS -Modifies an Active Directory organizational unit. - -## SYNTAX - -### Identity -``` -Set-ADOrganizationalUnit [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-City ] - [-Clear ] [-Country ] [-Credential ] [-Description ] - [-DisplayName ] [-Identity] [-ManagedBy ] [-Partition ] - [-PassThru] [-PostalCode ] [-ProtectedFromAccidentalDeletion ] [-Remove ] - [-Replace ] [-Server ] [-State ] [-StreetAddress ] [] -``` - -### Instance -``` -Set-ADOrganizationalUnit [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADOrganizationalUnit** cmdlet modifies the properties of an Active Directory organizational unit (OU). -You can modify commonly used property values by using the cmdlet parameters. -**Property** values that are not associated with cmdlet parameters can be modified by using the *Add*, *Remove*, *Replace*, and *Clear* parameters. - -The *Identity* parameter specifies the Active Directory organizational unit to modify. -You can identify an organizational unit by its distinguished name or GUID. - -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADOrganizationalUnit** cmdlet to retrieve an organizational unit object and then pass the object through the pipeline to the **Set-ADOrganizationalUnit** cmdlet. - -The *Instance* parameter provides a way to update an organizational unit object by applying the changes made to a copy of the object. -When you set the *Instance* parameter to a copy of an Active Directory organizational unit object that has been modified, the **Set-ADOrganizationalUnit** cmdlet makes the same changes to the original organizational unit object. -To get a copy of the object to modify, use the **Get-ADOrganizationalUnit** object. -When you specify the *Instance* parameter you should not pass the *Identity* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - -For Active Directory Lightweight Directory Services (AD LDS) environments, the *Partition* parameter must be specified except in the following two conditions: - -- The cmdlet is run from an Active Directory provider drive. -- A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADOrganizationalUnit -Identity "OU=UserAccounts,DC=FABRIKAM,DC=COM" -Description "This Organizational Unit holds all of the users accounts of FABRIKAM.COM" -``` - -Description - ------------ - -Sets the description of the OrganizationalUnit with distinguishedName OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADOrganizationalUnit -Identity "OU=UserAccounts,DC=FABRIKAM,DC=COM" -ProtectedFromAccidentalDeletion $false -``` - -Description - ------------ - -Sets the ProtectedFromAccidentalDeletion property to $false on the OrganizationalUnit with distinguishedName OU=UserAccounts,DC=FABRIKAM,DC=COM. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-ADOrganizationalUnit -Identity "OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM" -Country "AU" -StreetAddress "45 Martens Place" -City Balmoral -State QLD -PostalCode 4171 -Replace @{co="Australia"} -``` - -Description - ------------ - -Sets the Country, City and State, PostalCode and co properties on the OrganizationalUnit 'OU=AsiaPacific,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$EuropeSalesOU = Get-ADOrganizationalUnit "OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM" -$EuropeSalesOU.Country = "UK" -$EuropeSalesOU.StreetAddress = "22 Station Rd" -$EuropeSalesOU.City = "QUARRINGTON" -$EuropeSalesOU.PostalCode = "NG34 0NI" -$EuropeSalesOU.co ="United Kingdom" -Set-ADOrganizationalUnit -Instance $EuropeSalesOU -``` - -Description - ------------ - -Creates a new OrganizationalUnit using the OrganizationalUnit 'OU=Europe,OU=Sales,OU=UserAccounts,DC=FABRIKAM,DC=COM' as a template. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Set-ADOrganizationalUnit -Identity "OU=Managed,DC=AppNC" -Server "FABRIKAM-SRV1:60000" -Country "UK" -``` - -Description - ------------ - -Set the Country property of the OrganizationalUnit 'OU=Managed,DC=AppNC' in an AD LDS instance. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the user's town or city. -This parameter sets the City property of a user. -The LDAP display name (ldapDisplayName) of this property is "l". - -The following example shows how set this parameter. - --City "Las Vegas" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -Specifies the country or region code for the user's language of choice. -This parameter sets the Country property of a user object. -The LDAP Display Name (ldapDisplayName) of this property is "c". -This value is not used by Windows 2000. - -The following example shows how set this parameter. - --Country "IN" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADOrganizationalUnit -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of an organizational unit object to use to update the actual Active Directory organizational unit object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update organizational unit objects that have been retrieved by using the Get-ADOrganizationalUnit cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADOrganizationalUnit cmdlet to retrieve an instance of the ADOrganizationalUnit object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADOrganizationalUnit cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$organizationalUnitInstance = Get-ADOrganizationalUnit -Identity "OU=Accounting,DC=corp,DC=contoso,DC=com" - -Step 2: Modify one or more properties of the object instance. - -$organizationalUnitInstance.ManagedBy = "CN=SaraDavisGroup,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -Step3: Save your changes to Accounting. - -Set-ADOrganizationalUnit -Instance $organizationalUnitInstance - -```yaml -Type: ADOrganizationalUnit -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the user's postal code or zip code. -This parameter sets the PostalCode property of a user. -The LDAP Display Name (ldapDisplayName) of this property is "postalCode". - -The following example shows how to set this parameter. - --PostalCode "28712" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Specifies the user's or Organizational Unit's state or province. -This parameter sets the State property of a User or Organizational Unit object. -The LDAP display name (ldapDisplayName) of this property is "st". - -The following example shows how set this parameter. - --State "Nevada" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetAddress -Specifies the organizational unit's street address. -This parameter sets the StreetAddress property of a organizational unit object. -The LDAP display name (ldapDisplayName) of this property is "street". - -The following example shows how to set this parameter. - --StreetAddress "1200 Main Street" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOrganizationalUnit -An organizational unit object is received by the Identity parameter. - -An organizational unit object that was retrieved by using the Get-ADOrganizationalUnit cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADOrganizationalUnit -Returns the modified organizational unit object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADOrganizationalUnit](./Get-ADOrganizationalUnit.md) - -[New-ADOrganizationalUnit](./New-ADOrganizationalUnit.md) - -[Remove-ADOrganizationalUnit](./Remove-ADOrganizationalUnit.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADReplicationConnection.md b/docset/winserver2012-ps/activedirectory/Set-ADReplicationConnection.md deleted file mode 100644 index 0901744d1c..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADReplicationConnection.md +++ /dev/null @@ -1,510 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adreplicationconnection?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADReplicationConnection - -## SYNOPSIS -Sets properties on Active Directory replication connections. - -## SYNTAX - -### Identity -``` -Set-ADReplicationConnection [-WhatIf] [-Confirm] [-Add ] [-AuthType ] - [-Clear ] [-Credential ] [-Identity] [-PassThru] - [-Remove ] [-Replace ] [-ReplicateFromDirectoryServer ] - [-ReplicationSchedule ] [-Server ] [] -``` - -### Instance -``` -Set-ADReplicationConnection [-WhatIf] [-Confirm] [-AuthType ] [-Clear ] - [-Credential ] -Instance [-PassThru] [-Server ] - [] -``` - -## DESCRIPTION -The Set-ADReplicationConnection cmdlet sets properties on Active Directory replication connections. -Connections are used to enable domain controllers to replicate with each other. -A connection defines a one-way, inbound route from one domain controller, the source, to another domain controller, the destination. -The Kerberos consistency checker (KCC) reuses existing connections where it can, deletes unused connections, and creates new connections if none exist that meet the current need. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADReplicationConnection "5f98e288-19e0-47a0-9677-57f05ed54f6b" -ReplicateFromDirectoryServer corp-DC01 -``` - -Description - ------------ - -Set the replication connection with name '5f98e288-19e0-47a0-9677-57f05ed54f6b' to replicate from corp-DC01. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule; -$schedule.ResetSchedule(); -$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty"); -Get-ADReplicationConnection -Filter "ReplicateFromDirectoryServer -eq 'corp-DC01'" -Properties ReplicationSchedule | % {Set-ADReplicationConnection $_ - ReplicationSchedule $schedule} -``` - -Description - ------------ - -Get all the replication connections in the directory that replicate from corp-DC01. -Set the daily replication schedule on these connection objects. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationConnection -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of an Active Directory object to use as a template for a new Active Directory object. - -You can use an instance of an existing Active Directory object as a template or you can construct a new Active Directory object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new Active Directory object. - -Method 1: Use an existing Active Directory object as a template for a new object. -To retrieve an instance of an existing Active Directory object, use a cmdlet such as Get-ADObject. -Then provide this object to the Instance parameter of the New-ADObject cmdlet to create a new Active Directory object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADObject -Identity saraDavisDesktop - -New-ADObject -Name "ellenAdamsDesktop" -Instance $ObjectInstance -Type "computer" - -Method 2: Create a new ADObject and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADObject cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADObject $objectInstance.Description = "Ellen Adams New Computer" New-ADObject -Name ellenAdamsDesktop -Instance $ObjectInstance -Type computer - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationConnection -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicateFromDirectoryServer -Specifies the domain controller to use as a source for this replication connection. - -```yaml -Type: ADDirectoryServer -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSchedule -Specifies the schedule on which the source server is available for replication. - -Replication occurs at intervals that administrators can schedule so that use of expensive WAN links is managed. -Use this parameter to specify the replication intervals. -For more information on how replication topology works, go to http://go.microsoft.com/fwlink/?LinkId=223932. - -To specify the replication schedule, - -1. Create a new Active Directory schedule object. - - Example: - - `$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule;` - -2. Edit the schedule on the Active Directory schedule object. - - Example: - - `$schedule.ResetSchedule();` - - `$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty");` - -3. Using the Active Directory schedule object, set the replication schedule of the connection - - `Set-ADReplicationConnection "5f98e288-19e0-47a0-9677-57f05ed54f6b" -ReplicationSchedule $schedule` - -For more information on the ActiveDirectorySchedule class, go to http://go.microsoft.com/fwlink/?LinkId=223933. - -```yaml -Type: ActiveDirectorySchedule -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationConnection -A connection object is received by the Identity parameter. - -A connection object that was retrieved by using the Get-ADReplicationConnection cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationConnection - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationConnection](./Get-ADReplicationConnection.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSite.md b/docset/winserver2012-ps/activedirectory/Set-ADReplicationSite.md deleted file mode 100644 index 8efb43486f..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSite.md +++ /dev/null @@ -1,795 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adreplicationsite?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADReplicationSite - -## SYNOPSIS -Sets the replication properties for an Active Directory site. - -## SYNTAX - -### Identity -``` -Set-ADReplicationSite [-WhatIf] [-Confirm] [-Add ] [-AuthType ] - [-AutomaticInterSiteTopologyGenerationEnabled ] [-AutomaticTopologyGenerationEnabled ] - [-Clear ] [-Credential ] [-Description ] [-Identity] - [-InterSiteTopologyGenerator ] [-ManagedBy ] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-RedundantServerTopologyEnabled ] [-Remove ] - [-Replace ] [-ReplicationSchedule ] [-ScheduleHashingEnabled ] - [-Server ] [-TopologyCleanupEnabled ] [-TopologyDetectStaleEnabled ] - [-TopologyMinimumHopsEnabled ] [-UniversalGroupCachingEnabled ] - [-UniversalGroupCachingRefreshSite ] - [-WindowsServer2000BridgeheadSelectionMethodEnabled ] - [-WindowsServer2000KCCISTGSelectionBehaviorEnabled ] [-WindowsServer2003KCCBehaviorEnabled ] - [-WindowsServer2003KCCIgnoreScheduleEnabled ] - [-WindowsServer2003KCCSiteLinkBridgingEnabled ] [] -``` - -### Instance -``` -Set-ADReplicationSite [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADReplicationSite cmdlet is used to set the properties for an Active Directory site that is being used for replication. -Sites are used in Active Directory to either enable clients to discover network resources (published shares, domain controllers) close to the physical location of a client computer or to reduce network traffic over wide area network (WAN) links. -Sites can also be used to optimize replication between domain controllers. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADReplicationSite NorthAmerica -InterSiteTopologyGenerator corp-DC02 -AutomaticInterSiteTopologyGenerationEnabled $false -``` - -Description - ------------ - -Set the properties of the site with name 'NorthAmerica' to prevent its intersite topology generator (ISTG) at 'corp-DC02' from generating connections for intersite replication. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSite -Filter * | % {Set-ADReplicationSite $_ -ScheduleHashingEnabled $true} -``` - -Description - ------------ - -Returns all the sites in the directory and sets the ScheduleHashingEnabled propertyto spread replication start times randomly across the entire schedule interval rather than just the first quarter of the interval.. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule; -$schedule.ResetSchedule(); -$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty"); -Set-ADReplicationSite "Asia" -ReplicationSchedule $schedule -``` - -Description - ------------ - -Set the daily replication schedule of the site with name 'Asia'. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticInterSiteTopologyGenerationEnabled -Prevents the KCC that functions as the intersite topology generator (ISTG) from generating connections for intersite replication. -Use this option when you want to create manual intersite connections (disable the ISTG) but retain the KCC to generate intrasite connections. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticTopologyGenerationEnabled -When enabled, prevents the KCC from generating intrasite connections on all servers in the site. -Disable this option if you use manual connections and do not want the KCC to build connections automatically. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSite -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a site object to use as a template for a new site object. - -You can use an instance of an existing site object as a template or you can construct a new site object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new site object. - -Method 1: Use an existing site object as a template for a new object. -To retrieve an instance of an existing site object, use a cmdlet such as Get-ADReplicationSite. -Then provide this object to the Instance parameter of the New-ADReplicationSite cmdlet to create a new site object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSite -Identity NorthAmerica - -New-ADReplicationSite -Name "SouthAmerica" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSite and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSite cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSite - -$objectInstance.Description = North America" - -New-ADReplicationSite -Name "NorthAmerica" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSite -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterSiteTopologyGenerator -The server acting as the inter-site topology generator for this site. - -```yaml -Type: ADDirectoryServer -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedBy -Specifies the user or group that manages the object by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. - -Distinguished Name - -Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy". - -The following example shows how to specify this parameter. - --ManagedBy ContosoAdmins - -```yaml -Type: ADPrincipal -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedundantServerTopologyEnabled -Creates redundant connections between sites before a failure takes place. -When enabled, disables KCC failover. -Requires that automatic detection of failed connections also be disabled (+IS_TOPL_DETECT_STALE_DISABLED). - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSchedule -Default replication schedule for connections within this site (intra-site replication). - -```yaml -Type: ActiveDirectorySchedule -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScheduleHashingEnabled -Spreads replication start times randomly across the entire schedule interval rather than just the first quarter of the interval. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TopologyCleanupEnabled -When enabled, this optional parameter prevents the Knowledge Consistency Checker (KCC) from removing connection objects that it does not need. -Disable this option if you want to take responsibility for removing old redundant connections. -Alternatively, to control or augment the topology, you can use manual connections, which the KCC does not delete. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TopologyDetectStaleEnabled -This parameter option prevents the Knowledge Consistency Checker (KCC) from excluding servers that are unreachable from the topology; that is, the KCC does use an alternate server to reroute replication. -Use this option only if network communication is very unstable and brief outages are expected. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TopologyMinimumHopsEnabled -When enabled, this parameter prevents the Knowledge Consistency Checker (KCC) from generating optimizing connections in the ring topology of intrasite replication. -Optimizing connections reduce the replication latency in the site and disabling them is not recommended. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniversalGroupCachingEnabled -If this parameter is true, it indicates this site caches universal groups, which are those groups cached on global catalog (GC) servers. -It can be useful in sites with no GC servers available locally. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UniversalGroupCachingRefreshSite -If universal group caching is enabled, this parameter sets the name of the site from which the cache is pulled. - -```yaml -Type: ADReplicationSite -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsServer2000BridgeheadSelectionMethodEnabled -Implements the Windows 2000 Server method of selecting a single bridgehead server per directory partition and transport. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsServer2000KCCISTGSelectionBehaviorEnabled -When enabled, this parameter implements the Windows 2000 Server method of Intersite Topology Generator (ISTG) selection. -By default, it is disabled. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsServer2003KCCBehaviorEnabled -Implements Knowledge Consistency Checker (KCC) operation that is consistent with Windows Server 2003 forest functional level. -This option can be set if all domain controllers in the site are running Windows Server 2003. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsServer2003KCCIgnoreScheduleEnabled -When the forest functional level Windows Server 2003 or Windows Server 2003 interim is in effect, provides KCC control of the ability to ignore schedules (replication occurs at the designated intervals and is always available). - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsServer2003KCCSiteLinkBridgingEnabled -When the forest functional level Windows Server 2003 or Windows Server 2003 interim is in effect, provides Knowledge Consistency Checker (KCC) control of the ability to enable or disable site link bridging. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSite -A site object is received by the Identity parameter. - -A site object that was retrieved by using the Get-ADReplicationSite cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSite - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSite](./Get-ADReplicationSite.md) - -[New-ADReplicationSite](./New-ADReplicationSite.md) - -[Remove-ADReplicationSite](./Remove-ADReplicationSite.md) diff --git a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSiteLink.md b/docset/winserver2012-ps/activedirectory/Set-ADReplicationSiteLink.md deleted file mode 100644 index 2961232eaa..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSiteLink.md +++ /dev/null @@ -1,567 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adreplicationsitelink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADReplicationSiteLink - -## SYNOPSIS -Sets the properties for an Active Directory site link. - -## SYNTAX - -### Identity -``` -Set-ADReplicationSiteLink [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Cost ] [-Credential ] [-Description ] [-Identity] - [-PassThru] [-Remove ] [-Replace ] [-ReplicationFrequencyInMinutes ] - [-ReplicationSchedule ] [-Server ] [-SitesIncluded ] - [] -``` - -### Instance -``` -Set-ADReplicationSiteLink [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Instance ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADReplicationSiteLink cmdlet can be used to set properties on an Active Directory site link. -A site link connects two or more sites. -Site links reflect the administrative policy for how sites are to be interconnected and the methods used to transfer replication traffic. -You must connect sites with site links so that domain controllers at each site can replicate Active Directory changes. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADReplicationSiteLink "Europe-Asia" -SitesIncluded @{Add="Asia2";Remove="Asia"} -``` - -Description - ------------ - -Add site 'Asia2' to the site link 'Europe-Asia', and remove site 'Asia'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLink -Filter "ReplicationFrequencyInMinutes -ge 60" -Properties Cost | % {Set-ADReplicationSiteLink $_ -Cost 200} -``` - -Description - ------------ - -Get all the site links in the directory with replication frequency greater than or equal to 60 minutes. -Set the Cost property on these site link objects to 200. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -PS C:\>$replicationSchedule = New-Object System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule -$replicationSchedule.SetDailySchedule("Nine","Zero","Zero","Zero") -Set-ADReplicationSiteLink "NorthAmerica-SouthAmerica" -ReplicationSchedule $replicationSchedule -``` - -Description - ------------ - -Set the daily replication schedule of the site link with name 'NorthAmerica-SouthAmerica'. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Set-ADReplicationSiteLink "Europe-Asia" -Replace @{'options'=1} -``` - -Description - ------------ - -Enable change notification on the site link with name 'Europe-Asia'. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cost -Specifies the cost to be placed on the site link. -For more information on determining the cost, see the following topic called "Determining the Cost" in the TechNet Library: http://go.microsoft.com/fwlink/?LinkId=221871 - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica-SouthAmerica,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSiteLink -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a site link object to use as a template for a new site link object. - -You can use an instance of an existing site link object as a template or you can construct a new site link object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new site link object. - -Method 1: Use an existing site link object as a template for a new object. -To retrieve an instance of an existing site link object, use a cmdlet such as Get-ADReplicationSiteLink. -Then provide this object to the Instance parameter of the New-ADReplicationSiteLink cmdlet to create a new site link object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSiteLink -Identity "NorthAmerica-SouthAmerica" - -New-ADReplicationSiteLink -Name "Europe-Asia" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSiteLink and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSiteLink cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLink - -$objectInstance.Description = "Between North America and South America." - -New-ADReplicationSiteLink -Name "NorthAmerica-SouthAmerica"-Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSiteLink -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationFrequencyInMinutes -Species the frequency (in minutes) for which replication will occur where this site link is in use between sites. -Active Directory preserves bandwidth between sites by minimizing the frequency of replication and by allowing you to schedule the availability of site links for replication. -By default, intersite replication across each site link occurs every 180 minutes (3 hours). -You can adjust this frequency to match your specific needs. -Be aware that increasing this frequency increases the amount of bandwidth used by replication. - -```yaml -Type: Int32 -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSchedule -Specifies the default replication schedule for any connections within this site link (intra-site replication). -This allows you to schedule the availability of site links for use by replication. -By default, a site link is available to carry replication traffic 24 hours a day, 7 days a week. -You can limit this schedule to specific days of the week and times of day. -You can, for example, schedule intersite replication so that it only occurs after normal business hours. - -```yaml -Type: ActiveDirectorySchedule -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SitesIncluded -Specifies the list of sites included in the site link. -For Set-ADReplicationSiteLink operations, you can add or include new sites within an existing site link by specifying them using this parameter. -You do not have to specify all previously listed sites already within this link. - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink -A site link object is received by the Identity parameter. - -A site link object that was retrieved by using the Get-ADReplicationSitLink cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSiteLink](./Get-ADReplicationSiteLink.md) - -[New-ADReplicationSiteLink](./New-ADReplicationSiteLink.md) - -[Remove-ADReplicationSiteLink](./Remove-ADReplicationSiteLink.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSiteLinkBridge.md b/docset/winserver2012-ps/activedirectory/Set-ADReplicationSiteLinkBridge.md deleted file mode 100644 index b32d776b52..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSiteLinkBridge.md +++ /dev/null @@ -1,486 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adreplicationsitelinkbridge?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADReplicationSiteLinkBridge - -## SYNOPSIS -Sets the properties of a replication site link bridge in Active Directory. - -## SYNTAX - -### Identity -``` -Set-ADReplicationSiteLinkBridge [-WhatIf] [-Confirm] [-Add ] [-AuthType ] - [-Clear ] [-Credential ] [-Description ] - [-Identity] [-PassThru] [-Remove ] [-Replace ] - [-Server ] [-SiteLinksIncluded ] [] -``` - -### Instance -``` -Set-ADReplicationSiteLinkBridge [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Instance ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADReplicationSiteLinkBridge object sets the properties for a replication site link bridge in Active Directory. -A site link bridge connects two or more site links and enables transitivity between site links. -Each site link in a bridge must have a site in common with another site link in the bridge. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded @{Add='NorthAmerica-Europe2','Europe2-Asia';Remove='NorthAmerica-Europe','Europe-Asia'} -``` - -Description - ------------ - -Update the site link bridge 'NorthAmerica-Asia' to use 'Europe2' instead of 'Europe'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSiteLinkBridge -Filter "SiteLinksIncluded -eq 'NorthAmerica-Europe' -and SiteLinksIncluded -eq 'Europe-Asia'" -Properties SiteLinksIncluded | % {Set-ADReplicationSiteLinkBridge $_ -SiteLinksIncluded @{Add='NorthAmerica-Europe2','Europe2-Asia';Remove='NorthAmerica-Europe','Europe-Asia'}} -``` - -Description - ------------ - -Get all the site link bridges in the directory that includes site links 'NorthAmerica-Europe' and 'Europe-Asia'. -Update the site link bridge objects to use 'Europe2' instead of 'Europe'. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=NorthAmerica-Asia,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSiteLinkBridge -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a site link bridge object to use as a template for a new site link bridge object. - -You can use an instance of an existing site link bridge object as a template or you can construct a new site link bridge object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new site link bridge object. - -Method 1: Use an existing site link bridge object as a template for a new object. -To retrieve an instance of an existing site link bridge object, use a cmdlet such as Get-ADReplicationSiteLinkBridge. -Then provide this object to the Instance parameter of the New-ADReplicationSiteLinkBridge cmdlet to create a new site link bridge object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSiteLinkBridge -Identity "NorthAmerica-Asia" - -New-ADReplicationSiteLinkBridge -Name "SouthAmerica-Asia" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSiteLinkBridge and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSiteLinkBridge cmdlet to create the new Active Directory object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge - -$objectInstance.Description = Between North America and Asia." - -New-ADReplicationSiteLinkBridge -Name "NorthAmerica-Asia" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSiteLinkBridge -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteLinksIncluded -Specifies the list of site links that are included in this site link bridge. -Accepted values for this parameter are the distinguished name (DN), a GUID, or the name of a site link. - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge -A site link bridge object is received by the Identity parameter. - -A site link bridge object that was retrieved by using the Get-ADReplicationSiteLinkBridge cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSiteLinkBridge](./Get-ADReplicationSiteLinkBridge.md) - -[New-ADReplicationSiteLinkBridge](./New-ADReplicationSiteLinkBridge.md) - -[Remove-ADReplicationSiteLinkBridge](./Remove-ADReplicationSiteLinkBridge.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSubnet.md b/docset/winserver2012-ps/activedirectory/Set-ADReplicationSubnet.md deleted file mode 100644 index 7d6db119cc..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADReplicationSubnet.md +++ /dev/null @@ -1,492 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adreplicationsubnet?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADReplicationSubnet - -## SYNOPSIS -Sets the properties of an Active Directory replication subnet object. - -## SYNTAX - -### Identity -``` -Set-ADReplicationSubnet [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-Description ] [-Identity] [-Location ] - [-PassThru] [-Remove ] [-Replace ] [-Server ] [-Site ] - [] -``` - -### Instance -``` -Set-ADReplicationSubnet [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Instance ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADReplicationSubnet cmdlet sets the properties of an Active Directory replication subnet object. -Subnet objects (class subnet) define network subnets in Active Directory. -A network subnet is a segment of a TCP/IP network to which a set of logical IP addresses is assigned. -Subnets group computers in a way that identifies their physical proximity on the network. -Subnet objects in Active Directory are used to map computers to sites. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADReplicationSubnet "10.0.0.12/22" -Site Asia -Location "Tokyo,Japan" -``` - -Description - ------------ - -Set the properties of the subnet named '10.0.0.12/22'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADReplicationSubnet -Filter "Location -like '*Japan'" -Properties Site | % {Set-ADReplicationSubnet $_ -Site Asia} -``` - -Description - ------------ - -Get all the subnets in the directory that are in Japan, and set 'Asia' as their associated site. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=10.0.0.0/25,CN=Subnets,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADReplicationSubnet -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a subnet object to use as a template for a new subnet object. - -You can use an instance of an existing subnet object as a template or you can construct a new subnet object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new subnet object. - -Method 1: Use an existing subnet object as a template for a new object. -To retrieve an instance of an existing subnet object, use a cmdlet such as Get-ADReplicationSubnet. -Then provide this object to the Instance parameter of the New-ADReplicationSubnet cmdlet to create a new subnet object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADReplicationSubnet -Identity "10.0.0.0/25" - -New-ADReplicationSubnet -Name "12.0.0.0/25" -Instance $ObjectInstance - -Method 2: Create a new ADReplicationSubnet and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADReplicationSubnet cmdlet to create the new subnet object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSubnet - -$objectInstance.Description = Branch office subnet" - -New-ADReplicationSubnet -Name "10.0.0.0/25" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADReplicationSubnet -Parameter Sets: Instance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Location -Can be used to describe the physical location of this subnet. -This value may be displayed or made visible when the subnet object appears in other Active Directory administrative tools. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Site -Specifies the site associated with this subnet. - -```yaml -Type: ADReplicationSite -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet -A subnet object is received by the Identity parameter. - -A subnet object that was retrieved by using the Get-ADReplicationSubnet cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet - -## NOTES - -## RELATED LINKS - -[Get-ADReplicationSubnet](./Get-ADReplicationSubnet.md) - -[New-ADReplicationSubnet](./New-ADReplicationSubnet.md) - -[Remove-ADReplicationSubnet](./Remove-ADReplicationSubnet.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADResourceProperty.md b/docset/winserver2012-ps/activedirectory/Set-ADResourceProperty.md deleted file mode 100644 index d3a698e50e..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADResourceProperty.md +++ /dev/null @@ -1,582 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adresourceproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADResourceProperty - -## SYNOPSIS -Modifies a resource property in Active Directory. - -## SYNTAX - -### Identity -``` -Set-ADResourceProperty [-WhatIf] [-Confirm] [-Add ] [-AppliesToResourceTypes ] - [-AuthType ] [-Clear ] [-Credential ] [-Description ] - [-DisplayName ] [-Enabled ] [-Identity] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Remove ] [-Replace ] [-Server ] - [-SharesValuesWith ] [-SuggestedValues ] [] -``` - -### Instance -``` -Set-ADResourceProperty [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADResourceProperty cmdlet can be used to modify a resource property in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$us = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("US", "United States of America", "United States of America"); -$jp = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("JP", "Japan", "Japan"); -Set-ADResourceProperty Country -SuggestedValues $us,$jp -``` - -Description - ------------ - -Set the suggested values of the resource property with display name 'Country' to 'US' and 'JP'. -Applications using this resource property would allow their users to specify one of the suggested values as this resource property's value. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADResourceProperty Country -SharesValuesWith Country -``` - -Description - ------------ - -Sets the resource property with display name 'Country' to reference an existing claim type named 'Country' for its suggested values. -This enables the resource property to be always valid for comparisons with the referenced claim type in a central access rule. - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppliesToResourceTypes -Specifies the list of resource types that this property applies to. -For Set-ADResourceProperty operations, you can add or include new resource types within an existing property by specifying them using this parameter. -You do not have to specify all previously listed resource types already within this property. - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Displays the name of the resource property. -The display name of the resource property must be unique. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies if the resource property is enabled. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourceProperty -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a resource property object to use as a template for a new resource property object. - -You can use an instance of an existing resource property object as a template or you can construct a new resource property object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new resource property object. - -Method 1: Use an existing resource property object as a template for a new object. -To retrieve an instance of an existing resource property object, use a cmdlet such as Get-ADResourceProperty. -Then provide this object to the Instance parameter of the New-ADResourceProperty cmdlet to create a new resource property object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADResourceProperty -Identity "Country" - -New-ADResourceProperty -Name "Region" -Instance $ObjectInstance - -Method 2: Create a new ADResourceProperty and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADResourceProperty cmdlet to create the new resource property object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourceProperty - -$objectInstance.Description = "Non-Disclosure Agreement (NDA)" - -New-ADResourceProperty -Name "NDA" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADResourceProperty -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharesValuesWith -Use this parameter to create a reference resource property. -Reference resource properties do not provide their own suggested values, but rather use the suggested values from the claim type object specified in this parameter. -This enables the resource property to be always valid for comparisons with the referred claim type in a central access rule. - -```yaml -Type: ADClaimType -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuggestedValues -Specifies one or more suggested values for the resource property. -An application may choose to present this list of suggested values for the user to choose from. -When RestrictValues is set to true, the application should restrict the user to pick values from this list only. - -Example: - -$us = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("US", "United States of America", "United States of America"); - -$jp = New-Object Microsoft.ActiveDirectory.Management.ADSuggestedValueEntry("JP", "Japan", "Japan"); - -New-ADResourceProperty Country -ResourcePropertyValueType MS-DS-MultivaluedChoice -SuggestedValues $us,$jp - -```yaml -Type: ADSuggestedValueEntry[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourceProperty - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADResourceProperty - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADResourcePropertyList.md b/docset/winserver2012-ps/activedirectory/Set-ADResourcePropertyList.md deleted file mode 100644 index 77aa86152a..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADResourcePropertyList.md +++ /dev/null @@ -1,487 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adresourcepropertylist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADResourcePropertyList - -## SYNOPSIS -Modifies a resource property list in Active Directory. - -## SYNTAX - -### Identity -``` -Set-ADResourcePropertyList [-WhatIf] [-Confirm] [-Add ] [-AuthType ] [-Clear ] - [-Credential ] [-Description ] [-Identity] [-PassThru] - [-ProtectedFromAccidentalDeletion ] [-Remove ] [-Replace ] [-Server ] - [] -``` - -### Instance -``` -Set-ADResourcePropertyList [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADResourcePropertyList cmdlet can be used to modify a resource property list in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADResourcePropertyList "Corporate Resource Property List" -Description "For corporate documents." -``` - -Description - ------------ - -Sets the resource property list named "Corporate Resource Property List" with the description "For corporate documents." - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADResourcePropertyList "Corporate Resource Property List" | Set-ADResourcePropertyList -Description "For corporate documents." -``` - -Description - ------------ - -Gets the resource property list named "Corporate Resource Property List" and then sets its description to "For corporate documents." - -## PARAMETERS - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=Global Resource Property List,CN=Resource Property Lists,CN=Claims Configuration,CN=Services,CN=Configuration,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADResourcePropertyList -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies an instance of a resource property list object to use as a template for a new resource property list object. - -You can use an instance of an existing resource property list object as a template or you can construct a resource property list object by using the Windows PowerShell command line or by using a script. -The following examples show how to use these two methods to create a new resource property list object. - -Method 1: Use an existing resource property list object as a template for a new object. -To retrieve an instance of an existing resource property list object, use a cmdlet such as Get-ADResourcePropertyList. -Then provide this object to the Instance parameter of the New-ADResourcePropertyList cmdlet to create a new resource property list object. -You can override property values of the new object by setting the appropriate parameters. - -$objectInstance = Get-ADResourcePropertyList -Identity "Global Resource Property list" - -New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance - -Method 2: Create a new ADResourcePropertyList and set the property values by using the Windows PowerShell command line interface. -Then pass this object to the Instance parameter of the New-ADResourcePropertyList cmdlet to create the new resource property list object. - -$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADResourcePropertyList - -$objectInstance.Description = "For finance use only." - -New-ADResourcePropertyList -Name "Finance Resource Property List" -Instance $ObjectInstance - -Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error. - -```yaml -Type: ADResourcePropertyList -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtectedFromAccidentalDeletion -Specifies whether to prevent the object from being deleted. -When this property is set to true, you cannot delete the corresponding object without changing the value of the property. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to true. - --ProtectedFromAccidentalDeletion $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Replace @{Attribute1LDAPDisplayName=value\[\], Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows. - --Replace @{otherTelephone='555-222-2222', '555-222-1111'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTypeList - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADClaimTypeList - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/Set-ADServiceAccount.md deleted file mode 100644 index f9a21a98bd..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADServiceAccount.md +++ /dev/null @@ -1,1008 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADServiceAccount - -## SYNOPSIS -Modifies an Active Directory managed service account or group managed service account object. - -## SYNTAX - -### Identity -``` -Set-ADServiceAccount [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-Add ] [-AuthType ] [-Certificates ] [-Clear ] - [-CompoundIdentitySupported ] [-Credential ] [-Description ] - [-DisplayName ] [-DNSHostName ] [-Enabled ] [-HomePage ] - [-Identity] [-KerberosEncryptionType ] [-Partition ] - [-PassThru] [-PrincipalsAllowedToDelegateToAccount ] - [-PrincipalsAllowedToRetrieveManagedPassword ] [-Remove ] [-Replace ] - [-SamAccountName ] [-Server ] [-ServicePrincipalNames ] - [-TrustedForDelegation ] [] -``` - -### Instance -``` -Set-ADServiceAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - -Instance [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Set-ADServiceAccount cmdlet modifies the properties of an Active Directory managed service account (MSA). -You can modify commonly used property values by using the cmdlet parameters. -Property values that are not associated with cmdlet parameters can be modified by using the Add, Replace, Clear and Remove parameters. - -The Identity parameter specifies the Active Directory MSA to modify. -You can identify a MSA by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to an object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Get-ADServiceAccount cmdlet to retrieve a MSA object and then pass the object through the pipeline to the Set-ADServiceAccount cmdlet. - -The Instance parameter provides a way to update a MSA object by applying the changes made to a copy of the object. -When you set the Instance parameter to a copy of an Active Directory MSA object that has been modified, the Set-ADServiceAccount cmdlet makes the same changes to the original MSA object. -To get a copy of the object to modify, use the Get-ADServiceAccount object. -When you specify the Instance parameter you should not pass the Identity parameter. -For more information about the Instance parameter, see the Instance parameter description. - -For more information about how the Instance concept is used in Active Directory cmdlets, see about_ActiveDirectory_Instance. - -The following examples show how to modify the ServicePrincipalNames property of a MSA object by using three methods: - --By specifying the Identity and the ServicePrincipalNames parameters - --By passing a service account object through the pipeline and specifying the ServicePrincipalNames parameter - --By specifying the Instance parameter. - -Method 1: Modify the ServicePrincipalNames property for the AccessIndia MSA by using the Identity and ServicePrincipalNames parameters. - -Set-ADServiceAccount -Identity AccessIndia -ServicePrincipalNames @{Add=ACCESSAPP/india.contoso.com} - -Method 2: Modify the ServicePrincipalNames property for the AccessIndia MSA by passing the AccessIndia MSA through the pipeline and specifying the ServicePrincipalNames parameter. - -Get-ADServiceAccount -Identity "AccessIndia" | Set-ADServiceAccount -ServicePrincipalNames @{Add=ACCESSAPP/india.contoso.com} - -Method 3: Modify the \ property for the AccessIndia MSA by using the Windows PowerShell command line to modify a local instance of the AccessIndia MSA. -Then set the Instance parameter to the local instance. - -$serviceAccount = Get-ADServiceAccount -Identity "AccessIndia" - -$serviceAccount.ServicePrincipalNames = @{Add=ACCESSAPP/india.contoso.com} - -Set-ADServiceAccount -Instance $serviceAccount. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADServiceAccount service1 -Description "Secretive Data Server" -``` - -Description - ------------ - -Set the description of Managed Service Account 'service1' to "Secretive Data Server" - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADServiceAccount Mongol01ADAM -ServicePrincipalNames @{replace="ADAMwdb/a.contoso.com", "ADAMbdb/a.contoso.com"} -``` - -Description - ------------ - -Replace the value of property ServicePrincipalNames with "ADAMwdb/a.contoso.com", "ADAMbdb/a.contoso.com" - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-ADServiceAccount service1 -PrincipalsAllowedToRetrieveManagedPassword "MsaAdmins.corp.contoso.com" -``` - -Description - ------------ - -Sets the principals allowed to retrieve the password for this managed service account to be limited to only members of the specified Active Directory group account. - -## PARAMETERS - -### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the AccountExpirationDate property of an account object. -The LDAP Display name (ldapDisplayName) for this property is accountExpires. - -Use the DateTime syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. -The following examples show commonly-used syntax to specify a DateTime object. - -"4/17/2006" - -"Monday, April 17, 2006" - -"2:22:45 PM" - -"Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -"4/17/2006 2:22 PM" - -"Monday, April 17, 2006 2:22 PM" - -"2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - -"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - -"2006-04-17T14:22:48.0000000" - -The following example shows how to set this parameter to the date May 1, 2012 at 5 PM. - --AccountExpirationDate "05/01/2012 5:00:00 PM" - -```yaml -Type: DateTime -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountNotDelegated -Specifies whether the security context of the user is delegated to a service. -When this parameter is set to true, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the AccountNotDelegated property for an Active Directory account. -This parameter also sets the ADS_UF_NOT_DELEGATED flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter so that the security context of the account is not delegated to a service. - --AccountNotDelegated $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. -The format for this parameter is - --Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...} - -For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and "555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value "555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as follows. - --Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove @{otherTelephone='555-222-2222'} - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificates -Modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the Certificates property of the account object. -The LDAP Display Name (ldapDisplayName) for this property is "userCertificate". - -Syntax: - -To add values: - --Certificates @{Add=value1,value2,...} - -To remove values: - --Certificates @{Remove=value3,value4,...} - -To replace values: - --Certificates @{Replace=value1,value2,...} - -To clear all values: - --Certificates $null - -You can specify more than one operation by using a list separated by semicolons. -For example, use the following syntax to add and remove Certificate values - --Certificates @{Add=value1,value2,...};@{Remove=value3,value4,...} - -The operators will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -The following example shows how to create a certificate by using the New-Object cmdlet, and then add it to a user account. -When this cmdlet is run, \ is replaced by the password used to add the certificate. - -$cert = New-Object System.Security.Cryptography.X509Certificates.X509Certificate certificate1.cer \ - -Set-ADUser saradavis -Certificates @{Add=$cert} - -The following example shows how to add a certificate that is specified as a byte array. - -Set-ADUser saradavis -Certificates @{Add= \[Byte\[\]\](0xC5,0xEE,0x53,...)} - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that will be cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is - --Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName - -For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Clear parameter as follows. - --Clear otherTelephone - -When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompoundIdentitySupported -Specifies whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account supports service tickets with device authorization data. - --SupportDeviceAuthz $true - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DNSHostName -Specifies the DNS host name. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the Description property for the object. -The LDAP Display Name (ldapDisplayName) for this property is "description". - -The following example shows how to set this parameter to a sample description. - --Description "Description of the object" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the DisplayName property of the object. -The LDAP Display Name (ldapDisplayName) for this property is "displayName". - -The following example shows how to set this parameter. - --DisplayName "Sara Davis Laptop" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies if an account is enabled. -An enabled account requires a password. -This parameter sets the Enabled property for an account object. -This parameter also sets the ADS_UF_ACCOUNTDISABLE flag of the Active Directory User Account Control (UAC) attribute. -Possible values for this parameter include: - -$false or 0 - -$true or 1 - -The following example shows how to set this parameter to enable the account. - --Enabled $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the homePage property of an Active Directory object. -The LDAP Display Name (ldapDisplayName) for this property is "wWWHomePage". - -The following example shows how to set this parameter to a URL. - --HomePage "http://employees.contoso.com/sdavis" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: WebAccount$ - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "AccountInstance". - --Identity $AccountInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Specifies a modified copy of a service account object to use to update the actual Active Directory service account object. -When this parameter is used, any modifications made to the modified copy of the object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The Instance parameter can only update service account objects that have been retrieved by using the Get-ADServiceAccount cmdlet. -When you specify the Instance parameter, you cannot specify other parameters that set properties on the object. - -The following is an example of how to use the Get-ADServiceAccount cmdlet to retrieve an instance of the ADServiceAccount object. -The object is modified by using the Windows PowerShell command line. -Then the Set-ADServiceAccount cmdlet saves the changes to the Active Directory object. - -Step 1: Retrieve a local instance of the object. - -$serviceAccountInstance = Get-ADServiceAccount -Identity ADServiceAdmin - -Step 2: Modify one or more properties of the object instance. - -$serviceAccountInstance.Description = "default" - -Step3: Save your changes to ADServiceAdmin. - -Set-ADServiceAccount -Instance $serviceAccountInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory msDS-SupportedEncryptionTypes attribute. -Possible values for this parameter are: - -None - -DES - -RC4 - -AES128 - -AES256 - -None, will remove all encryption types from the account may result in the KDC being unable to issue service tickets for services using the account. - -DES is a weak encryption type which is not supported by default since Windows 7 and Windows Server 2008 R2. - -The following example shows how to specify that an account supports service tickets with device authorization data. - --KerberosEncryptionTypes RC4,AES128,AES256 - -Warning: Domain-joined Windows systems and services such as clustering manage their own msDS-SupportedEncryptionTypes attribute. -Therefore any changes to the flag on the msDS-SupportedEncryptionTypes attribute will be overwritten by the service or system which manages the setting. - -```yaml -Type: ADKerberosEncryptionType -Parameter Sets: Identity -Aliases: -Accepted values: None, DES, RC4, AES128, AES256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToDelegateToAccount -Specifies the accounts which can act on the behalf of users to services running as this Managed Service Account or Group Managed Service Account. -This parameter sets the msDS-AllowedToActOnBehalfOfOtherIdentity attribute of the object. - -```yaml -Type: ADPrincipal[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToRetrieveManagedPassword -Specifies the membership policy for systems which can use a group managed service account. -For a service to run under a group managed service account, the system must be in the membership policy of the account. -This parameter sets the msDS-GroupMSAMembership attribute of a group managed service account object. -This parameter should be set to the principals allowed to use this group managed service account. - -```yaml -Type: ADPrincipal[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can remove more than one property by specifying a semicolon-separated list. -The format for this parameter is - --Remove @{Attribute1LDAPDisplayName=value\[\]; Attribute2LDAPDisplayName=value\[\]} - -For example, if you want to add the values blue and green and remove the value pink from a property with a LDAP display name of FavColors, set the Add and Remove parameters as follows. - --Add @{FavColors=Blue,Green} -Remove {FavColors=Pink} - -When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the following sequence: - -..Remove - -..Add - -..Replace - -..Clear - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the SAMAccountName for an account object. -The LDAP display name (ldapDisplayName) for this property is "sAMAccountName". - -The following example shows how to specify this parameter. - --SAMAccountName "saradavis" - -Note: If the string value provided is not terminated with a '$' character, the system adds one if needed. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalNames -Specifies the service principal names for the account. -This parameter sets the **ServicePrincipalNames** property of the account. -The LDAP display name (**ldapDisplayName**) for this property is servicePrincipalName. -This parameter uses the following syntax to add remove, replace or clear service principal name values. - -To add values: - -`-ServicePrincipalNames @{Add=value1,value2,...}` - -To remove values: - -`-ServicePrincipalNames @{Remove=value3,value4,...}` - -To replace values: - -`-ServicePrincipalNames @{Replace=value1,value2,...}` - -To clear all values: - -`-ServicePrincipalNames $Null` - -You can specify more than one change by using a list separated by semicolons. -For example, use the following syntax to add and remove service principal names. - -`@{Add=value1,value2,...};@{Remove=value3,value4,...}` - -The operators are applied in the following sequence: - -- Remove -- Add -- Replace - -The following example shows how to add and remove service principal names. - -```powershell - -ServicePrincipalNames @{Add="SQLservice\accounting.corp.contoso.com:1456"};{Remove="SQLservice\finance.corp.contoso.com:1456"} -``` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the TrustedForDelegation property of an account object. -This value also sets the ADS_UF_TRUSTED_FOR_DELEGATION flag of the Active Directory User Account Control attribute. -Possible values for this parameter are: - -$false or 0 - -$true or 1 - -The following example shows how to specify that an account is trusted for Kerberos delegation. - --TrustedForDelegation $true - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the Identity parameter. - -A managed service account object that was retrieved by using the Get-ADServiceAccount cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -Returns the modified managed service account object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Install-ADServiceAccount](./Install-ADServiceAccount.md) - -[New-ADServiceAccount](./New-ADServiceAccount.md) - -[Remove-ADServiceAccount](./Remove-ADServiceAccount.md) - -[Uninstall-ADServiceAccount](./Uninstall-ADServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Set-ADUser.md b/docset/winserver2012-ps/activedirectory/Set-ADUser.md deleted file mode 100644 index 9da26a5cc3..0000000000 --- a/docset/winserver2012-ps/activedirectory/Set-ADUser.md +++ /dev/null @@ -1,1465 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/set-aduser?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADUser - -## SYNOPSIS -Modifies an Active Directory user. - -## SYNTAX - -### Identity -``` -Set-ADUser [-WhatIf] [-Confirm] [-AccountExpirationDate ] [-AccountNotDelegated ] - [-Add ] [-AllowReversiblePasswordEncryption ] [-AuthType ] - [-CannotChangePassword ] [-Certificates ] [-ChangePasswordAtLogon ] - [-City ] [-Clear ] [-Company ] [-CompoundIdentitySupported ] - [-Country ] [-Credential ] [-Department ] [-Description ] - [-DisplayName ] [-Division ] [-EmailAddress ] [-EmployeeID ] - [-EmployeeNumber ] [-Enabled ] [-Fax ] [-GivenName ] - [-HomeDirectory ] [-HomeDrive ] [-HomePage ] [-HomePhone ] - [-Identity] [-Initials ] [-KerberosEncryptionType ] - [-LogonWorkstations ] [-Manager ] [-MobilePhone ] [-Office ] - [-OfficePhone ] [-Organization ] [-OtherName ] [-Partition ] [-PassThru] - [-PasswordNeverExpires ] [-PasswordNotRequired ] [-POBox ] [-PostalCode ] - [-PrincipalsAllowedToDelegateToAccount ] [-ProfilePath ] [-Remove ] - [-Replace ] [-SamAccountName ] [-ScriptPath ] [-Server ] - [-ServicePrincipalNames ] [-SmartcardLogonRequired ] [-State ] - [-StreetAddress ] [-Surname ] [-Title ] [-TrustedForDelegation ] - [-UserPrincipalName ] [] -``` - -### Instance -``` -Set-ADUser [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] -Instance - [-PassThru] [-SamAccountName ] [-Server ] [] -``` - -## DESCRIPTION -The **Set-ADUser** cmdlet modifies the properties of an Active Directory user. -You can modify commonly used property values by using the cmdlet parameters. -You can set property values that are not associated with cmdlet parameters by using the *Add*, *Remove*, *Replace*, and *Clear* parameters. - -The *Identity* parameter specifies the Active Directory user to modify. -You can identify a user by its distinguished name, GUID, security identifier (SID), or Security Account Manager (SAM) account name. -You can also set the *Identity* parameter to an object variable such as `$`, or you can pass an object through the pipeline to the *Identity* parameter. -For example, you can use the **Get-ADUser** cmdlet to retrieve a user object and then pass the object through the pipeline to the **Set-ADUser** cmdlet. - -The *Instance* parameter provides a way to update a user object by applying the changes made to a copy of the object. -When you set the *Instance* parameter to a copy of an Active Directory user object that has been modified, the **Set-ADUser** cmdlet makes the same changes to the original user object. -To get a copy of the object to modify, use the **Get-ADUser** object. -The *Identity* parameter is not allowed when you use the *Instance* parameter. -For more information about the *Instance* parameter, see the *Instance* parameter description. - -Accounts created with the **New-ADUser** cmdlet are disabled if no password is provided. - -For AD LDS environments, the *Partition* parameter must be specified except in the following two conditions: - -- The cmdlet is run from an Active Directory provider drive. -- A default naming context or partition is defined for the AD LDS environment. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. - -## EXAMPLES - -### Example 1: Set properties for a user -```powershell -PS C:\> Set-ADUser -Identity ChewDavid -HomePage 'http://fabrikam.com/employees/ChewDavid' -LogonWorkstations 'ChewDavid-DSKTOP,ChewDavid-LPTOP' -``` - -This command sets the specified user's **homepage** property to http://fabrikam.com/employees/ChewDavid and the **LogonWorkstations** property to ChewDavid-DSKTOP,ChewDavid-LPTOP. - -### Example 2: Set properties for multiple users -```powershell -PS C:\> Get-ADUser -Filter 'Name -like "*"' -SearchBase 'OU=HumanResources,OU=UserAccounts,DC=FABRIKAM,DC=COM' -Properties DisplayName | % {Set-ADUser $_ -DisplayName ($_.Surname + ' ' + $_.GivenName)} -``` - -This command gets all the users in the directory that are located in the OU=HumanResources,OU=UserAccounts,DC=FABRIKAM,DC=COM organizational unit. -The command sets the **DisplayName** property on these user objects to the concatenation of the **Surname** property and the **GivenName** property. - -### Example 3: Set properties -```powershell -PS C:\> Set-ADUser -Identity GlenJohn -Replace @{title="director";mail="glenjohn@fabrikam.com"} -``` - -This command sets the specified user's **title** property to director and the **mail** property to glenjohn@fabrikam.com. - -### Example 4: Modify a user otherMailbox property -```powershell -PS C:\> Set-ADUser -Identity GlenJohn -Remove @{otherMailbox="glen.john"} -Add @{url="fabrikam.com"} -Replace @{title="manager"} -Clear description -``` - -This command modifies the user with the SAM account name GlenJohn's object by removing glen.john from the **otherMailbox** property, adding fabrikam.com to the **url** property, replacing the **title** property with manager, and clearing the **description** property. - -### Example 5: Set user properties to a local instance -```powershell -PS C:\> $User = Get-ADUser -Identity GlenJohn -Properties mail,department -PS C:\> $User.mail = "glen@fabrikam.com" -PS C:\> $User.department = "Accounting" -PS C:\> Set-ADUser -Instance $User -``` - -This example sets the **mail** and **department** properties on the user object with the SAM account name GlenJohn by using the *Instance* parameter. - -### Example 6: Set attributes for a user -```powershell -PS C:\> $Hours = New-Object byte[] 21 -PS C:\> $Hours[5] = 255; $Hours[8] = 255; $Hours[11] = 255; $Hours[14] = 255; $Hours[17] = 255; -PS C:\> $Hours[6] = 1; $Hours[9] = 1; $Hours[12] = 1; $Hours[15] = 1; $Hours[18] = 1; -PS C:\> $ReplaceHashTable = New-Object HashTable -PS C:\> $ReplaceHashTable.Add("logonHours", $Hours) -PS C:\> $ReplaceHashTable.Add("description", "Sarah Davis can only logon from Monday through Friday from 8:00 AM to 5:00 PM") -PS C:\> Set-ADUser -Identity "SarahDavis" -Replace $ReplaceHashTable -``` - -This example sets the user logon hours to Monday through Friday from 8:00 AM to 5:00 PM and adds a description. -It updates the **logonHours** attribute with the specified byte array and the **description** attribute with the specified string. - -### Example 7: Set a property for a user -```powershell -PS C:\> $Manager = Get-ADUser -Identity GlenJohn -Server Corp-DC01 -PS C:\> Set-ADUser -Identity ChewDavid -Manager $Manager -Server Branch-DC02 -``` - -This example sets the **Manager** property for the user with the SAM account name of ChewDavid where the manager, GlenJohn, is a user in another domain. - -## PARAMETERS - -### -AccountExpirationDate -Specifies the expiration date for an account. -This parameter sets the AccountExpirationDate property of an account object. -The LDAP display name (ldapDisplayName) for this property is accountExpires. - -Use the **DateTime** syntax when you specify this parameter. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. - -```yaml -Type: DateTime -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccountNotDelegated -Indicates whether the security context of the user is delegated to a service. -When this parameter is set to $True, the security context of the account is not delegated to a service even when the service account is set as trusted for Kerberos delegation. -This parameter sets the **AccountNotDelegated** property for an Active Directory account. -This parameter also sets the **ADS_UF_NOT_DELEGATED** flag of the Active Directory User Account Control (UAC) attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Add -Specifies values to add to an object property. -Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon. If any of the properties have a null or empty value the cmdlet will return an error. -The format for this parameter is: - -`-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the **Add**, **Remove**, **Replace**, and **Clear** parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowReversiblePasswordEncryption -Indicates whether reversible password encryption is allowed for the account. -This parameter sets the **AllowReversiblePasswordEncryption** property of the account. -This parameter also sets the **ADS_UF_ENCRYPTED_TEXT_PASSWORD_ALLOWED** flag of the Active Directory User Account Control (UAC) attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthType -Specifies the authentication method to use. -The acceptable values for this parameter are: - -- Negotiate or 0 -- Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CannotChangePassword -Indicates whether the account password can be changed. -This parameter sets the **CannotChangePassword** property of an account. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Certificates -Specifies an array of certificates. -The cmdlet modifies the DER-encoded X.509v3 certificates of the account. -These certificates include the public key certificates issued to this account by the Microsoft Certificate Service. -This parameter sets the **Certificates** property of the account object. -The Lightweight Directory Access Protocol (LDAP) display name (**ldapDisplayName**) for this property is userCertificate. - -To add values: - -`-Certificates @{Add=value1,value2,...}` - -To remove values: - -`-Certificates @{Remove=value3,value4,...}` - -To replace values: - -`-Certificates @{Replace=value1,value2,...}` - -To clear all values: - -`-Certificates $Null` - -You can specify more than one operation by using a list separated by semicolons. -For example, use the following syntax to add and remove **Certificates** values: - -`-Certificates @{Add=value1,value2,...};@{Remove=value3,value4,...}` - -The operators are applied in the following sequence: - -- Remove -- Add -- Replace - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChangePasswordAtLogon -Indicates whether a password must be changed during the next logon attempt. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -City -Specifies the user's town or city. -This parameter sets the **City** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is l. - --City "Las Vegas" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Clear -Specifies an array of object properties that are cleared in the directory. -Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can modify more than one property by specifying a comma-separated list. -The format for this parameter is: - -`-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName` - -When you use the **Add**, **Remove**, **Replace**, and **Clear** parameters together, the operations are performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: String[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Company -Specifies the user's company. -This parameter sets the **Company** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is company. - --Company "Contoso" - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompoundIdentitySupported -Indicates whether an account supports Kerberos service tickets which includes the authorization data for the user's device. -This value sets the compound identity supported flag of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages the setting. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Country -Specifies the country or region code for the user's language of choice. -This parameter sets the **Country** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is c. -This value is not used by Windows 2000. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as `User1` or `Domain01\User01` or you can specify a **PSCredential** object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a **PSCredential** object by using a script or by using the Get-Credential cmdlet. -You can then set the *Credential* parameter to the **PSCredential** object. - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Department -Specifies the user's department. -This parameter sets the **Department** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is department. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description of the object. -This parameter sets the value of the **Description** property for the user object. -The LDAP display name (**ldapDisplayName**) for this property is description. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the object. -This parameter sets the **DisplayName** property of the user object. -The LDAP display name (**ldapDisplayName**) for this property is displayName. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Division -Specifies the user's division. -This parameter sets the **Division** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is division. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the user's e-mail address. -This parameter sets the **EmailAddress** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is mail. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmployeeID -Specifies the user's employee ID. -This parameter sets the **EmployeeID** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is employeeID. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmployeeNumber -Specifies the user's employee number. -This parameter sets the **EmployeeNumber** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is employeeNumber. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether an account is enabled. -An enabled account requires a password. -This parameter sets the **Enabled** property for an account object. -This parameter also sets the **ADS_UF_ACCOUNTDISABLE** flag of the Active Directory User Account Control (UAC) attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fax -Specifies the user's fax phone number. -This parameter sets the **Fax** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is facsimileTelephoneNumber. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GivenName -Specifies the user's given name. -This parameter sets the **GivenName** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is givenName. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomeDirectory -Specifies a user's home directory. -This parameter sets the **HomeDirectory** property of a user object. -The LDAP display name (**ldapDisplayName**) for this property is homeDirectory. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomeDrive -Specifies a drive that is associated with the UNC path defined by the **HomeDirectory** property. -The drive letter is specified as \: where \ indicates the letter of the drive to associate. -The \ must be a single, uppercase letter and the colon is required. -This parameter sets the **HomeDrive** property of the user object. -The LDAP display name (**ldapDisplayName**) for this property is homeDrive. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePage -Specifies the URL of the home page of the object. -This parameter sets the **homePage** property of an Active Directory object. -The LDAP display name (**ldapDisplayName**) for this property is wWWHomePage. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HomePhone -Specifies the user's home telephone number. -This parameter sets the **HomePhone** property of a user. -The LDAP display name (**ldapDisplayName**) of this property is homePhone. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory user object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -```yaml -Type: ADUser -Parameter Sets: Identity -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Initials -Specifies the initials that represent part of a user's name. -You can use this value for the user's middle initial. -This parameter sets the **Initials** property of a user. -The LDAP display name (**ldapDisplayName**) of this property is initials. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Specifies an **ADUser** object that identifies the Active Directory user object that should be modified and the set of changes that should be made to that object. -When this parameter is specified, any modifications made to the **ADUser** object are also made to the corresponding Active Directory object. -The cmdlet only updates the object properties that have changed. - -The **ADUser** object specified as the value of the **Instance** parameter must have been retrieved by using the **Get-ADUser** cmdlet. -When you specify the **Instance** parameter, you cannot specify other parameters that set individual properties on the object. - -```yaml -Type: ADUser -Parameter Sets: Instance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosEncryptionType -Specifies whether an account supports Kerberos encryption types which are used during creation of service tickets. -This value sets the encryption types supported flags of the Active Directory **msDS-SupportedEncryptionTypes** attribute. -The acceptable values for this parameter are: - -- None -- DES -- RC4 -- AES128 -- AES256 - -None removes all encryption types from the account, resulting in the KDC being unable to issue service tickets for services using the account. - -DES is a weak encryption type that is not supported by default since Windows 7 and Windows Server 2008 R2. - -Warning: Domain-joined Windows systems and services such as clustering manage their own **msDS-SupportedEncryptionTypes** attribute. -Therefore any changes to the flag on the **msDS-SupportedEncryptionTypes** attribute are overwritten by the service or system that manages the setting. - -```yaml -Type: ADKerberosEncryptionType -Parameter Sets: Identity -Aliases: -Accepted values: None, DES, RC4, AES128, AES256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogonWorkstations -Specifies the computers that the user can access. -To specify more than one computer, create a single comma-separated list. -You can identify a computer by using the Security Account Manager (SAM) account name (sAMAccountName) or the DNS host name of the computer. -The SAM account name is the same as the NetBIOS name of the computer. - -The LDAP display name (**ldapDisplayName**) for this property is userWorkStations. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Manager -Specifies the user's manager. -This parameter sets the **Manager** property of a user object. -This parameter is set by providing one of the following property values. -Note: The identifier in parentheses is the LDAP display name for the property. -The acceptable values for this parameter are: - -- A distinguished name -- A GUID (objectGUID) -- A security identifier (objectSid) -- A SAM account name (sAMAccountName) - -The LDAP display name (**ldapDisplayName**) of this property is manager. - -```yaml -Type: ADUser -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MobilePhone -Specifies the user's mobile phone number. -This parameter sets the **MobilePhone** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is mobile. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Office -Specifies the location of the user's office or place of business. -This parameter sets the **Office** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is physicalDeliveryOfficeName. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OfficePhone -Specifies the user's office telephone number. -This parameter sets the **OfficePhone** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is telephoneNumber. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Organization -Specifies the user's organization. -This parameter sets the **Organization** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is o. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OtherName -Specifies a name in addition to a user's given name and surname, such as the user's middle name. -This parameter sets the **OtherName** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is middleName. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -POBox -Specifies the user's post office box number. -This parameter sets the **POBox** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is postOfficeBox. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the *Identity* parameter. - -In many cases, a default value is used for the *Partition* parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and when a default value can be determined, no further rules are evaluated. - -In AD DS environments, a default value for *Partition* are set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of *Partition* is set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for *Partition* will be set in the following cases: - -- If the *Identity* parameter is set to a distinguished name, the default value of *Partition* is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of *Partition* is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of *Partition* is set to the default naming context. -To specify a default naming context for an AD LDS environment, set the **msDS-defaultNamingContext** property of the Active Directory directory service agent object (**nTDSDSA**) for the AD LDS instance. -- If none of the previous cases apply, the *Partition* parameter does not take any default value. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNeverExpires -Specifies whether the password of an account can expire. -This parameter sets the **PasswordNeverExpires** property of an account object. -This parameter also sets the **ADS_UF_DONT_EXPIRE_PASSWD** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -Note: This parameter cannot be set to $True or 1 for an account that also has the **ChangePasswordAtLogon** property set to $True. - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordNotRequired -Specifies whether the account requires a password. -This parameter sets the **PasswordNotRequired** property of an account, such as a user or computer account. -This parameter also sets the **ADS_UF_PASSWD_NOTREQD** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostalCode -Specifies the postal code or zip code. -This parameter sets the **PostalCode** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is postalCode. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrincipalsAllowedToDelegateToAccount -Specifies an array of principal objects. -This parameter sets the **msDS-AllowedToActOnBehalfOfOtherIdentity** attribute of a computer account object. - -```yaml -Type: ADPrincipal[] -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProfilePath -Specifies a path to the user's profile. -This value can be a local absolute path or a Universal Naming Convention (UNC) path. -This parameter sets the **ProfilePath** property of the user object. -The LDAP display name (**ldapDisplayName**) for this property is profilePath. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -Specifies that the cmdlet remove values of an object property. -Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. -To remove an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. If any of the properties have a null or empty value the cmdlet will return an error. -The format for this parameter is: - -`-Remove @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the parameters are applied in the following sequence: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies values for an object property that will replace the current values. -Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. -To modify an object property, you must use the LDAP display name. -You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. If any of the properties have a null or empty value the cmdlet will return an error. -The format for this parameter is: - -`-Replace @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}` - -When you use the *Add*, *Remove*, *Replace*, and *Clear* parameters together, the operations will be performed in the following order: - -- **Remove** -- **Add** -- **Replace** -- **Clear** - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamAccountName -Specifies the Security Account Manager (SAM) account name of the user, group, computer, or service account. -The maximum length of the description is 256 characters. -To be compatible with older operating systems, create a SAM account name that is 20 characters or less. -This parameter sets the **SAMAccountName** for an account object. -The LDAP display name (**ldapDisplayName**) for this property is sAMAccountName. - -Note: If the string value provided is not terminated with a $ character, the system adds one if needed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptPath -Specifies a path to the user's log on script. -This value can be a local absolute path or a Universal Naming Convention (UNC) path. -This parameter sets the **ScriptPath** property of the user. -The LDAP display name (**ldapDisplayName**) for this property is scriptPath. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the AD DS instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: AD LDS, AD DS, or Active Directory snapshot instance. - -Specify the AD DS instance in one of the following ways: - -Domain name values: - -- Fully qualified domain name -- NetBIOS name - -Directory server values: - -- Fully qualified directory server name -- NetBIOS name -- Fully qualified directory server name and port - -The default value for this parameter is determined by one of the following methods in the order that they are listed: - -- By using the *Server* value from objects passed through the pipeline -- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive -- By using the domain of the computer running Windows PowerShell - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServicePrincipalNames -Specifies the service principal names for the account. This parameter sets the ServicePrincipalNames property of the account. The LDAP display name (ldapDisplayName) for this property is servicePrincipalName. This parameter uses the following syntax to add, remove, replace or clear service principal name values. - -Syntax: - -To add values: - -`-ServicePrincipalNames @{Add=value1,value2,...}` - -To remove values: - -`-ServicePrincipalNames @{Remove=value3,value4,...}` - -To replace values: - -`-ServicePrincipalNames @{Replace=value1,value2,...}` - -To clear all values: - -`-ServicePrincipalNames $null` - -You can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove service principal names. - -`@{Add=value1,value2,...};@{Remove=value3,value4,...}` - -The operators will be applied in the following sequence: - -- Remove -- Add -- Replace - -The following example shows how to add and remove service principal names. - -`-ServicePrincipalNames-@{Add="SQLservice\accounting.corp.contoso.com:1456"};{Remove="SQLservice\finance.corp.contoso.com:1456"}` - -```yaml -Type: Hashtable -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartcardLogonRequired -Indicates whether a smart card is required to logon. -This parameter sets the **SmartCardLoginRequired** property for a user. -This parameter also sets the **ADS_UF_SMARTCARD_REQUIRED** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -State -Specifies the user's state or province. -This parameter sets the **State** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is st. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StreetAddress -Specifies the user's street address. -This parameter sets the **StreetAddress** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is streetAddress. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Surname -Specifies the user's last name or surname. -This parameter sets the **Surname** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is sn. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Title -Specifies the user's title. -This parameter sets the **Title** property of a user object. -The LDAP display name (**ldapDisplayName**) of this property is title. - -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustedForDelegation -Specifies whether an account is trusted for Kerberos delegation. -A service that runs under an account that is trusted for Kerberos delegation can assume the identity of a client requesting the service. -This parameter sets the **TrustedForDelegation** property of an account object. -This value also sets the **ADS_UF_TRUSTED_FOR_DELEGATION** flag of the Active Directory User Account Control attribute. -The acceptable values for this parameter are: - -- $False or 0 -- $True or 1 - -```yaml -Type: Boolean -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserPrincipalName -Specifies a user principal name (UPN) in the format `@`. -A UPN is a friendly name assigned by an administrator that is shorter than the LDAP distinguished name used by the system and easier to remember. -The UPN is independent of the user object's distinguished name, so a user object can be moved or renamed without affecting the user logon name. -When logging on using a UPN, users don't have to choose a domain from a list on the logon dialog box. -```yaml -Type: String -Parameter Sets: Identity -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADUser -A user object is received by the Identity parameter. - -A user object that was retrieved by using the Get-ADUser cmdlet and then modified is received by the Instance parameter. - -## OUTPUTS - -### None or Microsoft.ActiveDirectory.Management.ADUser -Returns the modified user object when the PassThru parameter is specified. -By default, this cmdlet does not generate any output. - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADUser](./Get-ADUser.md) - -[New-ADUser](./New-ADUser.md) - -[Remove-ADUser](./Remove-ADUser.md) - -[Set-ADAccountControl](./Set-ADAccountControl.md) - diff --git a/docset/winserver2012-ps/activedirectory/Sync-ADObject.md b/docset/winserver2012-ps/activedirectory/Sync-ADObject.md deleted file mode 100644 index 1a19b3baef..0000000000 --- a/docset/winserver2012-ps/activedirectory/Sync-ADObject.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/sync-adobject?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Sync-ADObject - -## SYNOPSIS -Replicates a single object between any two domain controllers that have partitions in common. - -## SYNTAX - -``` -Sync-ADObject [-AuthType ] [-Credential ] [-Destination] - [-Object] [-PassThru] [-PasswordOnly] [[-Source] ] [] -``` - -## DESCRIPTION -The Sync-ADObject cmdlet replicates a single object between any two domain controllers that have partitions in common. -The two domain controllers do not need to be direct replication partners. -It can also be used to populate passwords in a read-only domain controller (RODC) cache. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Sync-ADObject "CN=AccountManagers,OU=AccountDeptOU,DC=corp,DC=contoso,DC=com" corp-DC01 corp-DC02 -``` - -Description - ------------ - -Replicate an object with DistinguishedName 'CN=AccountManagers,OU=AccountDeptOU,DC=corp,DC=contoso,DC=com' from corp-DC01 to corp-DC02. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADUser saradavis | Sync-ADObject -Destination "corp-RODC01" -PasswordOnly -``` - -Description - ------------ - -Pre-cache the password of Sara Davis to the read-only Domain Controller corp-RODC01 using the user's SamAccountName - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user account that has permission to perform this action. -The default is the current user. - -Type a user name, such as "User01" or "Domain01\User01", or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. -If you type a user name, you will be prompted for a password. - -This parameter is not supported by any providers installed with Windows PowerShell. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the identity of the Active Directory server that acts as the destination for synchronizing this data. -The alias for Destination is Server. -This parameter works similarly to the Server parameter as used on the Set-Object cmdlet with some restrictions. -It does not allow domain or forest names to be used. - -Valid formats for specifying the destination server are the following: - -Host name - -Example: corp-DC12 - -Host name and port - -Examples: corp-DC12:3268 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -IP address - -Examples: 10.0.0.1 - -IP address and port - -Example: 10.0.0.1:3268 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Server, HostName, IPv4Address - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Object -Specifies an Active Directory object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=saradavis,OU=users,OU=asia,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance". - --Identity $ADObjectInstance - -```yaml -Type: ADObject -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns the object once it has been synchronized on the destination server. -By default if the PassThru parameter is not specified, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordOnly -Populates a read-only domain controller (RODC) password cache with the password of the account specified in the Object parameter. -If specified, no other data is replicated other than the password. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Source -Specifies the identity of the Active Directory server that acts as the source for synchronizing this data. -This parameter works similarly to the Server parameter as used on the Set-Object cmdlet with some restrictions. -It does not allow domain or forest names to be used. - -Valid format foes specifying the source server are the following: - -Host name - -Example: corp-DC12 - -Host name and port - -Examples: corp-DC12:3268 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -IP address - -Examples: 10.0.0.1 - -IP address and port - -Example: 10.0.0.1:3268 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.ActiveDirectory.Management.ADObject -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADGroup - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -Microsoft.ActiveDirectory.Management.ADOrganizationalUnit - -Microsoft.ActiveDirectory.Management.ADFineGrainedPasswordPolicy - -Microsoft.ActiveDirectory.Management.ADDomain - -## OUTPUTS - -## NOTES -* This cmdlet only works with Windows Server 2012, Windows Server 2008 R2 SP1 and Windows Server 2008 or Windows Server 2003. -* For Windows Server 2008 or Windows Server 2003, this cmdlet requires that the Active Directory Management Gateway Service is installed and running. This requires a separate download, which can be obtained on the Microsoft Download Center. - -## RELATED LINKS - -[Get-ADObject](./Get-ADObject.md) - -[Move-ADObject](./Move-ADObject.md) - -[New-ADObject](./New-ADObject.md) - -[Remove-ADObject](./Remove-ADObject.md) - -[Rename-ADObject](./Rename-ADObject.md) - -[Restore-ADObject](./Restore-ADObject.md) - -[Set-ADObject](./Set-ADObject.md) - diff --git a/docset/winserver2012-ps/activedirectory/Test-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/Test-ADServiceAccount.md deleted file mode 100644 index 7ee1565a66..0000000000 --- a/docset/winserver2012-ps/activedirectory/Test-ADServiceAccount.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/test-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ADServiceAccount - -## SYNOPSIS -Tests a managed service account from a computer. - -## SYNTAX - -``` -Test-ADServiceAccount [-AuthType ] [-Identity] [] -``` - -## DESCRIPTION -The Test-ADServiceAccount cmdlet tests a managed service account (MSA) from a local computer. - -The Identity parameter specifies the Active Directory MSA account to test. -You can identify a MSA by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the parameter to a MSA object variable, such as $\ or pass a MSA object through the pipeline to the Identity parameter. -For example, you can use the Get-ADServiceAccount to get a MSA object and then pass that object through the pipeline to the Test-ADServiceAccount cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Test-ADServiceAccount -Identity MSA1 - - -True -``` - -Description - ------------ - -Tests that the specified service account ("MSA1") is ready for use (it is able be authenticated and access the domain using its currently configured credentials) from the local computer. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Test-ADServiceAccount -Identity MSA1 - - -False - -WARNING: Test failed for Managed Service Account MSA. If standalone Managed Service Account, the account is linked to another computer object in the Active Directory. If group Managed Service Account, either this computer does not have permission to use the group MSA or this computer does not support all the Kerberos encryption types required for the gMSA. See the MSA operational log for more information. -``` - -Description - ------------ - -Test results returned if MsaInfoCannotInstall - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Test-ADServiceAccount -Identity MSA1 - - -False - -WARNING: The Managed Service Account MSA is not linked with any computer object in the directory. -``` - -Description - ------------ - -Test returns MsaInfoCanInstall - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory managed service account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=MyServiceMSA,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM account name (sAMAccountName) - -Example: MyServiceMSA - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=MyServiceMSA,CN=Europe,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to a user object instance named "userInstance". - --Identity $userInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the Identity parameter. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/activedirectory/Uninstall-ADServiceAccount.md b/docset/winserver2012-ps/activedirectory/Uninstall-ADServiceAccount.md deleted file mode 100644 index 87593dd144..0000000000 --- a/docset/winserver2012-ps/activedirectory/Uninstall-ADServiceAccount.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/uninstall-adserviceaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-ADServiceAccount - -## SYNOPSIS -Uninstalls an Active Directory managed service account from a computer or removes a cached group managed service account from a computer. - -## SYNTAX - -``` -Uninstall-ADServiceAccount [-WhatIf] [-Confirm] [-AuthType ] [-ForceRemoveLocal] - [-Identity] [] -``` - -## DESCRIPTION -The Uninstall-ADServiceAccount cmdlet removes an Active Directory standalone managed service account (MSA) on the computer on which the cmdlet is run. -For group MSAs, the cmdlet removes the group MSA from the cache, however, if a service is still using the group MSA and the host has permission to retrieve the password a new cache entry will be created. -The specified MSA must be installed on the computer. - -The Identity parameter specifies the Active Directory MSA to uninstall. -You can identify a MSA by its distinguished name (DN), GUID, security identifier (SID), or Security Accounts Manager (SAM) account name. -You can also set the parameter to a MSA object variable, such as $\ or pass a MSA object through the pipeline to the Identity parameter. -For example, you can use the Get-ADServiceAccount to get a MSA object and then pass that object through the pipeline to the Uninstall-ADServiceAccount cmdlet. - -For standalone MSA, the ForceRemoveLocal switch parameter will allow you to remove the account from the local LSA without failing the command if an access to a writable DC is not possible. -This is required if you are uninstalling the standalone MSA from a server that is placed in a segmented network (i.e. -perimeter network) with access only to an RODC. -If you pass this parameter and the server has access to a writable DC the standalone MSA will be un-linked from the computer account in the directory as well. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-ADServiceAccount -Identity SQL-SRV1 -``` - -Description - ------------ - -Uninstall the managed service account SQL-SRV1 from the local machine. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Uninstall-ADServiceAccount sql-hr-01 -ForceRemoveLocal -``` - -Description - ------------ - -Uninstall a standalone Managed Service Account from a server located in a RODC-only site with no access to writable DCs such as a perimeter network. - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRemoveLocal -The ForceRemoveLocal switch parameter will allow you to remove the account from the local LSA without failing the command if an access to a writable DC is not possible. -This is required if you are uninstalling the MSA from a server that is placed in a segmented network (i.e. -perimeter network) with access only to an RODC. -If you pass this parameter and the server has access to a writable DC the account will be un-linked from the computer account in the directory as well. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: WebAccount$ - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an object instance. - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=WebAccount,CN=ManagedServiceAccounts,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "AccountInstance". - --Identity $AccountInstance - -```yaml -Type: ADServiceAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADServiceAccount -A managed service account object is received by the Identity parameter. -A switch parameter with name ForceRemoveLocal is provided to un-install standalone MSAs on a RODC only site. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with AD LDS. - - This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Get-ADServiceAccount](./Get-ADServiceAccount.md) - -[Install-ADServiceAccount](./Install-ADServiceAccount.md) - -[New-ADServiceAccount](./New-ADServiceAccount.md) - -[Remove-ADServiceAccount](./Remove-ADServiceAccount.md) - -[Set-ADServiceAccount](./Set-ADServiceAccount.md) - diff --git a/docset/winserver2012-ps/activedirectory/Unlock-ADAccount.md b/docset/winserver2012-ps/activedirectory/Unlock-ADAccount.md deleted file mode 100644 index 63bb2387a5..0000000000 --- a/docset/winserver2012-ps/activedirectory/Unlock-ADAccount.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -external help file: Microsoft.ActiveDirectory.Management.dll-Help.xml -Module Name: ActiveDirectory -online version: https://learn.microsoft.com/powershell/module/activedirectory/unlock-adaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Unlock-ADAccount - -## SYNOPSIS -Unlocks an Active Directory account. - -## SYNTAX - -``` -Unlock-ADAccount [-WhatIf] [-Confirm] [-AuthType ] [-Credential ] - [-Identity] [-Partition ] [-PassThru] [-Server ] [] -``` - -## DESCRIPTION -The Unlock-ADAccount cmdlet restores Active Directory Domain Services (AD DS) access for an account that is locked. -AD DS access is suspended or locked for an account when the number of incorrect password entries exceeds the maximum number allowed by the account password policy. - -The Identity parameter specifies the Active Directory account to unlock. -You can identify an account by its distinguished name (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. -You can also set the Identity parameter to an account object variable such as $\, or you can pass an object through the pipeline to the Identity parameter. -For example, you can use the Search-ADAccount cmdlet to get an account object and then pass the object through the pipeline to the Unlock-ADAccount cmdlet to unlock the account. -Similarly, you can use Get-ADUser and Get-ADComputer to get objects to pass through the pipeline. - -For AD LDS environments, the Partition parameter must be specified except when: - Using a DN to identify objects: the partition will be auto-generated from the DN. -- Running cmdlets from an Active Directory provider drive: the current path will be used to set the partition. -- A default naming context or partition is specified. - -To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Unlock-ADAccount -Identity KimAb -``` - -Description - ------------ - -Unlocks the account with SamAccountName: KimAb. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Unlock-ADAccount -Identity "CN=Kim Abercrombie,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM" -``` - -Description - ------------ - -Unlocks the account with DistinguishedName: "CN=Kim Abercrombie,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM". - -## PARAMETERS - -### -AuthType -Specifies the authentication method to use. -Possible values for this parameter include: - -Negotiate or 0 - -Basic or 1 - -The default authentication method is Negotiate. - -A Secure Sockets Layer (SSL) connection is required for the Basic authentication method. - -The following example shows how to set this parameter to Basic. - --AuthType Basic - -```yaml -Type: ADAuthType -Parameter Sets: (All) -Aliases: -Accepted values: Negotiate, Basic - -Required: False -Position: Named -Default value: Microsoft.ActiveDirectory.Management.AuthType.Negotiate -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user account credentials to use to perform this task. -The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell provider drive. -If the cmdlet is run from such a provider drive, the account associated with the drive is the default. - -To specify this parameter, you can type a user name, such as "User1" or "Domain01\User01" or you can specify a PSCredential object. -If you specify a user name for this parameter, the cmdlet prompts for a password. - -You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. -You can then set the Credential parameter to the PSCredential object The following example shows how to create credentials. - -$AdminCredentials = Get-Credential "Domain01\User01" - -The following shows how to set the Credential parameter to these credentials. - --Credential $AdminCredentials - -If the acting credentials do not have directory-level permission to perform the task, Active Directory PowerShell returns a terminating error. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies an Active Directory account object by providing one of the following property values. -The identifier in parentheses is the LDAP display name for the attribute. - -Distinguished Name - -Example: CN=SaraDavis ,CN=Users,DC=corp,DC=contoso,DC=com - -GUID (objectGUID) - -Example: 599c3d2e-f72d-4d20-8a88-030d99495f20 - -Security Identifier (objectSid) - -Example: S-1-5-21-3165297888-301567370-576410423-1103 - -SAM Account Name (sAMAccountName) - -Example: saradavis - -The cmdlet searches the default naming context or partition to find the object. -If two or more objects are found, the cmdlet returns a non-terminating error. - -This parameter can also get this object through the pipeline or you can set this parameter to an account object instance. - -Derived types such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -This example shows how to set the parameter to a distinguished name. - --Identity "CN=saradavis,CN=Users,DC=corp,DC=contoso,DC=com" - -This example shows how to set this parameter to an account object instance named "accountInstance". - --Identity $accountInstance - -```yaml -Type: ADAccount -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Partition -Specifies the distinguished name of an Active Directory partition. -The distinguished name must be one of the naming contexts on the current directory server. -The cmdlet searches this partition to find the object defined by the Identity parameter. - -The following two examples show how to specify a value for this parameter. - --Partition "CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - --Partition "CN=Schema,CN=Configuration,DC=EUROPE,DC=TEST,DC=CONTOSO,DC=COM" - -In many cases, a default value will be used for the Partition parameter if no value is specified. -The rules for determining the default value are given below. -Note that rules listed first are evaluated first and once a default value can be determined, no further rules will be evaluated. - -In AD DS environments, a default value for Partition will be set in the following cases: - If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. - -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain. - -In AD LDS environments, a default value for Partition will be set in the following cases: - -- If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name. -- If running cmdlets from an Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive. -- If the target AD LDS instance has a default naming context, the default value of Partition will be set to the default naming context. To specify a default naming context for an AD LDS environment, set the msDS-defaultNamingContext property of the Active Directory directory service agent (DSA) object (nTDSDSA) for the AD LDS instance. -- If none of the previous cases apply, the Partition parameter will not take any default value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns the new or modified object. -By default (i.e. -if -PassThru is not specified), this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. -The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance. - -Domain name values: - -Fully qualified domain name - -Examples: corp.contoso.com - -NetBIOS name - -Example: CORP - -Directory server values: - -Fully qualified directory server name - -Example: corp-DC12.corp.contoso.com - -NetBIOS name - -Example: corp-DC12 - -Fully qualified directory server name and port - -Example: corp-DC12.corp.contoso.com:3268 - -The default value for the Server parameter is determined by one of the following methods in the order that they are listed: - --By using Server value from objects passed through the pipeline. - --By using the server information associated with the Active Directory PowerShell provider drive, when running under that drive. - --By using the domain of the computer running Powershell. - -The following example shows how to specify a full qualified domain name as the parameter value. - --Server "corp.contoso.com" - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None or Microsoft.ActiveDirectory.Management.ADAccount -An account object is received by the Identity parameter. - -Derived types, such as the following are also accepted: - -Microsoft.ActiveDirectory.Management.ADUser - -Microsoft.ActiveDirectory.Management.ADComputer - -Microsoft.ActiveDirectory.Management.ADServiceAccount - -## OUTPUTS - -### None - -## NOTES -* This cmdlet does not work with an Active Directory Snapshot. - - This cmdlet does not work with a read-only domain controller. - -## RELATED LINKS - -[Clear-ADAccountExpiration](./Clear-ADAccountExpiration.md) - -[Disable-ADAccount](./Disable-ADAccount.md) - -[Enable-ADAccount](./Enable-ADAccount.md) - -[Get-ADAccountAuthorizationGroup](./Get-ADAccountAuthorizationGroup.md) - -[Search-ADAccount](./Search-ADAccount.md) - -[Set-ADAccountControl](./Set-ADAccountControl.md) - -[Set-ADAccountExpiration](./Set-ADAccountExpiration.md) - -[Set-ADAccountPassword](./Set-ADAccountPassword.md) - diff --git a/docset/winserver2012-ps/adcsadministration/adcsadministration.md b/docset/winserver2012-ps/adcsadministration/adcsadministration.md deleted file mode 100644 index 0cb389d75c..0000000000 --- a/docset/winserver2012-ps/adcsadministration/adcsadministration.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.3.0.0 -Locale: en-US -Module Guid: bcc14c75-ede8-486e-97a5-5bf775c4a221 -Module Name: adcsadministration ---- - -# ADCSAdministration Module -## Description -This topic contains the brief descriptions of the Windows PowerShell® cmdlets that are for use in administering the Active Directory Certificate Services (AD CS) certification authority (CA) role service. Each cmdlet in the table is linked to additional information about that cmdlet. - -## ADCSAdministration Cmdlets -### [Add-CAAuthorityInformationAccess](./Add-CAAuthorityInformationAccess.md) -Configures the Authority Information Access (AIA) or Online Certificate Status Protocol (OCSP) for a certification authority (CA). - -### [Add-CACrlDistributionPoint](./Add-CACrlDistributionPoint.md) -Adds a certificate revocation list (CRL) distribution point uniform resource indicator (URI) where AD CS publishes certification revocations. - -### [Add-CATemplate](./Add-CATemplate.md) -Adds a certificate template to the CA. - -### [Get-CAAuthorityInformationAccess](./Get-CAAuthorityInformationAccess.md) -Gets the Authority Information Access (AIA) and Online Certificate Status Protocol (OCSP) URI information set on the AIA extension of the certification authority (CA) properties. - -### [Get-CACrlDistributionPoint](./Get-CACrlDistributionPoint.md) -Gets all the locations set on the CRL distribution point (CDP) extension of the certification authority (CA) properties. - -### [Get-CATemplate](./Get-CATemplate.md) -Gets the list of templates set on the certification authority (CA) for issuance of certificates. - -### [Remove-CAAuthorityInformationAccess](./Remove-CAAuthorityInformationAccess.md) -Removes authority information access (AIA) or Online Certificate Status Protocol (OCSP) URI from the AIA extension set on the certification authority. - -### [Remove-CACrlDistributionPoint](./Remove-CACrlDistributionPoint.md) -Removes the URI for the certificate revocation list (CRL) distribution point (CDP) from the certification authority (CA). - -### [Remove-CATemplate](./Remove-CATemplate.md) -Removes the templates from the certification authority (CA) which were set for issuance of certificates. - diff --git a/docset/winserver2012-ps/adcsadministration/add-caauthorityinformationaccess.md b/docset/winserver2012-ps/adcsadministration/add-caauthorityinformationaccess.md deleted file mode 100644 index 1d3811a551..0000000000 --- a/docset/winserver2012-ps/adcsadministration/add-caauthorityinformationaccess.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/add-caauthorityinformationaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-CAAuthorityInformationAccess - -## SYNOPSIS -Configures the Authority Information Access (AIA) or Online Certificate Status Protocol (OCSP) for a certification authority (CA). - -## SYNTAX - -### AddAsInputObject -``` -Add-CAAuthorityInformationAccess [-InputObject] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### AddAsAIA -``` -Add-CAAuthorityInformationAccess [-Uri] [-AddToCertificateAia] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### AddAsOCSP -``` -Add-CAAuthorityInformationAccess [-Uri] [-AddToCertificateOcsp] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Add-CAAuthorityInformationAccess cmdlet configures the uniform resource identifier (URI) for the AIA or Online Responder OCSP location for a CA. -An AIA URI should specify either an AIA extension or an OCSP extension, but not both. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Add-CAAuthorityInformationAccess -AddToCertificateAia -uri http://ca1.corp.contoso.com/pki -``` - -Description - ------------ - -Adds Authority Information Access (AIA) for the specified certification authority to http://ca1.corp.contoso.com/pki - -### -------------------------- EXAMPLE 2 -------------------------- -``` -PS C:\>Add-CAAuthorityInformationAccess -AddToCertificateOcsp -uri http://www.corp.contoso.com/ocsp -``` - -Description - ------------ - -Adds AIA for OCSP pointing to http://www.corp.contoso.com/ocsp - -### -------------------------- EXAMPLE 3 -------------------------- -``` -PS C:\>$aia = Get-CAAuthorityInformationAccess - - -PS C:\>$aia | remove-CAAuthorityInformationAccess -``` - -These commands remove all AIA entries - -## PARAMETERS - -### -AddToCertificateAia -Specifies to add the URI to the AIA extension of the issued certificate. - -```yaml -Type: SwitchParameter -Parameter Sets: AddAsAIA -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToCertificateOcsp -Specifies to add the URI to the Online Responder OCSP extension of the issued certificate. - -```yaml -Type: SwitchParameter -Parameter Sets: AddAsOCSP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses all user prompts. -By default, you are prompted to confirm each operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -The input object is meant to be used in a pipeline command. - -```yaml -Type: AuthorityInformationAccess -Parameter Sets: AddAsInputObject -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Uri -Specifies a URI for the AIA or Online Responder OCSP location. - -```yaml -Type: String -Parameter Sets: AddAsAIA, AddAsOCSP -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.CA.AuthorityInformationAccessResult -This output object has a single property named Restart of Boolean type, which by default is set to True. - -## NOTES - -## RELATED LINKS - -[Get-CAAuthorityInformationAccess](./Get-CAAuthorityInformationAccess.md) - -[Remove-CAAuthorityInformationAccess](./Remove-CAAuthorityInformationAccess.md) - diff --git a/docset/winserver2012-ps/adcsadministration/add-cacrldistributionpoint.md b/docset/winserver2012-ps/adcsadministration/add-cacrldistributionpoint.md deleted file mode 100644 index 357737829e..0000000000 --- a/docset/winserver2012-ps/adcsadministration/add-cacrldistributionpoint.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/add-cacrldistributionpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-CACrlDistributionPoint - -## SYNOPSIS -Adds a certificate revocation list (CRL) distribution point uniform resource indicator (URI) where AD CS publishes certification revocations. - -## SYNTAX - -``` -Add-CACrlDistributionPoint [-Uri] [-AddToCertificateCdp] [-AddToFreshestCrl] [-AddToCrlCdp] - [-AddToCrlIdp] [-PublishToServer] [-PublishDeltaToServer] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-CACRLDistributionPoint cmdlet adds a certificate revocation list (CRL) distribution point URI where the CA publishes certification revocations. - -You can add certificate revocation list (CRL) distribution points in issued certificates by using this powershell cmdlet. -However, adding the URL for a CRL distribution point only affects newly issued certificates. -Previously issued certificates will continue to reference the original location. - -To indicate that you want to use a URL as a CRL distribution point, use the switch PublishCRL. - -To indicate that you want to use a URL as a delta CRL distribution point, use the switch PublishDeltaCRL. - -To indicate that you want to publish this location in CRLs to point clients to a delta CRL, use the switch IncludeDeltaCRLs. - -CRL uniform resource locators can be HTTP or LDAP paths. -You can use the following variables depending upon the switch when specifying the address of the CRL. - -\, which is replaced by the name of the targeted CA. - -\, which is replaced by object class identifier for a CA, used when publishing to an LDAP URL. - -\, which is replaced by sanitized name of the CA, truncated to 32 characters with a hash at the end. - -\, which is replaced by the object class identifier for CRL distribution points, used when publishing to an LDAP URL. - -\, which is replaced by the renewal extension of the CA. - -\, which is replaced by the location of the Configuration container in Active Directory Domain Services (AD DS) location. - -\, which is replaced by inserts a name suffix at the end of the file name when publishing a CRL to a file or URL. - -\, which is replaced by the CRLNameSuffix variable with a separate suffix to distinguish the delta CRL from the CRL; used when a delta CRL is published. - -\, which is replaced by the DNS name of the CA server. - -\, which is replaced by the NetBIOS name of the CA server. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-CACRLDistributionPoint -Uri http://ca1.corp.contoso.com/pki/.crl -AddToCertificateCdp -``` - -Description - ------------ - -Adds a certificate revocation list (CRL) distribution point for the URI of http://ca1.corp.contoso.com/pki/\.crl and sets the CRL URI to be included in issued certificates. - -## PARAMETERS - -### -AddToCertificateCdp -Include in the CDP extension of issued certificates. -This parameter is available for use with LDAP, HTTP, UNC, and File paths. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToCrlCdp -Include in the certificate revocation list (CRL). -This parameter is available for use with LDAP paths. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToCrlIdp -Include in the IDP extension of issued certificates. -This parameter is available for use with LDAP and HTTP paths. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToFreshestCrl -Include in the most recent (freshest) certificate revocation list (CRL). -This parameter is available for use with LDAP, HTTP, UNC, and file paths. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishDeltaToServer -Publish the delta certificate revocation list (CRL). -This parameter is available for use with LDAP, UNC, local, and file paths. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishToServer -Publish the certificate revocation list (CRL) to the specified server. -This parameter is available for use with LDAP, local, UNC, and file paths. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Uri -Specifies the uniform resource identifier (URI) for the distribution point location of the certificate revocation list (CRL). -This is the location from where status information about certificate revocation will be retrieved and the location the CRL will be published. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.CA.CrlDistributionPointResult -The output object type has a single property named Restart of Boolean type. -If Restart equals True, then the CA must be restarted. - -## NOTES - -## RELATED LINKS - -[Get-CACrlDistributionPoint](./Get-CACrlDistributionPoint.md) - -[Remove-CACrlDistributionPoint](./Remove-CACrlDistributionPoint.md) - diff --git a/docset/winserver2012-ps/adcsadministration/add-catemplate.md b/docset/winserver2012-ps/adcsadministration/add-catemplate.md deleted file mode 100644 index 8af03855ab..0000000000 --- a/docset/winserver2012-ps/adcsadministration/add-catemplate.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/add-catemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-CATemplate - -## SYNOPSIS -Adds a certificate template to the CA. - -## SYNTAX - -``` -Add-CATemplate [-Name] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-CATemplate cmdlet adds a certificate template to the CA for issuing. - -A certificate template is a preconfigured list of certificate settings that allows users and computers to enroll for certificates without having to create complex certificate requests. -Certificate templates allow for the customization of a certificate that can be issued by the CA. -The template defines items such as the cryptographic types, validity and renewal periods, and certificate purposes. - -The certificate templates are stored in Active Directory Domain Services (AD DS). -Many default certificate templates are added to AD DS when the CA role service is installed. -The Add-CATemplate cmdlet does not allow you to create new templates or duplicate existing templates. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-CATemplate -Name EFS -``` - -Description - ------------ - -Adds a CA template with the template display name Basic EFS and the template name EFS. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a certificate template name. -This name must always be the template name (short name without spaces) and not the template display name. -For example, the certificate template with the template display name of Exchange Enrollment Agent (Offline request) must be specified by its template name, which is EnrollmentAgentOffline. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -There is only one parameter for this cmdlet (Name) and it can only accept a single template each time specified by name as a string. - -## OUTPUTS - -### None - -## NOTES -* To perform this procedure, you must be a member of the Domain Admins group or the Enterprise Admins group in Active Directory Domain Services (AD DS), or you must have been delegated the appropriate authority. As a security best practice, consider using Run as to perform this procedure. - -## RELATED LINKS - -[Get-CATemplate](./Get-CATemplate.md) - -[Remove-CATemplate](./Remove-CATemplate.md) - diff --git a/docset/winserver2012-ps/adcsadministration/backup-caroleservice.md b/docset/winserver2012-ps/adcsadministration/backup-caroleservice.md deleted file mode 100644 index fda22ff8d7..0000000000 --- a/docset/winserver2012-ps/adcsadministration/backup-caroleservice.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -ms.date: 12/27/2016 -online version: https://learn.microsoft.com/powershell/module/adcsadministration/backup-caroleservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 -title: Backup-CARoleService ---- - -# Backup-CARoleService - -## SYNOPSIS -Backs up the CA database and private key information. - -## SYNTAX - -### Key -``` -Backup-CARoleService [-Path] [-Force] [-KeyOnly] [-Password ] [] -``` - -### Database -``` -Backup-CARoleService [-Path] [-Force] [-DatabaseOnly] [-Incremental] [-KeepLog] [] -``` - -### All -``` -Backup-CARoleService [-Path] [-Force] [-Password ] [-Incremental] [-KeepLog] - [] -``` - -## DESCRIPTION -The **Backup-CARoleService** cmdlet backs up the certification authority (CA) database and private key information to a specified path. - -## EXAMPLES - -### Example 1: Back up the CA database and private key information -``` -PS C:\> Backup-CARoleService -Path "C:\CABackup" -``` - -This command exports the CA database and private key information to the specified path. - -### Example 2: Back up the CA database only -``` -PS C:\> Backup-CARoleService -Path "C:\CABackup" -DatabaseOnly -``` - -This command exports the CA database to the specified path. -The command does not back up the CA private key information. - -### Example 3: Back up the CA key only -``` -PS C:\> Backup-CARoleService -Path "C:\CABackup" -KeyOnly -``` - -This command exports the CA private key information to the specified path. -The command does not back up the CA database. - -## PARAMETERS - -### -DatabaseOnly -Indicates that the cmdlet backs up only the certification authority database. - -```yaml -Type: SwitchParameter -Parameter Sets: Database -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Incremental -Indicates that the cmdlet performs incremental database back up. - -```yaml -Type: SwitchParameter -Parameter Sets: Database, All -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeepLog -Indicates that the cmdlet does not truncate database logs. - -```yaml -Type: SwitchParameter -Parameter Sets: Database, All -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyOnly -Indicates that the cmdlet backs up only the CA private key and certificate. - -```yaml -Type: SwitchParameter -Parameter Sets: Key -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies a password, as a secure string, to protect private key and certificate information. -To obtain a secure string, use the [ConvertTo-SecureString](https://go.microsoft.com/fwlink/?LinkID=113291) cmdlet. -For more information, type `Get-Help ConvertTo-SecureString`. - -```yaml -Type: SecureString -Parameter Sets: Key, All -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the directory to which the cmdlet backs up the CA database and private key. -If you back up the database, the cmdlet creates a new subdirectory named Database that contains the database backup. -If you back up the private key, the cmdlet writes the private key to a .p12 file in the Database subdirectory in the path that you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[ConvertTo-SecureString](https://go.microsoft.com/fwlink/?LinkID=113291) - -[Restore-CARoleService](./Restore-CARoleService.md) - diff --git a/docset/winserver2012-ps/adcsadministration/confirm-caendorsementkeyinfo.md b/docset/winserver2012-ps/adcsadministration/confirm-caendorsementkeyinfo.md deleted file mode 100644 index 86039ed2a6..0000000000 --- a/docset/winserver2012-ps/adcsadministration/confirm-caendorsementkeyinfo.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -ms.date: 12/27/2016 -online version: https://learn.microsoft.com/powershell/module/adcsadministration/confirm-caendorsementkeyinfo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 -title: Confirm-CAEndorsementKeyInfo ---- - -# Confirm-CAEndorsementKeyInfo - -## SYNOPSIS -Checks whether the local CA trusts secure hardware for key attestation. - -## SYNTAX - -### PublicKeyHash -``` -Confirm-CAEndorsementKeyInfo [-PublicKeyHash] [] -``` - -### Certificate -``` -Confirm-CAEndorsementKeyInfo [-Certificate] [] -``` - -## DESCRIPTION -The **Confirm-CAEndorsementKeyInfo** cmdlet checks whether the local certification authority (CA) trusts secure hardware, such as a Trusted Platform Module (TPM), for key attestation. -The cmdlet checks the endorsement key or certificate. -An endorsement key is permanently embedded in the security hardware. -The public portion of the endorsement key helps to recognize genuine security hardware. - -This cmdlet verifies whether the endorsement public certificate connects by means of a certificate chain to an anchor that the CA trusts for key attestation. -Specify an X509 certificate by using the *Certificate* parameter. - -This cmdlet checks whether the endorsement public key exists as a file in a folder configured at the local CA for key attestation. -Specify the public key by using the *PublicKeyHash* parameter. - -## EXAMPLES - -### Example 1: Check an endorsement certificate -``` -PS C:\> Confirm-CAEndorsementKeyInfo -Certificate Contoso87.cer - -True -``` - -This command checks whether the endorsement certificate Contoso87.cer connects, by means of a certificate chain, to a trusted anchor. -This example returns a value of $True. - -### Example 2: Check an endorsement key -``` -PS C:\> Confirm-CAEndorsementKeyInfo -PublicKeyHash "1dd117facfbdcbd8713b9c588eef305e61ce3d8e3c6e21e6323a877476ecd167" -False -``` - -The command checks for the endorsement public certificate specified as an SHA-256 hash code. -This example returns a value of $False. -Therefore, the CA does not have this public key. - -## PARAMETERS - -### -Certificate -Specifies an X509 public key certificate issued to secure hardware. - -```yaml -Type: X509Certificate2 -Parameter Sets: Certificate -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PublicKeyHash -Specifies an endorsement public key of the secure hardware, as the result of the SHA-256 hash algorithm. -This is a 64 character hexadecimal string. - -```yaml -Type: String -Parameter Sets: PublicKeyHash -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String, System.Security.Cryptography.X509Certificate2 - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adcsadministration/get-caauthorityinformationaccess.md b/docset/winserver2012-ps/adcsadministration/get-caauthorityinformationaccess.md deleted file mode 100644 index 40f3f3c668..0000000000 --- a/docset/winserver2012-ps/adcsadministration/get-caauthorityinformationaccess.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/get-caauthorityinformationaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CAAuthorityInformationAccess - -## SYNOPSIS -Gets the Authority Information Access (AIA) and Online Certificate Status Protocol (OCSP) URI information set on the AIA extension of the certification authority (CA) properties. - -## SYNTAX - -``` -Get-CAAuthorityInformationAccess [] -``` - -## DESCRIPTION -The Get-CAAuthorityInformationAccess cmdlet gets the Authority Information Access (AIA) and Online Certificate Status Protocol (OCSP) URI information set on the AIA extension of the certification authority (CA) properties. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-CAAuthorityInformationAccess -``` - -Description - ------------ - -Returns the current authority information access (AIA) and online certificate status protocol (OCSP) settings information for the certification authority (CA). - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None. - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.CA.AuthorityInformationAccess -Output object is an array of Authority Information Access (AIA) (Microsoft.CertificateServices.Management.Cmdlets.CA.AuthorityInformationAcces) objects. -Each object will contain URI and different Boolean properties as follows: - -Name: Type - -Uri: String - -AddToCertificateAia: Boolean - -AddToCertificateOcsp: Boolean - -## NOTES - -## RELATED LINKS - -[Add-CAAuthorityInformationAccess](./Add-CAAuthorityInformationAccess.md) - -[Remove-CAAuthorityInformationAccess](./Remove-CAAuthorityInformationAccess.md) - diff --git a/docset/winserver2012-ps/adcsadministration/get-cacrldistributionpoint.md b/docset/winserver2012-ps/adcsadministration/get-cacrldistributionpoint.md deleted file mode 100644 index ee5760167a..0000000000 --- a/docset/winserver2012-ps/adcsadministration/get-cacrldistributionpoint.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/get-cacrldistributionpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CACrlDistributionPoint - -## SYNOPSIS -Gets all the locations set on the CRL distribution point (CDP) extension of the certification authority (CA) properties. - -## SYNTAX - -``` -Get-CACrlDistributionPoint [] -``` - -## DESCRIPTION -The Get-CACRLDistributionPoint cmdlet gets all the locations set on the CRL distribution point (CDP) extension of the certification authority (CA) properties. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-CACrlDistributionPoint -``` - -Description - ------------ - -Returns a certification authority (CA) certificate revocation list (CRL) distribution point (CDP) type object, which contains the settings information and uniform resource indicator (URI) that correspond to the CDP for the current CA. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### none - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.CA.CrlDistributionPoint -Output object is an array of CRL Distribution Point (CDP) (Microsoft.CertificateServices.Management.Cmdlets.CA.CrlDistributionPoint) Each object will contain URI and different Boolean properties as follows: - -PublishToServer: boolean - -PublishDeltaToServer: boolean - -AddToCertificateCdp: boolean - -AddToFreshestCrl: boolean - -AddToCrlCdp: boolean - -AddToCrlIdp: boolean - -Uri: String - -## NOTES - -## RELATED LINKS - -[Add-CACrlDistributionPoint](./Add-CACrlDistributionPoint.md) - -[Remove-CACrlDistributionPoint](./Remove-CACrlDistributionPoint.md) - diff --git a/docset/winserver2012-ps/adcsadministration/get-catemplate.md b/docset/winserver2012-ps/adcsadministration/get-catemplate.md deleted file mode 100644 index 81f91e2506..0000000000 --- a/docset/winserver2012-ps/adcsadministration/get-catemplate.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/get-catemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CATemplate - -## SYNOPSIS -Gets the list of templates set on the certification authority (CA) for issuance of certificates. - -## SYNTAX - -``` -Get-CATemplate [] -``` - -## DESCRIPTION -The Get-CATemplate cmdlet gets the list of templates set on the CA for issuance of certificates. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-CATemplate -``` - -Description - ------------ - -Return a list of certificate template entries that each contain a template name. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.Common.CertificateTemplate -The output object type will contain an array of certificate template objects which will have two properties: (1) Object Name and (2) Object ID (OID). -Both properties are of string type. - -## NOTES - -## RELATED LINKS - -[Add-CATemplate](./Add-CATemplate.md) - -[Remove-CATemplate](./Remove-CATemplate.md) - diff --git a/docset/winserver2012-ps/adcsadministration/remove-caauthorityinformationaccess.md b/docset/winserver2012-ps/adcsadministration/remove-caauthorityinformationaccess.md deleted file mode 100644 index f331b840e8..0000000000 --- a/docset/winserver2012-ps/adcsadministration/remove-caauthorityinformationaccess.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/remove-caauthorityinformationaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-CAAuthorityInformationAccess - -## SYNOPSIS -Removes authority information access (AIA) or Online Certificate Status Protocol (OCSP) URI from the AIA extension set on the certification authority. - -## SYNTAX - -### RemoveAsAIA (Default) -``` -Remove-CAAuthorityInformationAccess [-Uri] [-AddToCertificateAia] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### RemoveAsOCSP -``` -Remove-CAAuthorityInformationAccess [-Uri] [-AddToCertificateOcsp] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Remove-CAAuthorityInformationAccess cmdlet removes the Authority Information Access (AIA) or Online Certificate Status Protocol (OCSP) URI from the AIA extension set on the certification authority. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-CAAuthorityInformationAccess -uri "http://www.contoso.com/pki/orca1.crt" -AddToCertificateAia -``` - -Description - ------------ - -Removes Authority Information Access (AIA) for the specified uniform resource identifier (URI) of 'http://www.contoso.com/pki/orca1.crt'. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-CAAuthorityInformationAccess -uri "http://www.cpandl.com/ocsp/" -AddToCertificateOcsp -``` - -Description - ------------ - -Removes the Online Certificate Status Protocol (OCSP) for the specified uniform resource identifier (URI) of 'http://www.cpandl.com/ocsp'. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Remove-CAAuthorityInformationAccess -uri "http://www.contoso.com/pki/orca1.crt" -``` - -Description - ------------ - -Removes all AIA and OCSP entries that match the URL 'http://www.contoso.com/pki/orca1.crt'. - -## PARAMETERS - -### -AddToCertificateAia -This switch indicates the Authority Information Access (AIA) uniform resource information (URI). - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveAsAIA -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToCertificateOcsp -This switch indicates an Online Responder's uniform resource information (URI). - -```yaml -Type: SwitchParameter -Parameter Sets: RemoveAsOCSP -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the uniform resource identifier (URI) from where the certificate for the certification authority (CA) can be downloaded or the online responder information can be obtained. -This information is added to the CA properties and registry. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.CA.AuthorityInformationAccessResult - -## NOTES -* You must be a member of Enterprise Admins group to successfully run this command. - -## RELATED LINKS - -[Add-CAAuthorityInformationAccess](./Add-CAAuthorityInformationAccess.md) - -[Get-CAAuthorityInformationAccess](./Get-CAAuthorityInformationAccess.md) - diff --git a/docset/winserver2012-ps/adcsadministration/remove-cacrldistributionpoint.md b/docset/winserver2012-ps/adcsadministration/remove-cacrldistributionpoint.md deleted file mode 100644 index 97d735348a..0000000000 --- a/docset/winserver2012-ps/adcsadministration/remove-cacrldistributionpoint.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/remove-cacrldistributionpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-CACrlDistributionPoint - -## SYNOPSIS -Removes the URI for the certificate revocation list (CRL) distribution point (CDP) from the certification authority (CA). - -## SYNTAX - -``` -Remove-CACrlDistributionPoint [-Uri] [-AddToCertificateCdp] [-AddToFreshestCrl] [-AddToCrlCdp] - [-AddToCrlIdp] [-PublishToServer] [-PublishDeltaToServer] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-CACRLDistributionPoint cmdlet removes the uniform resource identifier (URI) for the certificate revocation list (CRL) distribution point from the certification authority (CA). - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-CACrlDistributionPoint -URI "http://corp.contoso.com/rootca.crl" -``` - -Description - ------------ - -Removes all URIs for all distribution points that contain the specified URI value ("http://corp.contoso.com/rootca.crl"). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-CACrlDistributionPoint -Uri "http://corp.contoso.com/rootca.crl" -AddToCertificateCdp -``` - -Description - ------------ - -Removes only the URIs that are set to a value of "http://corp.contoso.com/rootca.crl" and for which the AddToCertificateCdp is set. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Remove-CACrlDistributionPoint -Uri "http://www.contoso.com/pki/orca.crl" -AddToCertificateCdp -AddToCrlIdp -``` - -Description - ------------ - -Removes only the uniform resource indicators (URIs) that are unique to the URI specified ("http://www.contoso.com/pki/orca.crl") and the combination of flags that are set or included (AddToCertificateCdp, AddToCrlIdp). - -## PARAMETERS - -### -AddToCertificateCdp -Remove from the CDP extension of issued certificates. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToCrlCdp -Remove from the certificate revocation list (CRL). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToCrlIdp -Remove from the IDP extension of issued certificates. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddToFreshestCrl -Remove from the most recent (freshest) certificate revocation list (CRL). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PublishDeltaToServer -Remove the delta certificate revocation list (CRL). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PublishToServer -Remove from the base certificate revocation list (CRL). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Uri -Specifies the uniform resource identifier (URI) for the distribution point location of the certificate revocation list (CRL). -This is the location from where status information about certificate revocation has been retrieved and/or the location the CRL was published. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.CertificateServices.Administration.Commands.CA.CrlDistributionPointResult -There is an output property named RestartCA, which when set to True indicates that the CA service (certsvc) needs to be restarted. - -## NOTES - -## RELATED LINKS - -[Add-CACrlDistributionPoint](./Add-CACrlDistributionPoint.md) - -[Get-CACrlDistributionPoint](./Get-CACrlDistributionPoint.md) - diff --git a/docset/winserver2012-ps/adcsadministration/remove-catemplate.md b/docset/winserver2012-ps/adcsadministration/remove-catemplate.md deleted file mode 100644 index 7dc66463f2..0000000000 --- a/docset/winserver2012-ps/adcsadministration/remove-catemplate.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -online version: https://learn.microsoft.com/powershell/module/adcsadministration/remove-catemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-CATemplate - -## SYNOPSIS -Removes the templates from the certification authority (CA) which were set for issuance of certificates. - -## SYNTAX - -### Default (Default) -``` -Remove-CATemplate [-Name] [-Force] [-WhatIf] [-Confirm] [] -``` - -### AllTemplates -``` -Remove-CATemplate [-AllTemplates] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-CATemplate cmdlet removes the templates from the certification authority (CA) which were set for issuance of certificates. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-CATemplate -AllTemplates -``` - -Description - ------------ - -All the templates on the CA set for certificates issuance are removed. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-CATemplate -Name "EFS" -``` - -Description - ------------ - -The template named "EFS" on the CA that is set for certificate issuance is removed. - -## PARAMETERS - -### -AllTemplates -Removes all certificate templates on the CA that are available for certificate issuance. -A common task administrative task is to remove all the default templates that are currently added for issuance. -This allows the administrator to add only the templates that should be available for certificate issuance in the given scenario. - -```yaml -Type: SwitchParameter -Parameter Sets: AllTemplates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Removes an individual certificate template from the CA that is available for certificate issuance. -Be sure to use the certificate template name and not the certificate template display name. -For example, the certificate template display name of Basic EFS is assigned the template name EFS. - -```yaml -Type: String -Parameter Sets: Default -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-CATemplate](./Add-CATemplate.md) - -[Get-CATemplate](./Get-CATemplate.md) - diff --git a/docset/winserver2012-ps/adcsadministration/restore-caroleservice.md b/docset/winserver2012-ps/adcsadministration/restore-caroleservice.md deleted file mode 100644 index a9a4a01048..0000000000 --- a/docset/winserver2012-ps/adcsadministration/restore-caroleservice.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. -external help file: Microsoft.CertificateServices.Administration.Commands.dll-Help.xml -Module Name: adcsadministration -ms.date: 12/27/2016 -online version: https://learn.microsoft.com/powershell/module/adcsadministration/restore-caroleservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 -title: Restore-CARoleService ---- - -# Restore-CARoleService - -## SYNOPSIS -Restores the CA database and private key information. - -## SYNTAX - -### Key -``` -Restore-CARoleService [-Path] [-Force] [-KeyOnly] [-Password ] [-WhatIf] [-Confirm] - [] -``` - -### Database -``` -Restore-CARoleService [-Path] [-Force] [-DatabaseOnly] [-WhatIf] [-Confirm] [] -``` - -### All -``` -Restore-CARoleService [-Path] [-Force] [-Password ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Restore-CARoleService** cmdlet restores the certification authority (CA) database and private key information. - -## EXAMPLES - -### Example 1: Restore the CA private key and certificate -``` -PS C:\> Restore-CARoleService -Path "C:\CABackup" -``` - -This command restores the CA private key and certificate from the specified path. - -### Example 2: Restore the CA database only -``` -PS C:\> Restore-CARoleService -Path "C:\CABackup" -DatabaseOnly -``` - -This command restores the CA database from the specified path. -The command does not restore the CA private key information. - -### Example 3: Restore the CA key only -``` -PS C:\> Restore-CARoleService -Path "C:\CABackup" -KeyOnly -``` - -This command restores the CA private key information to the specified path. -The command does not restore the CA database. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabaseOnly -Indicates that the cmdlet restores only the certification authority database. - -```yaml -Type: SwitchParameter -Parameter Sets: Database -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -KeyOnly -Indicates that the cmdlet restores only the certification authority private key and certificate. - -```yaml -Type: SwitchParameter -Parameter Sets: Key -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies a password, as a secure string, to access the private key and certificate information. -To obtain a secure string, use the [ConvertTo-SecureString](https://go.microsoft.com/fwlink/?LinkID=113291) cmdlet. -For more information, type `Get-Help ConvertTo-SecureString`. - -```yaml -Type: SecureString -Parameter Sets: Key, All -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the directory from which the cmdlet restores the CA database and private key. -The cmdlet restores the database from the subdirectory named Database in the path that you specified when you backed up the CA database. -The cmdlet restores the private key from the .p12 file that you backed up in the Database subdirectory in the path that you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Backup-CARoleService](./Backup-CARoleService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/adcsdeployment.md b/docset/winserver2012-ps/adcsdeployment/adcsdeployment.md deleted file mode 100644 index b260676967..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/adcsdeployment.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 5919a3cb-977e-464f-a221-421c270218b4 -Module Name: adcsdeployment ---- - -# ADCSDeployment Module -## Description -This topic contains the brief descriptions of the Windows PowerShell® cmdlets that are for use in deploying Active Directory Certificate Services (AD CS). Each cmdlet in the table is linked to additional information about that cmdlet. - -## ADCSDeployment Cmdlets -### [Install-AdcsCertificationAuthority](./Install-AdcsCertificationAuthority.md) -Performs installation and configuration of the Active Directory Certificate Services (AD CS) Certification Authority (CA) role service. - -### [Install-AdcsEnrollmentPolicyWebService](./Install-AdcsEnrollmentPolicyWebService.md) -Performs the configuration of Certificate Enrollment Policy Web service. - -### [Install-AdcsEnrollmentWebService](./Install-AdcsEnrollmentWebService.md) -Performs initial configuration of the Certificate Enrollment Web service. - -### [Install-AdcsNetworkDeviceEnrollmentService](./Install-AdcsNetworkDeviceEnrollmentService.md) -Installs Network Device Enrollment Service - -### [Install-AdcsOnlineResponder](./Install-AdcsOnlineResponder.md) -Installs Online Responder service - -### [Install-AdcsWebEnrollment](./Install-AdcsWebEnrollment.md) -Installs Certification Authority Web Enrollment - -### [Uninstall-AdcsCertificationAuthority](./Uninstall-AdcsCertificationAuthority.md) -Uninstalls the Certification Authority (CA) role service and removes its configuration information. - -### [Uninstall-AdcsEnrollmentPolicyWebService](./Uninstall-AdcsEnrollmentPolicyWebService.md) -Uninstalls the Certificate Enrollment Policy Web service. - -### [Uninstall-AdcsEnrollmentWebService](./Uninstall-AdcsEnrollmentWebService.md) -Uninstalls the Certificate Enrollment Web service or individual instances of it. - -### [Uninstall-AdcsNetworkDeviceEnrollmentService](./Uninstall-AdcsNetworkDeviceEnrollmentService.md) -Uninstalls the Network Device Enrollment service. - -### [Uninstall-AdcsOnlineResponder](./Uninstall-AdcsOnlineResponder.md) -Uninstalls the Online Responder service. - -### [Uninstall-AdcsWebEnrollment](./Uninstall-AdcsWebEnrollment.md) -Uninstalls the Certification Authority (CA) Web Enrollment role service. - diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcscertificationauthority.md b/docset/winserver2012-ps/adcsdeployment/install-adcscertificationauthority.md deleted file mode 100644 index 2ebb0f89c1..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/install-adcscertificationauthority.md +++ /dev/null @@ -1,506 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/install-adcscertificationauthority?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdcsCertificationAuthority - -## SYNOPSIS -Performs installation and configuration of the Active Directory Certificate Services (AD CS) Certification Authority (CA) role service. - -## SYNTAX - -### NewKeyParameterSet (Default) -``` -Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] [-ValidityPeriod ] - [-ValidityPeriodUnits ] [-CACommonName ] [-CADistinguishedNameSuffix ] - [-CAType ] [-CryptoProviderName ] [-DatabaseDirectory ] [-HashAlgorithmName ] - [-IgnoreUnicode] [-KeyLength ] [-LogDirectory ] [-OutputCertRequestFile ] - [-OverwriteExistingCAinDS] [-OverwriteExistingKey] [-ParentCA ] [-OverwriteExistingDatabase] - [-Credential ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### ExistingCertificateParameterSet -``` -Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] [-CertFilePassword ] - [-CertFile ] [-CAType ] [-CertificateID ] [-DatabaseDirectory ] - [-LogDirectory ] [-OverwriteExistingKey] [-OverwriteExistingDatabase] [-Credential ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -### ExistingKeyParameterSet -``` -Install-AdcsCertificationAuthority [-AllowAdministratorInteraction] [-ValidityPeriod ] - [-ValidityPeriodUnits ] [-CADistinguishedNameSuffix ] [-CAType ] - [-CryptoProviderName ] [-DatabaseDirectory ] [-HashAlgorithmName ] [-IgnoreUnicode] - [-KeyContainerName ] [-LogDirectory ] [-OutputCertRequestFile ] - [-OverwriteExistingCAinDS] [-ParentCA ] [-OverwriteExistingDatabase] [-Credential ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Install-AdcsCertificationAuthority** cmdlet performs installation and configuration of the Active Directory Certificate Services (AD CS) Certification Authority (CA) role service. -To remove the certification authority role service use the **Uninstall-AdcsCertificationAuthority** cmdlet. - -You can import the cmdlet by running the following commands from Windows PowerShell: - -- `Install-WindowsFeature Adcs-Cert-Authority` - -To include the Certification Authority and Certificate Templates consoles in a CA installation, you must use the *IncludeManagementTools* parameter at the end of the `Install-WindowsFeature Adcs-Cert-Authority` command. - -Int is equivalent to Int32 in the [.NET Framework](/dotnet/csharp/language-reference/builtin-types/built-in-types). - -## EXAMPLES - -### Example 1: Install a new Standalone Root CA with default settings -```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType StandaloneRootCa -``` - -This command installs a new Standalone Root CA with default settings. - -### Example 2: Install a new Enterprise Root CA using a specific provider and key length -```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseRootCa -CryptoProviderName "ECDSA_P256#Microsoft Software Key Storage Provider" -KeyLength 256 -HashAlgorithmName SHA256 -``` - -This command installs a new Enterprise Root CA using the provider named ECDSA_P256 Microsoft Software Key Storage Provider, key length of 256, and the hash algorithm named SHA 256. - -### Example 3: Install a new Enterprise Root CA using a specific provider and a validity period -```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseRootCa -CryptoProviderName "RSA#Microsoft Software Key Storage Provider" -KeyLength 2048 -HashAlgorithmName SHA1 -ValidityPeriod Years -ValidityPeriodUnits 3 -``` - -This command installs a new Enterprise Root CA using a RSA algorithm using the provider named Microsoft Software Key Storage Provider, a key length of 2048, a hash algorithm named SHA 1, and validity period of three years. - -### Example 4: Install a new Enterprise Subordinate CA using a parent CA -```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseSubordinateCa -ParentCA SERVER75.corp.contoso.com\SERVER75-CA -``` - -This command installs a new Enterprise subordinate CA, the parent CA is SERVER75 in the CORP domain of Contoso.com. - -### Example 5: Install a new Enterprise Subordinate CA using an existing certificate -```powershell -PS C:\> Install-AdcsCertificationAuthority -CAType EnterpriseSubordinateCa -CertFile C:\Cert\SERVER80-CA.p12 -CertFilePassword (read-host "Set user password" -assecurestring) -``` - -This command installs an Enterprise Subordinate CA using an existing certificate from a PFX/P12 file that is located on the local C:\Cert folder named SERVER80-CA.p12. - -## PARAMETERS - -### -AllowAdministratorInteraction -Specifies whether prompting is enabled when the private key is accessed. -This is not required for any of the Microsoft default providers. -For enhanced security components, such as a hardware security module (HSM), review the enhanced security component vendor documentation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CACommonName -Specifies the certification authority common name. - -```yaml -Type: String -Parameter Sets: NewKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CADistinguishedNameSuffix -Specifies the certification authority distinguished name suffix. - -```yaml -Type: String -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CAType -Specifies the type of certification authority that this cmdlet installs. -The acceptable values for this parameter are: - -- EnterpriseRootCA -- EnterpriseSubordinateCA -- StandaloneRootCA -- StandaloneSubordinateCA - -```yaml -Type: CAType -Parameter Sets: (All) -Aliases: -Accepted values: EnterpriseRootCA, EnterpriseSubordinateCA, StandaloneRootCA, StandaloneSubordinateCA - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertFile -Specifies the file name of certification authority PKCS #12 formatted certificate file. - -```yaml -Type: String -Parameter Sets: ExistingCertificateParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertFilePassword -Specifies the password for certification authority certificate file. - -```yaml -Type: SecureString -Parameter Sets: ExistingCertificateParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CertificateID -Specifies the thumbprint or serial number of certification authority certificate. - -```yaml -Type: String -Parameter Sets: ExistingCertificateParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a **PSCredential** object for the connection to AD DS. -To obtain a credential object, use the **Get-Credential** cmdlet. -For more information, type `Get-Help Get-Credential`. -To install an enterprise certification authority, the computer must be joined to an AD DS domain and a user account that is a member of the Enterprise Admin group is required. -To install a standalone certification authority, the computer can be in a workgroup or AD DS domain. -If the computer is in a workgroup, a user account that is a member of Administrators is required. -If the computer is in an AD DS domain, a user account that is a member of Domain Admins is required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CryptoProviderName -The name of the cryptographic service provider (CSP) or key storage provider (KSP) that is used to generate or store the private key for the CA. - -```yaml -Type: String -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DatabaseDirectory -Specifies the folder location of the certification authority database. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HashAlgorithmName -Specifies the signature hash algorithm used by the certification authority. - -```yaml -Type: String -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IgnoreUnicode -Specifies that Unicode characters are allowed in certification authority name string. - -```yaml -Type: SwitchParameter -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyContainerName -Specifies the name of an existing private key container. - -```yaml -Type: String -Parameter Sets: ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyLength -Specifies the bit length for new certification authority key. - -```yaml -Type: Int32 -Parameter Sets: NewKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogDirectory -Specifies the folder location of the certification authority database log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OutputCertRequestFile -Specifies the folder location for certificate request file. - -```yaml -Type: String -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OverwriteExistingCAinDS -Specifies that the computer object in the Active Directory Domain Service domain should be overwritten with the same computer name. - -```yaml -Type: SwitchParameter -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OverwriteExistingDatabase -Specifies that the existing certification authority database should be overwritten. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OverwriteExistingKey -Overwrite existing key container with the same name - -```yaml -Type: SwitchParameter -Parameter Sets: NewKeyParameterSet, ExistingCertificateParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentCA -Specifies the configuration string of the parent certification authority that will certify this CA. - -```yaml -Type: String -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidityPeriod -Specifies the validity period of the certification authority (CA) certificate in hours, days, weeks, months or years. -If this is a subordinate CA, do not use this parameter, because the validity period is determined by the parent CA. - -```yaml -Type: ValidityPeriod -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: -Accepted values: Hours, Days, Weeks, Months, Years - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValidityPeriodUnits -Validity period of the certification authority (CA) certificate. -If this is a subordinate CA, do not specify this parameter because the validity period is determined by the parent CA. - -```yaml -Type: Int32 -Parameter Sets: NewKeyParameterSet, ExistingKeyParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### bool, string, string, enum, string, SecureString, string, string, string, string, bool, string, long, string, string, bool, bool, bool, string, enum, long - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.CA.CertificationAuthoritySetupResult - -## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the -f switch to bypass the prompt for confirmation. -To see parameters, run the following command: Install-AdcsCertificationAuthority -? -If you have installation issues, try using the -verbose switch to get verbose output and review the information in the %windir%\cerocm.log. - -## RELATED LINKS - -[Uninstall-AdcsCertificationAuthority](./Uninstall-AdcsCertificationAuthority.md) diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcsenrollmentpolicywebservice.md b/docset/winserver2012-ps/adcsdeployment/install-adcsenrollmentpolicywebservice.md deleted file mode 100644 index fa6ae68bf6..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/install-adcsenrollmentpolicywebservice.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/install-adcsenrollmentpolicywebservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdcsEnrollmentPolicyWebService - -## SYNOPSIS -Performs the configuration of Certificate Enrollment Policy Web service. - -## SYNTAX - -``` -Install-AdcsEnrollmentPolicyWebService [-AuthenticationType ] [-SSLCertThumbprint ] - [-KeyBasedRenewal] [-Force] [-Credential ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-AdcsEnrollmentPolicyWebService cmdlet performs the configuration of Certificate Enrollment Policy Web service. -It is also used to create additional instances of the service within an existing installation. -To remove the certification authority role service use the Uninstall-AdcsEnrollmentPolicyWebService cmdlet. - -You can import the cmdlet by running the following commands from Windows PowerShell: -`Import-Module ServerManager` -`Add-WindowsFeature Adcs-Enroll-Web-Pol` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-AdcsEnrollmentPolicyWebService -AuthenticationType Kerberos -SSLCertThumbprint -``` - -Description - ------------ - -This command installs the Certificate Enrollment Policy Web Service using Kerberos for authentication. -Replace \ with the actual certificate thumbprint. -For information on obtaining a certificate thumbprint using PowerShell, see Certificate Provider (http://go.microsoft.com/fwlink/?LinkId=225044). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Install-AdcsEnrollmentPolicyWebService -AuthenticationType Username -SSLCertThumbprint -``` - -Description - ------------ - -This command installs the Certificate Enrollment Policy Web Service specifying that username and password is used for authentication. -Replace \ with the actual certificate thumbprint. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Install-AdcsEnrollmentPolicyWebService -AuthenticationType Username -SSLCertThumbprint -KeyBasedRenewal -``` - -Description - ------------ - -This command installs the Certificate Enrollment Policy Web Service specifying that username and password is used for authentication and configures the service for Key-Based Renewal of the certificate. -Replace \ with the actual certificate thumbprint. - -## PARAMETERS - -### -AuthenticationType -Defines the authentication type used by the Certificate Enrollment Policy Web Service: Certificate, Kerberos, or UserName. - -```yaml -Type: AuthenticationType -Parameter Sets: (All) -Aliases: -Accepted values: Kerberos, UserName, Certificate - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials for installing the Enrollment Policy Web Service. -The Enrollment Policy Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. -You must use an account that is a member of Domain Admins group to install this service. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyBasedRenewal -Configures the Certificate Enrollment Policy Web Service to operate in key-based renewal mode. -Key-based renewal allows certificate clients to renew their certificates using the key of their existing certificate for authentication. -When in key-based renewal mode, the service will only return certificate templates that are set for key based renewal. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SSLCertThumbprint -Specifies the thumbprint of the certificate used by Internet Information Service (IIS) to enable support for required Secure Sockets Layer (SSL). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### enum, string, bool, PSCredential - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.CEP.EnrollmentPolicyServiceResult - -## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the -force switch to bypass the prompt for confirmation. - - To see parameters, run the following command: install-AdcsEnrollmentPolicyWebService -? - -* You can get the CA configuration, which is the computer name and CA name by running certutil without any parameters. You can see the certificate SSL certificate thumbprints assigned to the local computer by running the following commands: -`cd cert:\LocalMachine\My` -`dir | format-list` - -## RELATED LINKS - -[Uninstall-AdcsEnrollmentPolicyWebService](./Uninstall-AdcsEnrollmentPolicyWebService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcsenrollmentwebservice.md b/docset/winserver2012-ps/adcsdeployment/install-adcsenrollmentwebservice.md deleted file mode 100644 index fa6980defe..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/install-adcsenrollmentwebservice.md +++ /dev/null @@ -1,292 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/install-adcsenrollmentwebservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdcsEnrollmentWebService - -## SYNOPSIS -Performs initial configuration of the Certificate Enrollment Web service. - -## SYNTAX - -### DefaultParameterSet (Default) -``` -Install-AdcsEnrollmentWebService [-CAConfig ] [-ApplicationPoolIdentity] - [-AuthenticationType ] [-SSLCertThumbprint ] [-RenewalOnly] - [-AllowKeyBasedRenewal] [-Force] [-Credential ] [-WhatIf] [-Confirm] [] -``` - -### ServiceAccountParameterSet -``` -Install-AdcsEnrollmentWebService [-CAConfig ] -ServiceAccountName - -ServiceAccountPassword [-AuthenticationType ] - [-SSLCertThumbprint ] [-RenewalOnly] [-AllowKeyBasedRenewal] [-Force] [-Credential ] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-AdcsEnrollmentWebService cmdlet performs the configuration of Certificate Enrollment Web service. -It is also used to create additional instances of the service within an existing installation. -To remove the Certificate Enrollment Web Service role service use the Uninstall-AdcsEnrollmentWebService cmdlet. - -You can import the cmdlet by running the following commands from Windows PowerShell: -`Import-Module ServerManager` -`Add-WindowsFeature Adcs-Enroll-Web-Svc` - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-AdcsEnrollmentWebService -ApplicationPoolIdentity -CAConfig CA1.contoso.com\contoso-CA1-CA -SSLCertThumbprint -AuthenticationType Certificate -``` - -Description - ------------ - -This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of CA1.contoso.com and a CA common name contoso-CA1-CA. -The identity of the Certificate Enrollment Web Service is specified as the default application pool identity. -The placeholder \ should be replaced with the actual thumbprint of the certificate associated with the service. -The authentication type is certificate based. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Install-AdcsEnrollmentWebService -CAConfig APP1.corp.contoso.com\corp-APP1-CA -SSLCertThumbprint -ServiceAccountName Corp\CEPAcct1 -ServiceAccountPassword (read-host "Set user password" -assecurestring) -``` - -Description - ------------ - -This command installs the Certificate Enrollment Web Service to use the certification authority with a computer name of APP1.corp.contoso.com and a CA common name corp-APP1-CA. -The placeholder \ should be replaced with the actual thumbprint of the certificate associated with the service. -The identity of the Certificate Enrollment Web Service is specified as CEPAcct1 from the Corp domain. -The command will prompt for the user password. - -## PARAMETERS - -### -AllowKeyBasedRenewal -Specifies that the enrollment server accept key based renewal requests, which are valid client certificate for authentication that do not directly map to a security principal. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ApplicationPoolIdentity -Specifies the identity that the Certificate Enrollment Web Service will use when communicating with the Certification Authority (CA). -This parameter is only valid when Certificate Enrollment Web Service will be targeting a remote CA. -If not specified, the local application pool identity is used. -This parameter is only valid when installing the first instance of the Certificate Enrollment Web Service. -If this installation will be for an additional instance of Certificate Enrollment Web Service on this server, then this parameter should not be specified. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the authentication type. -Valid options include: Certificate, Kerberos, and UserName. - -```yaml -Type: AuthenticationType -Parameter Sets: (All) -Aliases: -Accepted values: Kerberos, UserName, Certificate - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CAConfig -Specifies the configuration string of the Certification Authority (CA) used by the Certificate Enrollment Web Service to process enrollment requests. -This parameter depends upon whether a local CA is installed. -If the CA is local, then the parameter is optional and defaults to the local CA when not specified. -If there is not a local CA, then the parameter is required. -The input is the configuration string is \\\\. -Replace the computer name of the (CA) for \ and replace the CA common name for \. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials for installing the Certificate Enrollment Web Service. -The Certificate Enrollment Web Service must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. -If the Certificate Enrollment Web Service is configured to use a Standalone certification authority (CA), then an account that is a member of the local Administrators on the CA is required. -If the Enrollment Web Service is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RenewalOnly -Specifies that renewal only mode be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SSLCertThumbprint -Specifies the hash or thumbprint of the Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for a web site as a string value. -This parameter is optional. -If used, it will establish the necessary binding with Internet Information Server (IIS) to enable support for the required SSL/TLS connectivity. -If a binding already exists within IIS, specifying this parameter overwrites the existing binding. -If this parameter is not specified, any existing binding is used. -If no bindings exist, installation succeeds, but the service will not function until the binding is established manually. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceAccountName -Specifies the domain account for use with the service. -The input string should be in the form of \\\\. -For example, to specify an account named WebEnroll in the Corp.contoso.com domain, you would type CORP\WebEnroll. - -```yaml -Type: String -Parameter Sets: ServiceAccountParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceAccountPassword -Specifies the password for the domain account used as the service account. - -```yaml -Type: SecureString -Parameter Sets: ServiceAccountParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### bool, bool, enum, string, bool, string, SecureString, string, PSCredential - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.CES.EnrollmentServiceResult - -## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the -force switch to bypass the prompt for confirmation. -To see parameters, run the following command: install-AdcsEnrollmentWebService cmdlet -? -* You can get the CA configuration, which is the computer name and CA name by running certutil without any parameters. You can see the SSL certificate thumbprints assigned to the local computer by running the following commands: -`cd cert:\LocalMachine\My` -`dir | format-list` - -## RELATED LINKS - -[Uninstall-AdcsEnrollmentWebService](./Uninstall-AdcsEnrollmentWebService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md b/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md deleted file mode 100644 index 6f7876fafc..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/install-adcsnetworkdeviceenrollmentservice.md +++ /dev/null @@ -1,401 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/install-adcsnetworkdeviceenrollmentservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdcsNetworkDeviceEnrollmentService - -## SYNOPSIS -Installs Network Device Enrollment Service - -## SYNTAX - -### DefaultParameterSet (Default) -``` -Install-AdcsNetworkDeviceEnrollmentService [-ApplicationPoolIdentity] [-RAName ] [-RAEmail ] - [-RACompany ] [-RADepartment ] [-RACity ] [-RAState ] [-RACountry ] - [-SigningProviderName ] [-SigningKeyLength ] [-EncryptionProviderName ] - [-EncryptionKeyLength ] [-CAConfig ] [-Force] [-Credential ] [-WhatIf] [-Confirm] - [] -``` - -### ServiceAccountParameterSet -``` -Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName -ServiceAccountPassword - [-RAName ] [-RAEmail ] [-RACompany ] [-RADepartment ] [-RACity ] - [-RAState ] [-RACountry ] [-SigningProviderName ] [-SigningKeyLength ] - [-EncryptionProviderName ] [-EncryptionKeyLength ] [-CAConfig ] [-Force] - [-Credential ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-AdcsNetworkDeviceEnrollmentService cmdlet performs the configuration of the Network Device Enrollment Service (NDES) role service. - -To remove the NDES role service, use the Uninstall-AdcsNetworkDeviceEnrollmentService cmdlet - -You can import the cmdlet by running the following commands from Windows PowerShell: -Import-Module ServerManager -Add-WindowsFeature Adcs-Device-Enrollment - -Int is equivalent to Int32 in the .NET Frameworkhttp://msdn.microsoft.com/en-us/library/ya5y69ds.aspx (http://msdn.microsoft.com/en-us/library/ya5y69ds.aspx). - -## EXAMPLES - -### Example 1: Display the default NDES settings -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -WhatIf -``` - -This command displays the default NDES settings that will be configured if it is installed. - -### Example 2: Display the default NDES settings using a service account name and password -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName "CONTOSO\svcNDES" -ServiceAccountPassword (read-host "Set user password" -assecurestring) -WhatIf -``` - -This command displays the default settings when NDES is using a service account without making any changes to the configuration. -This command uses the service account named CONTOSO\svcNDES that is a member of the local computer's IIS_USRS group. - -### Example 3: Install NDES using the application pool identity -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -CAConfig "\" -``` - -This command installs NDES using the application pool identity to use a remote CA as specified by the CA computer `\`. -Substitute the appropriate CA computer name and common name for `` and ``. - -### Example 4: Install NDES using a specific service account -``` -PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName "CONTOSO\svcNDES" -ServiceAccountPassword (read-host "Set user password" -assecurestring) -CAConfig "CAComputerName\CAName" -RAName "Contoso-NDES-RA" -RACountry "US" -RACompany "Contoso" -SigningProviderName "Microsoft Strong Cryptographic Provider" -SigningKeyLength 4096 -EncryptionProviderName "Microsoft Strong Cryptographic Provider" -EncryptionKeyLength 4096 -``` - -This command installs the NDES using a service account named CONTOSO\svcNDES that is a member of the local computer's IIS_USRS group. -The command also specifies several non-default parameters. - - -Description - ------------ - -This command installs the Network Device Enrollment Service using a specific service account, which is indicated by \\\\. -The command also specifies several non-default parameters. -The example assumes that the \\\\ user/service account is a member of the local machine's IIS_USRS group. -Substitute the domain name for \ and the user account name for \. - -## PARAMETERS - -### -ApplicationPoolIdentity -Specifies the identity that the Network Device Enrollment Service (NDES) will use when communicating with the certification authority (CA). -This parameter is only valid when NDES is using a remote CA. -If the CA is local, the application pool identity account cannot be used. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CAConfig -Specifies remote certification authority (CA) that the Network Device Enrollment Service uses. -This parameter is mandatory when used within the ApplicationPoolIdentity parameter. -Do not use this parameter when a local CA is installed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -The Network Device Enrollment Service (NDES) must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. -If NDES is configured to use a Standalone certification authority (CA), then an account that is a member of the local Administrators on the CA is required. -If NDES is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionKeyLength -Specifies the encryption key length. -This option is not valid if you use existing keys during installation. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EncryptionProviderName -Specifies the name of the encryption provider, such as the name of cryptographic service provider (CSP). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RACity -Specifies the city of the registration authority. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RACompany -Specifies the organization or company that the registration authority represents. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RACountry -Specifies the country/region of the registration authority. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RADepartment -Specifies the department of the registration authority. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RAEmail -Specifies the email address of the registration authority. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RAName -Specifies the name of the Network Device Enrollment Service registration authority. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RAState -Specifies the state or province (geographical political boundary), if applicable, of the registration authority. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceAccountName -Specifies the name of the account that is used by the Network Device Enrollment Service. - -```yaml -Type: String -Parameter Sets: ServiceAccountParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceAccountPassword -Specifies the password of the service account that is used by the Network Device Enrollment Service. - -```yaml -Type: SecureString -Parameter Sets: ServiceAccountParameterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SigningKeyLength -Specifies the signing key length. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SigningProviderName -Specifies the name of the signing device. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### bool, int, string, string, string, string, string, string, string, string, string, SecurePassword, int, string - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.NDES.NetworkDeviceEnrollmentServiceResult - -## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the -f switch to bypass the prompt for confirmation. -To see parameters, run the following command: install-AdcsNetworkDeviceEnrollmentService -? - - - -## RELATED LINKS - -[Uninstall-AdcsNetworkDeviceEnrollmentService](./Uninstall-AdcsNetworkDeviceEnrollmentService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcsonlineresponder.md b/docset/winserver2012-ps/adcsdeployment/install-adcsonlineresponder.md deleted file mode 100644 index d4b1e41cc9..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/install-adcsonlineresponder.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/install-adcsonlineresponder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdcsOnlineResponder - -## SYNOPSIS -Installs Online Responder service - -## SYNTAX - -``` -Install-AdcsOnlineResponder [-Force] [-Credential ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-AdcsOnlineResponder configures the Online Responder service, which provides Online Certificate Status Protocol (OSCP) services. -To remove the role service, use the Uninstall-AdcsOnlineResponder cmdlet. - -You can import the cmdlet by running the following commands from Windows PowerShell: -Import-Module ServerManager -Add-WindowsFeature Adcs-Online-Cert - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-AdcsOnlineResponder -``` - -Description - ------------ - -This command installs the Online Responder role service. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Install-AdcsOnlineResponder -force -``` - -Description - ------------ - -This command forces the installation of the Online Responder role service. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -You can install the Online Responder role service only on servers that are members of Active Directory Domain Services (AD DS) domains. -If you are installing an online responder configured to use a standalone certification authority (CA), then an account that is a member of the local Administrators group of the target server is required. -If you are installing an online responder to target an Enterprise CA, then an account that is a member of the Domain Admins group is required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSCredential - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.OCSP.OnlineResponderResult - -## NOTES -* Ensure you run Windows PowerShell® as an administrator. You can use the -force switch to bypass the prompt for confirmation. -To see parameters, run the following command: install-AdcsOnlineResponder -? - -## RELATED LINKS - -[Uninstall-AdcsOnlineResponder](./Uninstall-AdcsOnlineResponder.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/install-adcswebenrollment.md b/docset/winserver2012-ps/adcsdeployment/install-adcswebenrollment.md deleted file mode 100644 index ed45807435..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/install-adcswebenrollment.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/install-adcswebenrollment?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdcsWebEnrollment - -## SYNOPSIS -Installs Certification Authority Web Enrollment - -## SYNTAX - -``` -Install-AdcsWebEnrollment [-CAConfig ] [-Force] [-Credential ] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Install-AdcsWebEnrollment cmdlet performs initial installation and configuration of the Certification Authority Web Enrollment role service. -To remove the Web Enrollment role service use the Uninstall-AdcsWebEnrollment cmdlet. - -You can import the cmdlet by running the following commands from Windows PowerShell: -Import-Module ServerManager -Add-WindowsFeature Adcs-Web-Enrollment - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-AdcsWebEnrollment -CAConfig \ -``` - -Description - ------------ - -This command installs the Web Enrollment role service to a CA specified by \\\\. -Replace the computer name of the certification authority (CA) for \ and replace the CA common name for \ when running the command. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Install-AdcsWebEnrollment -CAConfig \ -force -``` - -Description - ------------ - -This command installs the Web Enrollment role service to a CA specified by \\\\ without requiring user confirmation. -Replace the computer name of the certification authority (CA) for \ and replace the CA common name for \ when running the command. - -## PARAMETERS - -### -CAConfig -CAConfig parameter string. -Do not specify this if there is a local CA installed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -If the Web Enrollment service is configured to use Standalone certification authority (CA), then an account that is a member of the local Administrators on the CA is required. -If the Web Enrollment service is configured to use an Enterprise CA, then an account that is a member of Domain Admins is required. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### PSCredential - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.WebEnrollment.WebEnrollmentResult - -## NOTES -* Ensure you run Windows PowerShell® as an administrator. You can use the -force switch to bypass the prompt for confirmation. -To see parameters, run the following command: install-AdcsWebEnrollment -? - -## RELATED LINKS - -[Uninstall-AdcsWebEnrollment](./Uninstall-AdcsWebEnrollment.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/uninstall-adcscertificationauthority.md b/docset/winserver2012-ps/adcsdeployment/uninstall-adcscertificationauthority.md deleted file mode 100644 index 38eb562143..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/uninstall-adcscertificationauthority.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/uninstall-adcscertificationauthority?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-AdcsCertificationAuthority - -## SYNOPSIS -Uninstalls the Certification Authority (CA) role service and removes its configuration information. - -## SYNTAX - -``` -Uninstall-AdcsCertificationAuthority [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-AdcsCertificationAuthority cmdlet removes the Active CA role and removes its configuration information. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-AdcsCertificationAuthority -force -``` - -Description - ------------ - -This command removes the Active Directory Certification Authority role service and does not prompt for user confirmation. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.CA.CertificationAuthoritySetupResult - -## NOTES -* To uninstall the CA role service, ensure you run PowerShell as an administrator. You can run the command with the -f switch to bypass the prompt for confirmation. - -## RELATED LINKS - -[Install-AdcsCertificationAuthority](./Install-AdcsCertificationAuthority.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsenrollmentpolicywebservice.md b/docset/winserver2012-ps/adcsdeployment/uninstall-adcsenrollmentpolicywebservice.md deleted file mode 100644 index 23aec82dfe..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsenrollmentpolicywebservice.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/uninstall-adcsenrollmentpolicywebservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-AdcsEnrollmentPolicyWebService - -## SYNOPSIS -Uninstalls the Certificate Enrollment Policy Web service. - -## SYNTAX - -### UninstallSingleInstance (Default) -``` -Uninstall-AdcsEnrollmentPolicyWebService -AuthenticationType [-KeyBasedRenewal] [-Force] - [-WhatIf] [-Confirm] [] -``` - -### UninstallAll -``` -Uninstall-AdcsEnrollmentPolicyWebService [-AllPolicyServers] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-AdcsEnrollmentPolicyWebService cmdlet uninstalls the Certificate Enrollment Policy Web Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-AdcsEnrollmentPolicyWebService -AllPolicyServers -force -``` - -Description - ------------ - -This command removes all configurations in the Certificate Enrollment Policy Web Service without prompting for confirmation. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Uninstall-AdcsEnrollmentPolicyWebService -AuthenticationType Certificate -KeyBasedRenewal -force -``` - -Description - ------------ - -This command removes the instance of Certificate Enrollment Policy Web Service that is utilizing certificate authentication and is in key-based renewal mode without prompting for confirmation. - -## PARAMETERS - -### -AllPolicyServers -Uninstall all instances of the Certificate Enrollment Policy (CEP) Web Service. - -```yaml -Type: SwitchParameter -Parameter Sets: UninstallAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the authentication type for the Certificate Enrollment Policy (CEP) Web Service instance to be uninstalled when multiple instances are present. - -```yaml -Type: AuthenticationType -Parameter Sets: UninstallSingleInstance -Aliases: -Accepted values: Kerberos, UserName, Certificate - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyBasedRenewal -Specifies the instance of the Certificate Enrollment Policy Web Service running in key-based renewal mode to be uninstalled. -This parameter is optional. -It is used to distinguish which instance of the Certificate Enrollment Policy Web Service is to be uninstalled if there are multiple instances that use the same authentication type. -If this option is not specified, the instance of the Certificate Enrollment Policy Web Service that is using the defined AuthenticationType that is not enabled for KeyBasedRenewal mode is uninstalled. - -```yaml -Type: SwitchParameter -Parameter Sets: UninstallSingleInstance -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### bool, enum, bool - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.CEP.EnrollmentPolicyServiceResult - -## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the -force switch to bypass the prompt for confirmation. - -## RELATED LINKS - -[Install-AdcsEnrollmentPolicyWebService](./Install-AdcsEnrollmentPolicyWebService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsenrollmentwebservice.md b/docset/winserver2012-ps/adcsdeployment/uninstall-adcsenrollmentwebservice.md deleted file mode 100644 index 5cd62e8553..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsenrollmentwebservice.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/uninstall-adcsenrollmentwebservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-AdcsEnrollmentWebService - -## SYNOPSIS -Uninstalls the Certificate Enrollment Web service or individual instances of it. - -## SYNTAX - -### UninstallSingleInstance (Default) -``` -Uninstall-AdcsEnrollmentWebService -CAConfig -AuthenticationType [-Force] - [-WhatIf] [-Confirm] [] -``` - -### UninstallAll -``` -Uninstall-AdcsEnrollmentWebService [-AllEnrollmentServices] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-AdcsEnrollmentWebService cmdlet uninstalls the Certificate Enrollment Web Service either entirely removing all instances of it or partially by removing individual instances. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-AdcsEnrollmentWebService -AllEnrollmentServices -force -``` - -Description - ------------ - -This command removes all the Web Enrollment role services without prompting for confirmation. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Uninstall-AdcsEnrollmentWebService -CAConfig APP1.corp.contoso.com\corp-APP1-CA -AuthenticationType Certificate -``` - -Description - ------------ - -This command removes the Certificate Enrollment Web Service using the CA specified by the configuration APP1.corp.contoso.com\corp-APP1-CA. -The CA configuration is the CA Computer Name and CA common name separated by a backslash. -The authentication type in use is Certificate. - -## PARAMETERS - -### -AllEnrollmentServices -Specifies the removal of Certificate Enrollment Web Service instances. - -```yaml -Type: SwitchParameter -Parameter Sets: UninstallAll -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the authentication type of the of enrollment services instance to be uninstalled. - -```yaml -Type: AuthenticationType -Parameter Sets: UninstallSingleInstance -Aliases: -Accepted values: Kerberos, UserName, Certificate - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CAConfig -Specifies the configuration string of the certification authority (CA) for which enrollment services will be uninstalled. -This parameter is used to identify which instance of the Certificate Enrollment Web Service is to be uninstalled when multiple are present. - -```yaml -Type: String -Parameter Sets: UninstallSingleInstance -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string,enum,bool - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.CES.EnrollmentServiceResult - -## NOTES -* The application directories are removed from their respective instance folders in the file system. The uninstall command does not remove the Secure Sockets Layer/Transport Layer Security (SSL/TLS) or the secure hypertext transfer protocol (https) bindings. - - - -## RELATED LINKS - -[Install-AdcsEnrollmentWebService](./Install-AdcsEnrollmentWebService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsnetworkdeviceenrollmentservice.md b/docset/winserver2012-ps/adcsdeployment/uninstall-adcsnetworkdeviceenrollmentservice.md deleted file mode 100644 index da6b58a37e..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsnetworkdeviceenrollmentservice.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/uninstall-adcsnetworkdeviceenrollmentservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-AdcsNetworkDeviceEnrollmentService - -## SYNOPSIS -Uninstalls the Network Device Enrollment service. - -## SYNTAX - -``` -Uninstall-AdcsNetworkDeviceEnrollmentService [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-AdcsNetworkDeviceEnrollmentService cmdlet removes the Network Device Enrollment Service (NDES) role service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-AdcsNetworkDeviceEnrollmentService -force -``` - -Description - ------------ - -Removes the NDES role service and does not prompt for user input. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.NDES.NetworkDeviceEnrollmentServiceResult - -## NOTES -* Ensure you run Windows PowerShell as an administrator. You can use the -force switch to bypass the prompt for confirmation. - - - -## RELATED LINKS - -[Install-AdcsNetworkDeviceEnrollmentService](./Install-AdcsNetworkDeviceEnrollmentService.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsonlineresponder.md b/docset/winserver2012-ps/adcsdeployment/uninstall-adcsonlineresponder.md deleted file mode 100644 index 45c4cee10f..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/uninstall-adcsonlineresponder.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/uninstall-adcsonlineresponder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-AdcsOnlineResponder - -## SYNOPSIS -Uninstalls the Online Responder service. - -## SYNTAX - -``` -Uninstall-AdcsOnlineResponder [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-AdcsOnlineResponder cmdlet removes the Online Responder role service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-AdcsOnlineResponder -force -``` - -Description - ------------ - -This command removes Online Responder role service without requiring confirmation. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.OCSP.OnlineResponderResult - -## NOTES -* Ensure you run Windows PowerShell® as an administrator. You can use the -force switch to bypass the prompt for confirmation. - - - -## RELATED LINKS - -[Install-AdcsOnlineResponder](./Install-AdcsOnlineResponder.md) - diff --git a/docset/winserver2012-ps/adcsdeployment/uninstall-adcswebenrollment.md b/docset/winserver2012-ps/adcsdeployment/uninstall-adcswebenrollment.md deleted file mode 100644 index e191e15609..0000000000 --- a/docset/winserver2012-ps/adcsdeployment/uninstall-adcswebenrollment.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.CertificateServices.Deployment.Commands.dll-Help.xml -Module Name: adcsdeployment -online version: https://learn.microsoft.com/powershell/module/adcsdeployment/uninstall-adcswebenrollment?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-AdcsWebEnrollment - -## SYNOPSIS -Uninstalls the Certification Authority (CA) Web Enrollment role service. - -## SYNTAX - -``` -Uninstall-AdcsWebEnrollment [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-AdcsWebEnrollment cmdlet removes the CA Web Enrollment role service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-AdcsWebEnrollment -force -``` - -Description - ------------ - -This command removes the CA Web Enrollment role service without requiring confirmation. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.CertificateServices.Deployment.Commands.WebEnrollment.WebEnrollmentResult - -## NOTES -* Ensure you run Windows PowerShell® as an administrator. You can use the -force switch to bypass the prompt for confirmation. - - - -## RELATED LINKS - -[Install-AdcsWebEnrollment](./Install-AdcsWebEnrollment.md) - diff --git a/docset/winserver2012-ps/addsdeployment/ADDSDeployment.md b/docset/winserver2012-ps/addsdeployment/ADDSDeployment.md deleted file mode 100644 index 86e37b7831..0000000000 --- a/docset/winserver2012-ps/addsdeployment/ADDSDeployment.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.2.0.0 -Locale: en-US -Module Guid: df736400-2e72-4a7b-8eda-d5b28421881f -Module Name: ADDSDeployment ---- - -# ADDSDeployment Module -## Description -The following contains the names and a brief description of each ADDSDeployment cmdlet. - -## ADDSDeployment Cmdlets -### [Add-ADDSReadOnlyDomainControllerAccount](./Add-ADDSReadOnlyDomainControllerAccount.md) -Creates a read-only domain controller (RODC) account that can be used to install an RODC in Active Directory. - -### [Install-ADDSDomain](./Install-ADDSDomain.md) -Installs a new Active Directory domain configuration. - -### [Install-ADDSDomainController](./Install-ADDSDomainController.md) -Installs a domain controller in Active Directory. - -### [Install-ADDSForest](./Install-ADDSForest.md) -Installs a new Active Directory forest configuration. - -### [Test-ADDSDomainControllerInstallation](./Test-ADDSDomainControllerInstallation.md) -Runs the prerequisites (only) for installing a domain controller in Active Directory. - -### [Test-ADDSDomainControllerUninstallation](./Test-ADDSDomainControllerUninstallation.md) -Runs the prerequisites (only) for uninstalling a domain controller in Active Directory. - -### [Test-ADDSDomainInstallation](./Test-ADDSDomainInstallation.md) -Runs the prerequisites (only) for installing a new Active Directory domain configuration. - -### [Test-ADDSForestInstallation](./Test-ADDSForestInstallation.md) -Runs the prerequisites (only) for installing a new forest in Active Directory. - -### [Test-ADDSReadOnlyDomainControllerAccountCreation](./Test-ADDSReadOnlyDomainControllerAccountCreation.md) -Runs the prerequisites (only) for adding a read-only domain controller (RODC) account. - -### [Uninstall-ADDSDomainController](./Uninstall-ADDSDomainController.md) -Uninstalls a domain controller in Active Directory. - diff --git a/docset/winserver2012-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md b/docset/winserver2012-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md deleted file mode 100644 index 4f591756c9..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Add-ADDSReadOnlyDomainControllerAccount.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/add-addsreadonlydomaincontrolleraccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADDSReadOnlyDomainControllerAccount - -## SYNOPSIS -Creates a read-only domain controller (RODC) account that can be used to install an RODC in Active Directory. - -## SYNTAX - -``` -Add-ADDSReadOnlyDomainControllerAccount [-SkipPreChecks] -DomainControllerAccountName - -DomainName -SiteName [-AllowPasswordReplicationAccountName ] - [-Credential ] [-DelegatedAdministratorAccountName ] - [-DenyPasswordReplicationAccountName ] [-NoGlobalCatalog] [-InstallDns] - [-ReplicationSourceDC ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-ADDSReadOnlyDomainControllerAccount cmdlet creates a read-only domain controller (RODC) account that can be used to install an RODC in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADDSReadOnlyDomainControllerAccount -DomainControllerAccountName RODC1 -DomainName corp.contoso.com -SiteName NorthAmerica -``` - -Description - ------------ - -Adds a new read-only domain controller (RODC) account to the corp.contoso.com domain using the North America site as the source site for the replication source domain controller. - -## PARAMETERS - -### -AllowPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use "None" if you want to keep the value empty. -By default, only the Allowed RODC Password Replication Group is allowed, and it is originally created empty. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify "(get-credential)" when using this parameter to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegatedAdministratorAccountName -Specifies the name of the user or group that will install and administer the RODC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use "None" if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainControllerAccountName -Specifies the name of the RODC account that you are creating. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the domain name for the user name (account credentials) for the operation. -This parameter is required. -It also helps to specify the forest where you plan to install the domain controller or create an RODC account. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces completion of the cmdlet even if issues are found in the process of creating the RODC account. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed. -If no value is provided, the default behavior is to automatically compute DNS configuration behavior based upon the existing environment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoGlobalCatalog -Specifies that the read-only domain controller (RODC) will not be a global catalog server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSourceDC -Specifies the name of the domain controller to be used as the source for replicating to this RODC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of an existing site where you can place the new domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPreChecks -Specifies that only a base set of validations will be performed when this cmdlet is executed. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a domain controller. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section "Prerequisite Checking" in the Understand and Troubleshoot AD DS Simplified Administration in Windows Server 2012 guide located at http://go.microsoft.com/fwlink/?LinkID=237244. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -* Once you have added the RODC account, you can add an RODC to a server computer by using the **Install-ADDSDomainController** cmdlet with the **-ReadOnlyReplica** switch parameter. -* You can also delegate the ability to attach the server to a non-administrative group or user. If you are deploying RODCs in delegated administration scenarios where the machine accounts are pre-provisioned, creating the RODC account is the first stage of the RODC installation process and needs to be done by a member of the Domain Admins group. In these scenarios, once an administrator uses this cmdlet to add the RODC account in Active Directory Domain Services (AD DS), the second stage of the installation can occur. This involves attaching an actual server computer in a remote location (such as a branch office) that will operate as the RODC for the specified account created using this cmdlet. - -## RELATED LINKS - -[Install-ADDSDomainController](./Install-ADDSDomainController.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Install-ADDSDomain.md b/docset/winserver2012-ps/addsdeployment/Install-ADDSDomain.md deleted file mode 100644 index 18ea2beafd..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Install-ADDSDomain.md +++ /dev/null @@ -1,491 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/install-addsdomain?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-ADDSDomain - -## SYNOPSIS -Installs a new Active Directory domain configuration. - -## SYNTAX - -``` -Install-ADDSDomain [-SkipPreChecks] -NewDomainName -ParentDomainName - [-SafeModeAdministratorPassword ] [-ADPrepCredential ] [-AllowDomainReinstall] - [-CreateDnsDelegation] [-Credential ] [-DatabasePath ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-DomainMode ] - [-DomainType ] [-NoGlobalCatalog] [-InstallDns] [-LogPath ] - [-NewDomainNetbiosName ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SiteName ] - [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-ADDSDomain cmdlet installs a new Active Directory domain configuration. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-ADDSDomain -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName corp.contoso.com -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC DC1.corp.contoso.com -SiteName Houston -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion -``` - -Description - ------------ - -Installs a new child domain named child.corp.contoso.com using credentials of CORP\EnterpriseAdmin1. -This example also installs a DNS server, creates a DNS delegation in the corp.contoso.com domain, sets the domain functional level to Windows Server 2003, makes the domain controller a global catalog server in a site named Houston, uses DC1.corp.contoso.com as the replication source domain controller, installs the Active Directory database and SYSVOL on the D:\ drive, installs the log files on the E:\ drive, has the server not automatically restart after the domain installation is complete and causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password to complete and commit the installation of the domain in Active Directory. - -## PARAMETERS - -### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running operations (if they are required) to prepare Active Directory prior to the installation of this domain. -Specify "`(Get-Credential)`" to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDomainReinstall -If this parameter is included, it specifies that an existing domain is to be recreated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify "`(Get-Credential)`" to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for example, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationCredential -Specifies the user name and password (account credentials) for the user creating DNS delegation. -This parameter is skipped if the value for the **-CreateDnsDelegation** parameter is either specified or computed to be $false. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainMode -Specifies the domain functional level during creation of a new domain. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or "Win2008R2". -Other supported values include those for Windows Server 2003 (2, Win2003) Windows Server 2008 (3, Win2008) and Windows Server 2012 (5, Win8). -The domain functional level cannot be lower than the forest functional level, but it can be higher. -The default is Windows Server 2012 (5, Win8). - -```yaml -Type: DomainMode -Parameter Sets: (All) -Aliases: -Accepted values: Win2003, Win2008, Win2008R2, Win2012, Default - -Required: False -Position: Named -Default value: Windows2008R2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainType -Indicates the type of domain that you want to create: a new domain tree in an existing forest (supported values are "TreeDomain" or "tree"), a child of an existing domain (supported values are "ChildDomain" or "child"). -The default is ChildDomain. - -```yaml -Type: DomainType -Parameter Sets: (All) -Aliases: -Accepted values: ChildDomain, TreeDomain - -Required: False -Position: Named -Default value: ChildDomain -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the installation of the domain will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting installation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed and configured for the domain or domain tree. -For domain installation, if this parameter is left unspecified and the parent domain (or in the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the domain, then the default for this parameter is $true and the DNS server will be installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server will be installed. - -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query to ask the question "Does a zone exist for the domain name?" For example, if the value of **-NewDomainName** is "corp.contoso.com", Active Directory performs an SOA query for "corp.contoso.com" and ensures that the zone name in the response is " corp.contoso.com". - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that contains the domain log files, for example, C:\Windows\Logs. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDomainName -If the value set for **-DomainType** is set to "TreeDomain", this parameter can be used to specify the fully qualified domain name (FQDN) for the new domain tree (for example, "contoso.com"). -If the value set for **-DomainType** is set to "ChildDomain", this parameter can be used to specify a single label domain name for the child domain (for example, specify "corp" to make a new domain "corp.contoso.com" if the new domain is in the contoso.com domain tree). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDomainNetbiosName -Specifies the NetBIOS name for the new domain. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. - -If this parameter is set with a valid NetBIOS name value, then promotion continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the **-NewDomainName** parameter. - -For example, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the **-NewDomainName** parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label "corp" within a full domain name value of "corp.contoso.com" would be a successful name choice. - -Note that if the name value given for this parameter (or if it is omitted, the value of the single-label prefix domain name within the **-NewDomainName** parameter) is a name of 16 characters or more, then the domain installation fails. -For example, if a value of "CORPORATEHEADQTRS" were specified for this parameter (or if this parameter is omitted and the value of **-NewDomainName** were set to be "corporateheadqtrs.contoso.com") then the domain installation will fail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDnsOnNetwork -Specifies that DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server will be installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. - -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer will be used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoGlobalCatalog -Specifies that the read-only domain controller (RODC) will not be a global catalog server. -By default, the domain controller that you are installing is a global catalog server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -Specifies whether to restart the computer upon completion, regardless of success. -(By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted.) As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentDomainName -Specifies the fully qualified domain name (FQDN) of an existing parent domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSourceDC -Specifies the fully qualified domain name (FQDN) of the domain controller to be used as the source for replicating to this domain. -The default value for this parameter is automatically computed from the environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAutoConfigureDns -Skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPreChecks -Specifies that only a base set of validations will be performed. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a new domain. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section "Prerequisite Checking" in the Understand and Troubleshoot AD DS Simplified Administration in Windows Server 2012 guide (http://go.microsoft.com/fwlink/?LinkID=237244). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer, for example, C:\Windows\SYSVOL. -The default is %SYSTEMROOT%\SYSVOL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -* When a new domain tree is created in an existing forest, a two-way, transitive tree root trust is established by default. - -## RELATED LINKS - -[Install-ADDSDomainController](./Install-ADDSDomainController.md) - -[Install-ADDSForest](./Install-ADDSForest.md) - -[Install-ADDSDomain](./Install-ADDSDomain.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Install-ADDSDomainController.md b/docset/winserver2012-ps/addsdeployment/Install-ADDSDomainController.md deleted file mode 100644 index a6efa934a5..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Install-ADDSDomainController.md +++ /dev/null @@ -1,633 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/install-addsdomaincontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-ADDSDomainController - -## SYNOPSIS -Installs a domain controller in Active Directory. - -## SYNTAX - -### ADDSDomainController (Default) -``` -Install-ADDSDomainController [-SkipPreChecks] -DomainName - [-SafeModeAdministratorPassword ] [-SiteName ] [-ADPrepCredential ] - [-AllowDomainControllerReinstall] [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] - [-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-NoGlobalCatalog] - [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] [-ReplicationSourceDC ] - [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -### ADDSDomainControllerReadOnly -``` -Install-ADDSDomainController [-SkipPreChecks] -DomainName - [-SafeModeAdministratorPassword ] -SiteName [-ADPrepCredential ] - [-AllowDomainControllerReinstall] [-AllowPasswordReplicationAccountName ] - [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] [-Credential ] - [-CriticalReplicationOnly] [-DatabasePath ] [-DelegatedAdministratorAccountName ] - [-DenyPasswordReplicationAccountName ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] - [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] [-NoRebootOnCompletion] - [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] - [-Force] [-WhatIf] [-Confirm] [] -``` - -### ADDSDomainControllerUseExistingAccount -``` -Install-ADDSDomainController [-SkipPreChecks] -DomainName - [-SafeModeAdministratorPassword ] [-ADPrepCredential ] - [-ApplicationPartitionsToReplicate ] [-Credential ] [-CriticalReplicationOnly] - [-DatabasePath ] [-NoDnsOnNetwork] [-InstallationMediaPath ] [-LogPath ] - [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] - [-SysvolPath ] [-UseExistingAccount] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-ADDSDomainController cmdlet installs a domain controller in Active Directory. - -## EXAMPLES - -### Example 1: Install a domain controller and DNS server -```powershell -PS C:\> Install-ADDSDomainController -InstallDns -DomainName "corp.contoso.com" -``` - -This command installs a domain controller and DNS server in the corp.contoso.com domain using CORP\Administrator credentials and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) password. - -### Example 2: Install a domain controller and DNS server using administrator credentials -```powershell -PS C:\> Install-ADDSDomainController -InstallDns -Credential (Get-Credential "CORP\Administrator") -DomainName "corp.contoso.com" -``` - -This command installs a domain controller and DNS server in the corp.contoso.com domain using Administrator credentials and prompts the user to provide and confirm the DSRM password. - -### Example 3: Install a domain controller and DNS server that uses domain promotion -```powershell -PS C:\> Install-ADDSDomainController -InstallDns -Credential (Get-Credential) -DomainName (Read-Host "Domain to promote into") -``` - -Installs a domain controller and DNS server and prompts for credentials, the name of the domain to use when installing and promoting the domain controller and to provide and confirm the DSRM password. - -## PARAMETERS - -### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running the Adprep utility, if it is required, to prepare the directory prior to the installation of this domain controller. -Use the **Get-Credential** cmdlet to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDomainControllerReinstall -Specifies whether to continue installing this domain controller, despite the fact that another domain controller account with the same name is detected. -By default, the **Install-ADDSDomainController** cmdlet does not continue installing if another domain controller with the same name is found. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use an empty string ("") if you want to keep the value empty. -By default, only the Allowed RODC Password Replication Group is allowed. - -```yaml -Type: String[] -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPartitionsToReplicate -Specifies the application directory partitions that DCPromo will replicate. -Use the following format: "partition1" "partition2" "partitionN". -Use * to replicate all application directory partitions. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -If this parameter is specified then the DNS delegation is created. -If the value of $false is specified then no DNS delegation is created. -By default, the value for this parameter is computed automatically based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify **Get-Credential** to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CriticalReplicationOnly -Specifies whether the AD DS installation operation performs only critical replication before reboot and then continues, skipping the noncritical (and potentially lengthy) portion of replication. -The noncritical replication happens after the installation finishes and the computer reboots. -By default, the cmdlet performs both critical and noncritical portions of the replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that will contain the domain database, for example, `C:\Windows\NTDS`. -The default is `%SYSTEMROOT%\NTDS`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegatedAdministratorAccountName -Specifies the name of the user or group that will be the delegated administrator of this domain controller. - -```yaml -Type: String -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use an empty string ("") if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. - -```yaml -Type: String[] -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationCredential -Specifies the user name and password (account credentials) for creating DNS delegation. -This parameter is skipped if the value for the **CreateDnsDelegation** parameter is either specified or computed to be $false. - -```yaml -Type: PSCredential -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the fully qualified domain name (FQDN) for the domain where the domain controller will be installed or added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Indicates the cmdlet installs and configures the DNS Server service on the domain controller. -For domain controller installation, if this parameter is left unspecified and the current domain already hosts and stores the DNS names for the domain, then the default for this parameter is $True and the DNS server is installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is `$False` and no DNS server is installed. - -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query. -For instance, if the value of **DomainName** is corp.contoso.com, Active Directory performs an SOA query for corp.contoso.com and ensures that the zone name in the response is corp.contoso.com. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallationMediaPath -Indicates the location of the installation media that will be used to install a new domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for example, `C:\Windows\Logs`. -The default is `%SYSTEMROOT%\NTDS`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveInfrastructureOperationMasterRoleIfNecessary -Use this parameter to transfer the infrastructure master role to the domain controller being installed. -To successfully complete the transfer, the **NoGlobalCatalog** switch parameter must be included as well. -Do not specify this parameter if you want the infrastructure master role to remain where it currently is. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDnsOnNetwork -Specifies that DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server will be installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. - -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer will be used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoGlobalCatalog -Indicates that the RODC will not be a global catalog server. -By default, the domain controller that you are installing is a global catalog server. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -If specified, the computer will not restart upon the completion of the operation to install the domain controller. -By default, if this parameter is omitted the computer will restart upon the completion of the install operation. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadOnlyReplica -Specifies whether to install the domain controller as an RODC for an existing domain. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSourceDC -Specifies the name of the domain controller to be used as the source for replicating to this domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -If no value is specified for this parameter, the cmdlet prompts you to enter and confirm a masked password. -If specified with a value, the value must be a secure string. - -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value depends on the type of installation. -For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. - -```yaml -Type: String -Parameter Sets: ADDSDomainController -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAutoConfigureDns -Skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPreChecks -Specifies that only a base set of validations will be performed. -This behavior is equivalent to the validations that were performed when using `Dcpromo.exe` in earlier versions of Windows Server to add a new domain controller. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section "ADPrep and Prerequisite Checking Architecture" in the [AD DS Simplified Administration](https://go.microsoft.com/fwlink/?LinkID=237244). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemKey -Specifies the system key for the media from which you replicate the data. -The default is none. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the Sysvol data, for example, `C:\Windows\SYSVOL`. -The default is `%SYSTEMROOT%\SYSVOL`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseExistingAccount -Attaches a server to an existing RODC account. -If specified, a member of the Domain Admins group or a delegated user can run this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUseExistingAccount -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -* By default, this cmdlet always prompts for confirmation. To bypass confirmation, you need to include the **-Confirm** parameter and specify a value of `$false`. For example, `-Confirm:$false`. -* By default, this cmdlet is always run when executed. To see what will happen if the cmdlet runs without executing or committing installation changes, first run the cmdlet using the **-WhatIf** parameter to show what would happen. - -## RELATED LINKS - -[Add-ADDSReadOnlyDomainControllerAccount](./Add-ADDSReadOnlyDomainControllerAccount.md) - -[Install-ADDSDomain](./Install-ADDSDomain.md) - -[Install-ADDSForest](./Install-ADDSForest.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Install-ADDSForest.md b/docset/winserver2012-ps/addsdeployment/Install-ADDSForest.md deleted file mode 100644 index 7f3e7d42af..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Install-ADDSForest.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/install-addsforest?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-ADDSForest - -## SYNOPSIS -Installs a new Active Directory forest configuration. - -## SYNTAX - -``` -Install-ADDSForest [-SkipPreChecks] -DomainName [-SafeModeAdministratorPassword ] - [-CreateDnsDelegation] [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] - [-DomainMode ] [-DomainNetbiosName ] [-ForestMode ] [-InstallDns] - [-LogPath ] [-NoRebootOnCompletion] [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Install-ADDSForest cmdlet installs a new Active Directory forest configuration. - -## EXAMPLES - -### EXAMPLE 1 -``` -C:\PS>Install-ADDSForest -DomainName "corp.contoso.com" -InstallDNS -``` - -Description - ------------ - -Installs a new forest named corp.contoso.com, causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password and specifies a DNS server should also be installed during the forest installation process. - -### EXAMPLE 2 -``` -C:\PS>Install-ADDSForest -DomainName corp.contoso.com -CreateDNSDelegation -DomainMode Win2008 -ForestMode Win2008R2 -DatabasePath "d:\NTDS" -SysvolPath "d:\SYSVOL" -LogPath "e:\Logs" -``` - -Description - ------------ - -Installs a new forest named corp.contoso.com, creates a DNS delegation in the contoso.com domain, sets domain functional level to Windows Server 2008 R2 and sets forest functional level to Windows Server 2008, installs the Active Directory database and SYSVOL on the D:\ drive, installs the log files on the E:\ drive and has the server automatically restart after AD DS installation is complete and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) password. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for example, C:\Databases\NTDS. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationCredential -Specifies the user name and password (account credentials) for creating DNS delegation. -This parameter is skipped if the value for the **-CreateDnsDelegation** parameter is either specified or computed to be $false. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of **4** or **Win2008R2**. -Other supported values include those for Windows Server 2003 (**2** or **Win2003**) Windows Server 2008 (**3** or **Win2008**) and Window Server 2012 (**5**, **Win2012**). -The domain functional level cannot be lower than the forest functional level, but it can be higher. -The default is automatically computed and set. - -```yaml -Type: DomainMode -Parameter Sets: (All) -Aliases: -Accepted values: Win2003, Win2008, Win2008R2, Win2012, Default - -Required: False -Position: Named -Default value: Windows2008R2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the fully qualified domain name (FQDN) for the root (first) domain in the forest. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNetbiosName -Specifies the NetBIOS name for the root domain in the new forest. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. - -If this parameter is set with a valid NetBIOS name value, then forest installation continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the **-DomainName** parameter. - -For example, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the **-DomainName** parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label "corp" within a full domain name value of "corp.contoso.com" would be a successful name choice. - -Note that if the name value given for this parameter (or if it is omitted, the value of the single-label prefix domain name within the **-DomainName** parameter) is a name of 16 characters or more, then the forest installation fails. -For example, if a value of "CORPORATEHEADQTRS" were specified for this parameter (or if this parameter is omitted and the value of **-DomainName** were set to be "corporateheadqtrs.contoso.com") then the forest installation will fail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the installation of the new forest will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting installation of new forests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForestMode -Specifies the forest functional level for the new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the forest mode level to Windows Server 2008 R2, you can specify either a value of **4** or **Win2008R2**. -Other supported values include those for Windows Server 2003 (**2** or **Win2003**) Windows Server 2008 (**3** or **Win2008**) and Windows Server 2012 (**5** or **Win8**). -The default forest functional level in Windows Server 2012 when you create a new forest is Windows Server 2012 (**5**). -The default forest functional level in Windows Server 2008 R2 when you create a new forest is Windows Server 2003 (**2**). - -```yaml -Type: ForestMode -Parameter Sets: (All) -Aliases: -Accepted values: Win2003, Win2008, Win2008R2, Win2012, Default - -Required: False -Position: Named -Default value: Windows2008R2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed and configured for the new forest. -For forest installation, the default is $true (a new DNS server will be installed and configured). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the log file for this operation will be written. -For example, C:\Logs. -The default log file path if no other path is specified with this parameter is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDnsOnNetwork -Specifies that DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server will be installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. - -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer will be used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -Specifies that the computer is not to be rebooted upon completion of this command. -Omitting this parameter (the default) indicates the computer will be rebooted upon completion of the command, regardless of success or failure. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAutoConfigureDns -Skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPreChecks -Specifies that only a base set of validations will be performed. -This behavior is equivalent to the validations that were performed when using Dcpromo.exe in earlier versions of Windows Server to add a new forest. -When this switch parameter is set, it specifies that additional preliminary checks should be bypassed. -For more information on the scope of these additional preliminary checks that the ADDSDeployment module performs by default when using Windows Server 2012, refer to the table in the section "Prerequisite Checking" in the Understand and Troubleshoot AD DS Simplified Administration in Windows Server 2012 guide (http://go.microsoft.com/fwlink/?LinkID=237244). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the Sysvol file will be written. -For example, C:\Logs\SYSVOL. -The default path if no other path is specified with this parameter is %SYSTEMROOT%\SYSVOL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -* By default, the DNS Server service is installed when you create a new forest. It is strongly recommended that you install and use the Windows DNS Server to support the needs for DNS name resolution in your Active Directory deployment. You do not need to specifically include the **-InstallDNS** to install it. - - If you are using Active Directory-integrated DNS, the IP address for the preferred DNS server for the first domain controller in the forest is automatically set to the loopback address of 127.0.0.1. -This helps assure that the IP address of the first domain controller will be resolved in DNS even if the address is changed. - -## RELATED LINKS - -[Install-ADDSDomain](./Install-ADDSDomain.md) - -[Test-ADDSForestInstallation](./Test-ADDSForestInstallation.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md b/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md deleted file mode 100644 index 8340cb7140..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainControllerInstallation.md +++ /dev/null @@ -1,595 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/test-addsdomaincontrollerinstallation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ADDSDomainControllerInstallation - -## SYNOPSIS -Runs the prerequisites (only) for installing a domain controller in Active Directory. - -## SYNTAX - -### ADDSDomainController (Default) -``` -Test-ADDSDomainControllerInstallation -DomainName [-SafeModeAdministratorPassword ] - [-SiteName ] [-ADPrepCredential ] [-AllowDomainControllerReinstall] - [-ApplicationPartitionsToReplicate ] [-CreateDnsDelegation] [-Credential ] - [-CriticalReplicationOnly] [-DatabasePath ] [-DnsDelegationCredential ] - [-NoDnsOnNetwork] [-NoGlobalCatalog] [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-NoRebootOnCompletion] [-ReplicationSourceDC ] - [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] [-Force] [] -``` - -### ADDSDomainControllerReadOnly -``` -Test-ADDSDomainControllerInstallation -DomainName [-SafeModeAdministratorPassword ] - -SiteName [-ADPrepCredential ] [-AllowDomainControllerReinstall] - [-AllowPasswordReplicationAccountName ] [-ApplicationPartitionsToReplicate ] - [-CreateDnsDelegation] [-Credential ] [-CriticalReplicationOnly] [-DatabasePath ] - [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-NoGlobalCatalog] - [-InstallationMediaPath ] [-InstallDns] [-LogPath ] - [-MoveInfrastructureOperationMasterRoleIfNecessary] [-ReadOnlyReplica] [-NoRebootOnCompletion] - [-ReplicationSourceDC ] [-SkipAutoConfigureDns] [-SystemKey ] [-SysvolPath ] - [-Force] [] -``` - -### ADDSDomainControllerUseExistingAccount -``` -Test-ADDSDomainControllerInstallation -DomainName [-SafeModeAdministratorPassword ] - [-ADPrepCredential ] [-ApplicationPartitionsToReplicate ] [-Credential ] - [-CriticalReplicationOnly] [-DatabasePath ] [-NoDnsOnNetwork] [-InstallationMediaPath ] - [-LogPath ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SkipAutoConfigureDns] - [-SystemKey ] [-SysvolPath ] [-UseExistingAccount] [-Force] [] -``` - -## DESCRIPTION -The Test-ADDSDomainControllerInstallation cmdlet runs those prerequisite checks (only) which would be performed if you were to use the Install-ADDSDomainController cmdlet to install a domain controller in Active Directory. -It differs from using the **-WhatIf** parameter with the Install-ADDSDomainController cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. - -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section "Prerequisite Checking" in Understand and Troubleshoot AD DS Simplified Administrationhttp://go.microsoft.com/fwlink/?LinkID=237244. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Test-ADDSDomainControllerInstallation -InstallDns -Credential (Get-Credential CORP\Administrator) -DomainName "corp.contoso.com" -``` - -Description - ------------ - -Runs the prerequisites (only) to determine if installing a domain controller is possible that includes a DNS server for the corp.contoso.com domain (using domain administrator credentials) and that will cause the user to be prompted to enter and confirm the Directory Services Restore Mode (DSRM) password. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Test-ADDSDomainControllerInstallation -InstallDns -DomainName "corp.contoso.com " -``` - -Description - ------------ - -Runs the prerequisites (only) to determine if installing a domain controller along with the DNS server in the corp.contoso.com domain and that will cause the user to be prompted to enter and confirm the Directory Services Restore Mode (DSRM) password. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Test-ADDSDomainControllerInstallation -InstallDns -Credential (Get-Credential) -DomainName (Read-Host "Domain to promote into") -``` - -Description - ------------ - -Runs the prerequisites (only) to determine if installing a domain controller along with a DNS server and that will cause the user to be prompted for Administrator credentials as well as whether the domain name is possible and if the user is prompted to enter and confirm the Directory Services Restore Mode (DSRM) password. - -## PARAMETERS - -### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running operations (if they are required) to prepare Active Directory prior to the installation of this domain. -Specify "`(Get-Credential)`" to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDomainControllerReinstall -Specifies whether to continue installing this domain controller, despite the fact that another domain controller account with the same name is detected. -By default, the Install-ADDSDomainController cmdlet does not continue installing if another domain controller with the same name is found. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use an empty string ("") if you want to keep the value empty. -By default, only the Allowed RODC Password Replication Group is allowed. - -```yaml -Type: String[] -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationPartitionsToReplicate -Specifies the application directory partitions that DCPromo will replicate. -Use the following format: "partition1" "partition2" "partitionN". -Use * to replicate all application directory partitions. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -If this parameter is specified then the DNS delegation is created. -If the value of $false is specified then no DNS delegation is created. -By default, the value for this parameter is computed automatically based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify "`(Get-Credential)`" to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CriticalReplicationOnly -Specifies whether the AD DS installation operation performs only critical replication before reboot and then continues, skipping the noncritical (and potentially lengthy) portion of replication. -The noncritical replication happens after the installation finishes and the computer reboots. -By default, the cmdlet performs both critical and noncritical portions of the replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that will contain the domain database, for example, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegatedAdministratorAccountName -Specifies the name of the user or group that will be the delegated administrator of this domain controller. - -```yaml -Type: String -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use an empty string ("") if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. - -```yaml -Type: String[] -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationCredential -Specifies the user name and password (account credentials) for creating DNS delegation. -This parameter is skipped if the value for the **-CreateDnsDelegation** parameter is either specified or computed to be $false. - -```yaml -Type: PSCredential -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the fully qualified domain name (FQDN) for the domain where the domain controller will be installed or added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the installation and addition of the domain controller will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting installation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed and configured on the domain controller. -For domain controller installation, if this parameter is left unspecified and the current domain already hosts and stores the DNS names for the domain, then the default for this parameter is $true and the DNS server will be installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server will be installed. - -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query to ask the question "Does a zone exist for the domain name?" For example, if the value of **-DomainName** is "corp.contoso.com", Active Directory performs an SOA query for "corp.contoso.com" and ensures that the zone name in the response is " corp.contoso.com". - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallationMediaPath -Indicates the location of the installation media that will be used to install a new domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for example, C:\Windows\Logs. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveInfrastructureOperationMasterRoleIfNecessary -Use this parameter to transfer the infrastructure master role to the domain controller that you are creating in case the transfer is needed; in this case, make sure not to use the **-NoGlobalCatalog** switch parameter as well. -Do not specify this parameter if you want the infrastructure master role to remain where it currently is. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDnsOnNetwork -Specifies that DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server will be installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. - -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer will be used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoGlobalCatalog -Specifies that the read-only domain controller (RODC) will not be a global catalog server. -By default, the domain controller that you are installing is a global catalog server. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainController, ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -If specified, the computer will not restart upon the completion of the operation to install the domain controller. -By default, if this parameter is omitted the computer will restart upon the completion of the install operation. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadOnlyReplica -Specifies whether to install the domain controller as an RODC for an existing domain. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSourceDC -Specifies the name of the domain controller to be used as the source for replicating to this domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -If no value is specified for this parameter, the cmdlet prompts you to enter and confirm a masked password. -If specified with a value, the value must be a secure string. - -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value depends on the type of installation. -For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. - -```yaml -Type: String -Parameter Sets: ADDSDomainController -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ADDSDomainControllerReadOnly -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAutoConfigureDns -Skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemKey -Specifies the system key for the media from which you replicate the data. -The default is none. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the Sysvol data, for example, C:\Windows\SYSVOL. -The default is %SYSTEMROOT%\SYSVOL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseExistingAccount -Attaches a server to an existing RODC account. -If specified, a member of the Domain Admins group or a delegated user can run this cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUseExistingAccount -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - -[Test-ADDSReadOnlyDomainControllerAccountCreation](./Test-ADDSReadOnlyDomainControllerAccountCreation.md) - -[Test-ADDSDomainInstallation](./Test-ADDSDomainInstallation.md) - -[Test-ADDSForestInstallation](./Test-ADDSForestInstallation.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md b/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md deleted file mode 100644 index 032f424040..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainControllerUninstallation.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/test-addsdomaincontrolleruninstallation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ADDSDomainControllerUninstallation - -## SYNOPSIS -Runs the prerequisites (only) for uninstalling a domain controller in Active Directory. - -## SYNTAX - -### ADDSDomainControllerUninstall (Default) -``` -Test-ADDSDomainControllerUninstallation [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-DnsDelegationRemovalCredential ] - [-IgnoreLastDCInDomainMismatch] [-IgnoreLastDnsServerForZone] [-LastDomainControllerInDomain] - [-NoRebootOnCompletion] [-RemoveApplicationPartitions] [-RemoveDnsDelegation] [-RetainDCMetadata] [-Force] - [] -``` - -### ADDSDomainControllerUninstallForceRemoval -``` -Test-ADDSDomainControllerUninstallation [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-ForceRemoval] [-NoRebootOnCompletion] [-Force] - [] -``` - -## DESCRIPTION -The Test-ADDSDomainControllerUninstallation cmdlet runs those prerequisite checks (only) which would be performed if you were to use the Uninstall-ADDSDomainController cmdlet to uninstall a domain controller in Active Directory. -It differs from using the **-WhatIf** parameter with the Uninstall-ADDSDomainController cmdlet in that instead of summarizing the changes that would occur during the uninstallation process, this cmdlet actually tests whether those changes are possible given the current environment. - -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section "Prerequisite Checking" in Understand and Troubleshoot AD DS Simplified Administrationhttp://go.microsoft.com/fwlink/?LinkID=237244. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Test-ADDSDomainControllerUninstallation -``` - -Description - ------------ - -Runs the prerequisites (only) to determine if uninstalling an additional domain controller in a domain is possible and in such a way that it will prompt the user to set and confirm the local Administrator password prior to completing the uninstallation process. - -## PARAMETERS - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -To prompt the user to supply a password, use Runs the prerequisites (only) to determine if installing a domain controller is possible that includes a DNS server for the corp.contoso.com domain (using domain administrator credentials) and that prompts the user to correctly specify the Directory Services Restore Mode (DSRM) password."`(Get-Credential)`" in place of an existing *PSCredential* type. -This causes Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DemoteOperationMasterRole -Indicates that (forced) demotion should continue even if an operations master role is discovered on domain controller from which AD DS is being removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationRemovalCredential -Specifies the account credentials (user name and password) to use when you create or remove the DNS delegation. -If you do not specify a value, then the account credentials that you specify for the AD DS installation or removal are used to for the DNS delegation. -As an alternative, you can prompt the user to supply a password. -To do so, use "`(Get-Credential)`" in place of an existing *PSCredential* type. -This causes Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. - -```yaml -Type: PSCredential -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the uninstallation and removal of the domain controller will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting uninstallation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRemoval -Forces the removal of a domain controller. -Use this parameter to force the uninstall of AD DS if you need to remove the domain controller and do not have connectivity to other domain controllers within the domain topology. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstallForceRemoval -Aliases: - -Required: True -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLastDCInDomainMismatch -Used in conjunction with **-LastDomainControllerInDomain**. -This parameter specifies whether the Windows PowerShell ignores any inconsistency that it detects with the value that you specify for **-LastDomainControllerInDomain**. -For example, if you specify **-LastDomainControllerInDomain** but Windows PowerShell detects that there is actually another active domain controller in the domain, you can specify **-IgnoreLastDCInDomainMismatch** to have Windows PowerShell continue the removal of AD DS from the domain controller despite the inconsistency that it has detected. -Similarly, if you do not specify **-LastDomainControllerInDomain** but Windows PowerShell cannot detect that another domain controller is in the domain, you can specify **-IgnoreLastDCInDomainMismatch** to have Windows PowerShell continue to remove AD DS from the domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLastDnsServerForZone -Specifies whether to continue the removal of AD DS despite the fact that the domain controller is the last DNS server for one or more of the Active Directory-integrated DNS zones that it hosts. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastDomainControllerInDomain -Specifies whether the computer from which AD DS is being removed is the last domain controller in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalAdministratorPassword -Specifies a local administrator account password when AD DS is removed from a domain controller. -In earlier releases, where uninstall of AD DS was done using Dcpromo.exe for demotion, the default was to allow an empty password for this setting. -In Windows PowerShell, the ADDS Deployment module requires that a non-empty password string value be assigned. -If a value is not provided for this parameter, you will be prompted to enter a value for the password at the Windows PowerShell prompt. -The password value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -Specifies whether to not restart the computer upon completion, regardless of success. -(By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted.) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveApplicationPartitions -Specifies whether to remove application partitions during the removal of AD DS from a domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDnsDelegation -Specifies whether to preserve DNS delegations that point to this DNS server from the parent DNS zone. - -By default, this parameter is set to FALSE, which means DNS delegations that point to this server from the parent DNS zone will not be retained after uninstallation of the domain controller. -This setting corresponds to the earlier Dcpromo.exe parameter default of /RemoveDNSDelegation:Yes. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDCMetadata -If this parameter is used it indicates that the domain controller should retain metadata for the domain after removal of AD DS from it. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Uninstall-ADDSDomainController](./Uninstall-ADDSDomainController.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainInstallation.md b/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainInstallation.md deleted file mode 100644 index 063dd270ab..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Test-ADDSDomainInstallation.md +++ /dev/null @@ -1,440 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/test-addsdomaininstallation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ADDSDomainInstallation - -## SYNOPSIS -Runs the prerequisites (only) for installing a new Active Directory domain configuration. - -## SYNTAX - -``` -Test-ADDSDomainInstallation -NewDomainName -ParentDomainName - [-SafeModeAdministratorPassword ] [-ADPrepCredential ] [-AllowDomainReinstall] - [-CreateDnsDelegation] [-Credential ] [-DatabasePath ] - [-DnsDelegationCredential ] [-NoDnsOnNetwork] [-DomainMode ] - [-DomainType ] [-NoGlobalCatalog] [-InstallDns] [-LogPath ] - [-NewDomainNetbiosName ] [-NoRebootOnCompletion] [-ReplicationSourceDC ] [-SiteName ] - [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] [] -``` - -## DESCRIPTION -The Test-ADDSDomainInstallation cmdlet runs those prerequisite checks (only) which would be performed if you were to use the Install-ADDSDomain cmdlet to install a new Active Directory domain configuration. -It differs from using the **-WhatIf** parameter with the Install-ADDSDomain cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. - -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section "Prerequisite Checking" in Understand and Troubleshoot AD DS Simplified Administrationhttp://go.microsoft.com/fwlink/?LinkID=237244. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Test-ADDSDomainInstallation -Credential (Get-Credential CORP\EnterpriseAdmin1) -NewDomainName child -ParentDomainName corp.contoso.com -InstallDNS -CreateDNSDelegation -DomainMode Win2003 -ReplicationSourceDC DC1.corp.contoso.com -SiteName Houston -DatabasePath "D:\NTDS" -SYSVOLPath "D:\SYSVOL" -LogPath "E:\Logs" -NoRebootOnCompletion -``` - -Description - ------------ - -Runs the prerequisites (only) to determine if installing a new child domain named child.corp.contoso.com using credentials of CORP\EnterpriseAdmin1 is possible. -This example also installs a DNS server, creates a DNS delegation in the corp.contoso.com domain, sets the domain functional level to Windows Server 2003, makes the domain controller a global catalog server in a site named Houston, uses DC1.corp.contoso.com as the replication source domain controller, installs the Active Directory database and SYSVOL on the D:\ drive, installs the log files on the E:\ drive, has the server not automatically restart after the domain installation is complete and causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password to complete and commit the installation of the domain in Active Directory. - -## PARAMETERS - -### -ADPrepCredential -Specifies the user name and password that corresponds to the account to be used for running operations (if they are required) to prepare Active Directory prior to the installation of this domain. -Specify "`(Get-Credential)`" to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowDomainReinstall -If this parameter is included, it specifies that an existing domain is to be recreated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify "`(Get-Credential)`" to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePath -Specifies the fully qualified, non?Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for example, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationCredential -Specifies the user name and password (account credentials) for the user creating DNS delegation. -This parameter is skipped if the value for the **-CreateDnsDelegation** parameter is either specified or computed to be $false. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainMode -Specifies the domain functional level during creation of a new domain. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or "Win2008R2". -Other supported values include those for Windows Server 2003 (2, Win2003) Windows Server 2008 (3, Win2008) and Windows Server 2012 (5, Win8). -The domain functional level cannot be lower than the forest functional level, but it can be higher. -The default is Windows Server 2012 (5, Win8). - -```yaml -Type: DomainMode -Parameter Sets: (All) -Aliases: -Accepted values: Win2003, Win2008, Win2008R2, Win2012, Default - -Required: False -Position: Named -Default value: Windows2008R2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainType -Indicates the type of domain that you want to create: a new domain tree in an existing forest (supported values are "TreeDomain" or "tree"), a child of an existing domain (supported values are "ChildDomain" or "child"). -The default is ChildDomain. - -```yaml -Type: DomainType -Parameter Sets: (All) -Aliases: -Accepted values: ChildDomain, TreeDomain - -Required: False -Position: Named -Default value: ChildDomain -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the installation of the domain will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting installation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed and configured for the domain or domain tree. -For domain installation, if this parameter is left unspecified and the parent domain (or in the case of a domain tree, the forest root domain) already hosts and stores the DNS names for the domain, then the default for this parameter is $true and the DNS server will be installed. -Otherwise, if DNS domain names are hosted outside of Active Directory, the default is $false and no DNS server will be installed. - -To test if DNS domain names are hosted outside of Active Directory, this cmdlet uses a start of authority (SOA) type DNS query to ask the question "Does a zone exist for the domain name?" For example, if the value of **-NewDomainName** is "corp.contoso.com", Active Directory performs an SOA query for "corp.contoso.com" and ensures that the zone name in the response is " corp.contoso.com". - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that will contain the domain log files, for example, C:\Windows\Logs. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDomainName -If the value set for **-DomainType** is set to "TreeDomain", this parameter can be used to specify the fully qualified domain name (FQDN) for the new domain tree (for example, "contoso.com"). -If the value set for **-DomainType** is set to "ChildDomain", this parameter can be used to specify a single label domain name for the child domain (for example, specify "corp" to make a new domain "corp.contoso.com" if the new domain is in the contoso.com domain tree). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDomainNetbiosName -Specifies the NetBIOS name for the new domain. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. - -If this parameter is set with a valid NetBIOS name value, then promotion continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the **-NewDomainName** parameter. - -For example, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the **-NewDomainName** parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label "corp" within a full domain name value of "corp.contoso.com" would be a successful name choice. - -Note that if the name value given for this parameter (or if it is omitted, the value of the single-label prefix domain name within the **-NewDomainName** parameter) is a name of 16 characters or more, then the domain installation fails. -For example, if a value of "CORPORATEHEADQTRS" were specified for this parameter (or if this parameter is omitted and the value of **-NewDomainName** were set to be "corporateheadqtrs.contoso.com") then the domain installation will fail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDnsOnNetwork -Specifies that DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server will be installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. - -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer will be used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoGlobalCatalog -Specifies that the read-only domain controller (RODC) will not be a global catalog server. -By default, the domain controller that you are installing is a global catalog server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -Specifies whether to restart the computer upon completion, regardless of success. -(By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted.) As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentDomainName -Specifies the fully qualified domain name (FQDN) of an existing parent domain. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSourceDC -Specifies the fully qualified domain name (FQDN) of the domain controller to be used as the source for replicating to this domain. -The default value for this parameter is automatically computed from the environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAutoConfigureDns -Skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer, for example, C:\Windows\SYSVOL. -The default is %SYSTEMROOT%\SYSVOL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Install-ADDSDomain](./Install-ADDSDomain.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Test-ADDSForestInstallation.md b/docset/winserver2012-ps/addsdeployment/Test-ADDSForestInstallation.md deleted file mode 100644 index 3281c044ac..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Test-ADDSForestInstallation.md +++ /dev/null @@ -1,344 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/test-addsforestinstallation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ADDSForestInstallation - -## SYNOPSIS -Runs the prerequisites (only) for installing a new forest in Active Directory. - -## SYNTAX - -``` -Test-ADDSForestInstallation -DomainName [-SafeModeAdministratorPassword ] - [-CreateDnsDelegation] [-DatabasePath ] [-DnsDelegationCredential ] [-NoDnsOnNetwork] - [-DomainMode ] [-DomainNetbiosName ] [-ForestMode ] [-InstallDns] - [-LogPath ] [-NoRebootOnCompletion] [-SkipAutoConfigureDns] [-SysvolPath ] [-Force] - [] -``` - -## DESCRIPTION -The Test-ADDSForestInstallation cmdlet runs those prerequisite checks (only) which would be performed if you were to use the Install-ADDSForest cmdlet to install a new forest in Active Directory. -It differs from using the **-WhatIf** parameter with the Install-ADDSForest cmdlet in that instead of summarizing the changes that would occur during the installation process, this cmdlet actually tests whether those changes are possible given the current environment. - -For more information on the scope of these prerequisite checks that the ADDSDeployment module performs when using this cmdlet see the section "Prerequisite Checking" in Understand and Troubleshoot AD DS Simplified Administrationhttp://go.microsoft.com/fwlink/?LinkID=237244. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Test-ADDSForestInstallation -DomainName "corp.contoso.com" -NoRebootOnCompletion -``` - -Description - ------------ - -Runs the prerequisites (only) for installing a new forest named corp.contoso.com that causes the user to be prompted to provide and confirm the Directory Services Restore Mode (DSRM) password and specifies not to reboot after the new forest is created. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Test-ADDSForestInstallation -DomainName corp.contoso.com -CreateDNSDelegation -DomainMode Win2008 -ForestMode Win2008R2 -DatabasePath "D:\NTDS" -SysvolPath "D:\SYSVOL" -LogPath "E:\Logs" -``` - -Description - ------------ - -Runs the prerequisites (only) for installing a new forest that will create a DNS delegation in the contoso.com domain, set the domain functional level to Windows Server 2008 R2 and sets forest functional level to Windows Server 2008 R2, install the Active Directory database and SYSVOL on the D:\ drive, install the log files on the E:\ drive and has the server automatically restart after AD DS installation is complete and prompts the user to provide and confirm the Directory Services Restore Mode (DSRM) password. - -## PARAMETERS - -### -CreateDnsDelegation -Indicates whether to create a DNS delegation that references the new DNS server that you are installing along with the domain controller. -Valid for Active Directory-integrated DNS only. -The default is computed automatically based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DatabasePath -Specifies the fully qualified, non-Universal Naming Convention (UNC) path to a directory on a fixed disk of the local computer that contains the domain database, for example, C:\Windows\NTDS. -The default is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationCredential -Specifies the user name and password (account credentials) for creating DNS delegation. -This parameter is skipped if the value for the **-CreateDnsDelegation** parameter is either specified or computed to be $false. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainMode -Specifies the domain functional level of the first domain in the creation of a new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the domain mode level to Windows Server 2008 R2, you can specify either a value of 4 or "Win2008R2". -Other supported values include those for Windows Server 2003 (2, Win2003) Windows Server 2008 (3, Win2008) and Windows Server 2012 (5, Win8). -The domain functional level cannot be lower than the forest functional level, but it can be higher. -The default is automatically computed and set. - -```yaml -Type: DomainMode -Parameter Sets: (All) -Aliases: -Accepted values: Win2003, Win2008, Win2008R2, Win2012, Default - -Required: False -Position: Named -Default value: Windows2008R2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the fully qualified domain name (FQDN) for the root (first) domain in the forest. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainNetbiosName -Specifies the NetBIOS name for the root domain in the new forest. -For NetBIOS names to be valid for use with this parameter they must be single label names of 15 characters or less. - -If this parameter is set with a valid NetBIOS name value, then forest installation continues with the name specified. -If this parameter is not set, then the default is automatically computed from the value of the **-DomainName** parameter. - -For example, if this parameter is not specified and a single-label prefix domain name of 15 characters or less is specified within the value of the **-DomainName** parameter, then promotion continues with an automatically generated NetBIOS domain name. -For example, the prefix label "corp" within a full domain name value of "corp.contoso.com" would be a successful name choice. - -Note that if the name value given for this parameter (or if it is omitted, the value of the single-label prefix domain name within the **-DomainName** parameter) is a name of 16 characters or more, then the forest installation fails. -For example, if a value of "CORPORATEHEADQTRS" were specified for this parameter (or if this parameter is omitted and the value of **-DomainName** were set to be "corporateheadqtrs.contoso.com") then the forest installation will fail. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the installation of the new forest will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting installation of new forests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForestMode -Specifies the forest functional level for the new forest. -Supported values for this parameter can be either a valid integer or a corresponding enumerated string value. -For example, to set the forest mode level to Windows Server 2008 R2, you can specify either a value of 4 or "Win2008R2". -Other supported values include those for Windows Server 2003 (2, Win2003) Windows Server 2008 (3, Win2008) and Windows Server 2012 (5, Win8). -The default forest functional level in Windows Server 2012 when you create a new forest is Windows Server 2012 (5). -The default forest functional level in Windows Server 2008 R2 when you create a new forest is Windows Server 2003 (2). - -```yaml -Type: ForestMode -Parameter Sets: (All) -Aliases: -Accepted values: Win2003, Win2008, Win2008R2, Win2012, Default - -Required: False -Position: Named -Default value: Windows2008R2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed and configured for the new forest. -For forest installation, the default is $true (a new DNS server will be installed and configured). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the log file for this operation will be written. -For example, C:\Logs. -The default log file path if no other path is specified with this parameter is %SYSTEMROOT%\NTDS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDnsOnNetwork -Specifies that DNS service is not available on the network. -This parameter is used only when the IP setting of the network adapter for this computer is not configured with the name of a DNS server for name resolution. -It indicates that a DNS server will be installed on this computer for name resolution. -Otherwise, the IP settings of the network adapter must first be configured with the address of a DNS server. - -Omitting this parameter (the default) indicates that the TCP/IP client settings of the network adapter on this server computer will be used to contact a DNS server. -Therefore, if you are not specifying this parameter, ensure that TCP/IP client settings are first configured with a preferred DNS server address. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -Specifying this parameter indicates that the computer should not be rebooted upon completion of the command. -Omitting this parameter (the default) indicates the computer will be rebooted upon completion of the command, regardless of success or failure. -As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SafeModeAdministratorPassword -Supplies the password for the administrator account when the computer is started in Safe Mode or a variant of Safe Mode, such as Directory Services Restore Mode. -You must supply a password that meets the password complexity rules of the domain and the password cannot be blank. -If specified with a value, the value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipAutoConfigureDns -Skips automatic configuration of DNS client settings, forwarders, and root hints. -This parameter is in effect only if the DNS Server service is already installed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SysvolPath -Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer where the Sysvol file will be written. -For example, C:\Logs\SYSVOL. -The default path if no other path is specified with this parameter is %SYSTEMROOT%\SYSVOL. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Install-ADDSForest](./Install-ADDSForest.md) - -[Test-ADDSDomainInstallation](./Test-ADDSDomainInstallation.md) - -[Test-ADDSDomainControllerInstallation](./Test-ADDSDomainControllerInstallation.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md b/docset/winserver2012-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md deleted file mode 100644 index d0c3a670c9..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Test-ADDSReadOnlyDomainControllerAccountCreation.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/test-addsreadonlydomaincontrolleraccountcreation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ADDSReadOnlyDomainControllerAccountCreation - -## SYNOPSIS -Runs the prerequisites (only) for adding a read-only domain controller (RODC) account. - -## SYNTAX - -``` -Test-ADDSReadOnlyDomainControllerAccountCreation -DomainControllerAccountName -DomainName - -SiteName [-AllowPasswordReplicationAccountName ] [-Credential ] - [-DelegatedAdministratorAccountName ] [-DenyPasswordReplicationAccountName ] - [-NoGlobalCatalog] [-InstallDns] [-ReplicationSourceDC ] [-Force] [] -``` - -## DESCRIPTION -The Test-ADDSReadOnlyDomainControllerAccountCreation cmdlet runs the prerequisite checks (only) which would be performed if you were to add a read-only domain controller (RODC) account in Active Directory using the Add-ADDSReadOnlyDomainControllerAccount cmdlet. -It differs from using the **-WhatIf** parameter with the Add-ADDSReadOnlyDomainControllerAccount cmdlet in that instead of summarizing the changes that would occur during the account creation process, this cmdlet actually tests whether those changes are possible given the current environment. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Test-ADDSReadOnlyDomainControllerAccountCreation -DomainControllerAccountName RODC1 -DomainName corp.contoso.com -SiteName NorthAmerica -``` - -Description - ------------ - -Runs the prerequisites (only) for adding an RODC account to the corp.contoso.com domain that would use the North America site as the source site for the replication source domain controller. - -## PARAMETERS - -### -AllowPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords can be replicated to this RODC. -Use "None" if you want to keep the value empty. -By default, only the Allowed RODC Password Replication Group is allowed, and it is originally created empty. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -Specify "`(Get-Credential)`" when using this parameter to prompt the user to supply a password. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegatedAdministratorAccountName -Specifies the name of the user or group that will install and administer the RODC. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenyPasswordReplicationAccountName -Specifies the names of user accounts, group accounts, and computer accounts whose passwords are not to be replicated to this RODC. -Use "None" if you do not want to deny the replication of credentials of any users or computers. -By default, Administrators, Server Operators, Backup Operators, Account Operators, and the Denied RODC Password Replication Group are denied. -By default, the Denied RODC Password Replication Group includes Cert Publishers, Domain Admins, Enterprise Admins, Enterprise Domain Controllers, Enterprise Read-Only Domain Controllers, Group Policy Creator Owners, the krbtgt account, and Schema Admins. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainControllerAccountName -Specifies the name of the RODC account that you are creating. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the domain name for the user name (account credentials) for the operation. -This parameter is required. -It also helps to specify the forest where you plan to install the domain controller or create an RODC account. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces completion of the cmdlet even if issues are found in the process of creating the RODC account. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InstallDns -Specifies whether the DNS Server service should be installed. -The default is automatically computed based on the environment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoGlobalCatalog -Specifies that the read-only domain controller (RODC) will not be a global catalog server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationSourceDC -Specifies the name of the fully writable domain controller to use in creating the RODC account in Active Directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SiteName -Specifies the name of an existing site where you can place the new domain controller. -The default value depends on the type of installation. -For a new forest, the default is Default-First-Site-Name. -For all other installations, the default is the site that is associated with the subnet that includes the IP address of this server. -If no such site exists, the default is the site of the replication source domain controller. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-ADDSReadOnlyDomainControllerAccount](./Add-ADDSReadOnlyDomainControllerAccount.md) - diff --git a/docset/winserver2012-ps/addsdeployment/Uninstall-ADDSDomainController.md b/docset/winserver2012-ps/addsdeployment/Uninstall-ADDSDomainController.md deleted file mode 100644 index c304754834..0000000000 --- a/docset/winserver2012-ps/addsdeployment/Uninstall-ADDSDomainController.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.DirectoryServices.Deployment.dll-Help.xml -Module Name: ADDSDeployment -online version: https://learn.microsoft.com/powershell/module/addsdeployment/uninstall-addsdomaincontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-ADDSDomainController - -## SYNOPSIS -Uninstalls a domain controller in Active Directory. - -## SYNTAX - -### ADDSDomainControllerUninstall (Default) -``` -Uninstall-ADDSDomainController [-SkipPreChecks] [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-DnsDelegationRemovalCredential ] - [-IgnoreLastDCInDomainMismatch] [-IgnoreLastDnsServerForZone] [-LastDomainControllerInDomain] - [-NoRebootOnCompletion] [-RemoveApplicationPartitions] [-RemoveDnsDelegation] [-RetainDCMetadata] [-Force] - [-WhatIf] [-Confirm] [] -``` - -### ADDSDomainControllerUninstallForceRemoval -``` -Uninstall-ADDSDomainController [-SkipPreChecks] [-LocalAdministratorPassword ] - [-Credential ] [-DemoteOperationMasterRole] [-ForceRemoval] [-NoRebootOnCompletion] [-Force] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-ADDSDomainController cmdlet uninstalls a domain controller in Active Directory. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-ADDSDomainController -``` - -Description - ------------ - -Removes AD DS from an additional domain controller in a domain and causes the user to be prompted to set and confirm the local Administrator password prior to completing the removal process. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the user name and password that corresponds to the account used to install the domain controller. -To prompt the user to supply a password, use "`(Get-Credential)`" in place of an existing *PSCredential* type. -This causes Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DemoteOperationMasterRole -Indicates that (forced) demotion should continue even if an operations master role is discovered on domain controller from which AD DS is being removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDelegationRemovalCredential -Specifies the account credentials (user name and password) to use when you create or remove the DNS delegation. -If you do not specify a value, then the account credentials that you specify for the AD DS installation or removal are used to for the DNS delegation. -As an alternative, you can prompt the user to supply a password. -To do so, use "`(Get-Credential)`" in place of an existing *PSCredential* type. -This causes Windows PowerShell to prompt the user to enter credentials using the Windows security login UI. - -```yaml -Type: PSCredential -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When this parameter is specified any warnings that might normally appear during the uninstallation and removal of the domain controller will be suppressed to allow the cmdlet to complete its operation. -This parameter can be useful to include when scripting uninstallation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRemoval -Forces the removal of a domain controller. -Use this parameter to force the uninstall of AD DS if you need to remove the domain controller and do not have connectivity to other domain controllers within the domain topology. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstallForceRemoval -Aliases: - -Required: True -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLastDCInDomainMismatch -Used in conjunction with **-LastDomainControllerInDomain**. -This parameter specifies whether the Windows PowerShell ignores any inconsistency that it detects with the value that you specify for **-LastDomainControllerInDomain**. -For example, if you specify **-LastDomainControllerInDomain** but Windows PowerShell detects that there is actually another active domain controller in the domain, you can specify **-IgnoreLastDCInDomainMismatch** to have Windows PowerShell continue the removal of AD DS from the domain controller despite the inconsistency that it has detected. -Similarly, if you do not specify **-LastDomainControllerInDomain** but Windows PowerShell cannot detect that another domain controller is in the domain, you can specify **-IgnoreLastDCInDomainMismatch** to have Windows PowerShell continue to remove AD DS from the domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLastDnsServerForZone -Specifies whether to continue the removal of AD DS despite the fact that the domain controller is the last DNS server for one or more of the Active Directory?integrated DNS zones that it hosts. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LastDomainControllerInDomain -Specifies whether the computer from which AD DS is being removed is the last domain controller in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalAdministratorPassword -Specifies a local administrator account password when AD DS is removed from a domain controller. -In earlier releases, where uninstall of AD DS was done using Dcpromo.exe for demotion, the default was to allow an empty password for this setting. -In Windows PowerShell, the ADDS Deployment module requires that a non-empty password string value be assigned. -If a value is not provided for this parameter, you will be prompted to enter a value for the password at the Windows PowerShell prompt. -The password value must be a secure string. - -If this parameter is not specified, the cmdlet prompts you to enter and confirm a masked password. -This is the preferred usage when running the cmdlet interactively. -If additionally there are no other arguments specified with the cmdlet, you will be prompted to enter a masked password for this parameter but no confirmation of the password entered will be made (which is not recommended as it could allow a mistyped password to be configured). -Another available advanced option is to use the **ConvertTo-SecureString** cmdlet and specify the password string inline as unmasked console input, which is also not a recommended security best practice in production deployments. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRebootOnCompletion -Specifies whether to not restart the computer upon completion, regardless of success. -(By default, reboot upon completion occurs when this cmdlet is used and this parameter is omitted.) As a general rule, Microsoft support recommends that you not use this parameter except for testing or troubleshooting purposes because once configuration has completed the server will not function correctly as either a member server or a DC until it is rebooted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveApplicationPartitions -Specifies whether to remove application partitions during the removal of AD DS from a domain controller. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveDnsDelegation -Specifies whether to preserve DNS delegations that point to this DNS server from the parent DNS zone. - -By default, this parameter is set to FALSE, which means DNS delegations that point to this server from the parent DNS zone will not be retained after uninstallation of the domain controller. -This setting corresponds to the earlier Dcpromo.exe parameter default of /RemoveDNSDelegation:Yes. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: NULL -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainDCMetadata -If this parameter is used it indicates that metadata from the domain controller should be preserved after uninstallation is completed. - -```yaml -Type: SwitchParameter -Parameter Sets: ADDSDomainControllerUninstall -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipPreChecks -{{Fill SkipPreChecks Description}} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Install-ADDSDomainController](./Install-ADDSDomainController.md) - diff --git a/docset/winserver2012-ps/adfs/ADFS.md b/docset/winserver2012-ps/adfs/ADFS.md deleted file mode 100644 index ac2b7bc96e..0000000000 --- a/docset/winserver2012-ps/adfs/ADFS.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 5c958595-c68c-4c00-a468-9763de83bbee -Module Name: ADFS ---- - -# ADFS Module -## Description -This reference provides command-line reference documentation for the IT professional of the Windows PowerShell cmdlets that you can use to deploy and administer Active Directory Federation Services (AD FS) in Windows Server. -## ADFS Cmdlets -### [Add-ADFSAttributeStore](./Add-ADFSAttributeStore.md) -Adds an attribute store to the Federation Service. - -### [Add-ADFSCertificate](./Add-ADFSCertificate.md) -Adds a new certificate to the Federation Service for signing, decrypting, or securing communications. - -### [Add-ADFSClaimDescription](./Add-ADFSClaimDescription.md) -Adds a claim description to the Federation Service. - -### [Add-ADFSClaimsProviderTrust](./Add-ADFSClaimsProviderTrust.md) -Adds a new claims provider trust to the Federation Service. - -### [Add-AdfsFarmNode](./Add-AdfsFarmNode.md) -Adds this computer to an existing federation server farm. - -### [Add-AdfsProxy](./Add-AdfsProxy.md) -Configures this computer as a federation server proxy. - -### [Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) -Adds a new relying party trust to the Federation Service. - -### [Disable-ADFSClaimsProviderTrust](./Disable-ADFSClaimsProviderTrust.md) -Disables a claims provider trust in the Federation Service. - -### [Disable-ADFSEndpoint](./Disable-ADFSEndpoint.md) -Disables an endpoint of the Federation Service. - -### [Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) -Disables a relying party trust of the Federation Service. - -### [Enable-ADFSClaimsProviderTrust](./Enable-ADFSClaimsProviderTrust.md) -Enables a claims provider trust in the Federation Service. - -### [Enable-ADFSEndpoint](./Enable-ADFSEndpoint.md) -Enables an endpoint in the Federation Service. - -### [Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) -Enables a relying party trust of the Federation Service. - -### [Export-AdfsDeploymentSQLScript](./Export-AdfsDeploymentSQLScript.md) -Generates the SQL scripts that can be used separately to create the AD FS database and to grant permissions. - -### [Get-ADFSAttributeStore](./Get-ADFSAttributeStore.md) -Gets the attribute stores of the Federation Service. - -### [Get-ADFSCertificate](./Get-ADFSCertificate.md) -Gets the certificates that are in the Federation Service. - -### [Get-ADFSClaimDescription](./Get-ADFSClaimDescription.md) -Gets claim descriptions that are in the Federation Service. - -### [Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) -Gets the claims provider trusts in the Federation Service. - -### [Get-ADFSConfiguration](./Get-ADFSConfiguration.md) -Gets the configuration properties of the Federation Service. - -### [Get-ADFSEndpoint](./Get-ADFSEndpoint.md) -Gets the endpoints in the Federation Service. - -### [Get-ADFSProxyConfiguration](./Get-ADFSProxyConfiguration.md) -Gets the configuration properties of the federation server proxy. - -### [Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) -Gets the relying party trusts of the Federation Service. - -### [Get-ADFSSyncConfiguration](./Get-ADFSSyncConfiguration.md) -Gets the configuration database synchronization properties of the Federation Service. - -### [Install-AdfsFarm](./Install-AdfsFarm.md) -Creates the first node of a new federation server farm. - -### [Install-AdfsStandalone](./Install-AdfsStandalone.md) -Sets up this computer as a stand-alone federation server for evaluation purposes or for a small lab environment. - -### [New-ADFSClaimRuleSet](./New-ADFSClaimRuleSet.md) -Creates a new set of claim rules. - -### [New-ADFSContactPerson](./New-ADFSContactPerson.md) -Creates a new contact person object. - -### [New-ADFSOrganization](./New-ADFSOrganization.md) -Creates a new organization information object. - -### [New-ADFSSamlEndpoint](./New-ADFSSamlEndpoint.md) -Creates a new SAML protocol endpoint object. - -### [Remove-ADFSAttributeStore](./Remove-ADFSAttributeStore.md) -Removes an attribute store from the Federation Service. - -### [Remove-ADFSCertificate](./Remove-ADFSCertificate.md) -Removes a certificate from the Federation Service. - -### [Remove-ADFSClaimDescription](./Remove-ADFSClaimDescription.md) -Removes a claim description from the Federation Service. - -### [Remove-ADFSClaimsProviderTrust](./Remove-ADFSClaimsProviderTrust.md) -Removes a claims provider trust from the Federation Service. - -### [Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) -Removes a relying party trust from the Federation Service. - -### [Revoke-ADFSProxyTrust](./Revoke-ADFSProxyTrust.md) -Revokes trust for all federation server proxies configured for the Federation Service. - -### [Set-ADFSAttributeStore](./Set-ADFSAttributeStore.md) -Sets the properties of the attribute store. - -### [Set-ADFSCertificate](./Set-ADFSCertificate.md) -Sets the properties of an existing certificate that the Federation Service uses to sign, decrypt, or secure communications. - -### [Set-ADFSClaimDescription](./Set-ADFSClaimDescription.md) -Sets the properties of an existing claim description. - -### [Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) -Sets the properties of a claims provider trust. - -### [Set-ADFSConfiguration](./Set-ADFSConfiguration.md) -Sets the configuration properties of the Federation Service. - -### [Set-ADFSEndpoint](./Set-ADFSEndpoint.md) -Sets the properties of a Federation Service endpoint. - -### [Set-ADFSProxyConfiguration](./Set-ADFSProxyConfiguration.md) -Sets the configuration properties of the federation server proxy. - -### [Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) -Sets the properties of a relying party trust. - -### [Set-ADFSSyncConfiguration](./Set-ADFSSyncConfiguration.md) -Sets the configuration properties of the database synchronization engine for the federation server farm. - -### [Update-ADFSCertificate](./Update-ADFSCertificate.md) -Updates the certificates of the Federation Service. - -### [Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) -Updates the claims provider trust from federation metadata. - -### [Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) -Updates the relying party trust from federation metadata. - diff --git a/docset/winserver2012-ps/adfs/Add-ADFSAttributeStore.md b/docset/winserver2012-ps/adfs/Add-ADFSAttributeStore.md deleted file mode 100644 index fcf65ccd84..0000000000 --- a/docset/winserver2012-ps/adfs/Add-ADFSAttributeStore.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfsattributestore?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADFSAttributeStore - -## SYNOPSIS -Adds an attribute store to the Federation Service. - -## SYNTAX - -### Predefined -``` -Add-ADFSAttributeStore -Name -StoreType -Configuration [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### Custom -``` -Add-ADFSAttributeStore -Name -TypeQualifiedName -Configuration [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-ADFSAttributeStore cmdlet adds an attribute store to the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADFSAttributeStore -name 'LocalSqlStore' -StoreType 'SQL' -Configuration @{"name" = "SQL Attribute Store"; "Connection" = "Server=CONTOSOSRV01;Database=UserAttributes;Integrated Security=True;Async=True"} -``` - -Description - ------------ - -Adds a SQL-based attribute store named LocalSqlStore. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Add-ADFSAttributeStore -Name 'MyCustomStore' -TypeQualifiedName 'Contoso.CustomTypes.MyAttributeStore, Contoso.CustomTypes' -Configuration @{"Name" = "Custom Attribute Store"; "Connection" = "Default"} -``` - -Description - ------------ - -Adds a custom attribute store named MyCustomStore. - -## PARAMETERS - -### -Configuration -Specifies the initialization parameters of the attribute store, such as a connection string. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this attribute store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoreType -Specifies the type of attribute store to add. -Valid values are ActiveDirectory, LDAP, and SQL. - -```yaml -Type: String -Parameter Sets: Predefined -Aliases: -Accepted values: ActiveDirectory, LDAP, SQL - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TypeQualifiedName -Specifies the class reference for a custom attribute store that is implemented in a .NET Assembly. - -```yaml -Type: String -Parameter Sets: Custom -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* An Active Directory Federation Services (AD FS) 2.0 attribute store is a pluggable module that the policy process for AD FS 2.0 can query to retrieve claim values. You can use either an Active Directory database or a Microsoft SQL Server database as your attribute store, or you can implement your own custom attribute store. - -## RELATED LINKS - -[Get-ADFSAttributeStore](./Get-ADFSAttributeStore.md) - -[Remove-ADFSAttributeStore](./Remove-ADFSAttributeStore.md) - -[Set-ADFSAttributeStore](./Set-ADFSAttributeStore.md) - diff --git a/docset/winserver2012-ps/adfs/Add-ADFSCertificate.md b/docset/winserver2012-ps/adfs/Add-ADFSCertificate.md deleted file mode 100644 index f7dc27ee3d..0000000000 --- a/docset/winserver2012-ps/adfs/Add-ADFSCertificate.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfscertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADFSCertificate - -## SYNOPSIS -Adds a new certificate to the Federation Service for signing, decrypting, or securing communications. - -## SYNTAX - -``` -Add-ADFSCertificate -CertificateType -Thumbprint [-IsPrimary] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Add-AdfsCertificate** cmdlet adds a new certificate to Active Directory Federation Services (AD FS) for token signing, token decrypting, card signing, or securing communications. - -## EXAMPLES - -### Example 1: Add a token-signing certificate -```powershell -PS C:\> Add-AdfsCertificate -CertificateType "Token-Signing" -Thumbprint ‎"fedd995b45e633d4ef30fcbc8f3a48b627e9a28b" -``` - -This command adds a token-signing certificate with the thumbprint `fedd995b45e633d4ef30fcbc8f3a48b627e9a28b`. - -## PARAMETERS - -### -CertificateType -Specifies the type and purpose of the certificate. -The acceptable values for this parameter are: - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Token-Decrypting, Token-Signing - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPrimary -Specifies whether the certificate is primary or not. -Primary token-signing certificates are used to digitally sign outgoing claims. -Primary token-encrypting certificates are published in federation metadata for use by trusted claims providers. -Service communications certificates are always primary certificates. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate to use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* Active Directory Federation Services (AD FS) 2.0 uses certificates for issuing and receiving tokens, publishing federation metadata and communicating through Secure Sockets Layer (SSL). - -## RELATED LINKS - -[Remove-ADFSCertificate](./Remove-ADFSCertificate.md) - -[Update-ADFSCertificate](./Update-ADFSCertificate.md) - diff --git a/docset/winserver2012-ps/adfs/Add-ADFSClaimDescription.md b/docset/winserver2012-ps/adfs/Add-ADFSClaimDescription.md deleted file mode 100644 index aa6a66636a..0000000000 --- a/docset/winserver2012-ps/adfs/Add-ADFSClaimDescription.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfsclaimdescription?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADFSClaimDescription - -## SYNOPSIS -Adds a claim description to the Federation Service. - -## SYNTAX - -``` -Add-ADFSClaimDescription -Name -ClaimType [-IsAccepted ] [-IsOffered ] - [-IsRequired ] [-Notes ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-ADFSClaimDescription cmdlet adds a claim description to the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADFSClaimDescription -name "Role" -ClaimType "https://fabrikam.com/role" -``` - -Description - ------------ - -Adds a new claim description for a custom Role claim. - -## PARAMETERS - -### -ClaimType -Specifies the claim type URN or URI of the claim. -All claim descriptions must include a valid URN or URI. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAccepted -Specifies that the claim should be published in federation metadata as a claim that the Federation Service accepts. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsOffered -Specifies that the claim should be published in federation metadata as a claim that the Federation Service offers. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsRequired -Specifies that the claim should be published in federation metadata as a claim that the Federation Service requires. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this claim. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies any notes for this claim description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* You can use claim descriptions to configure the list of claims that are available to be offered or accepted by AD FS 2.0. - -## RELATED LINKS - -[Get-ADFSClaimDescription](./Get-ADFSClaimDescription.md) - -[Remove-ADFSClaimDescription](./Remove-ADFSClaimDescription.md) - -[Set-ADFSClaimDescription](./Set-ADFSClaimDescription.md) - diff --git a/docset/winserver2012-ps/adfs/Add-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Add-ADFSClaimsProviderTrust.md deleted file mode 100644 index 0655d751d4..0000000000 --- a/docset/winserver2012-ps/adfs/Add-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,556 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADFSClaimsProviderTrust - -## SYNOPSIS -Adds a new claims provider trust to the Federation Service. - -## SYNTAX - -### AllProperties -``` -Add-ADFSClaimsProviderTrust -Name -Identifier -TokenSigningCertificate - [-AllowCreate ] [-AutoUpdateEnabled ] [-AcceptanceTransformRules ] - [-AcceptanceTransformRulesFile ] [-EncryptionCertificate ] - [-EncryptionCertificateRevocationCheck ] [-WSFedEndpoint ] [-Enabled ] - [-MonitoringEnabled ] [-Notes ] [-ClaimOffered ] - [-SamlEndpoint ] [-ProtocolProfile ] [-RequiredNameIdFormat ] - [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SignatureAlgorithm ] - [-SigningCertificateRevocationCheck ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### MetadataFile -``` -Add-ADFSClaimsProviderTrust -Name [-AllowCreate ] [-AutoUpdateEnabled ] - [-AcceptanceTransformRules ] [-AcceptanceTransformRulesFile ] - [-EncryptionCertificateRevocationCheck ] [-MetadataFile ] [-Enabled ] - [-MonitoringEnabled ] [-Notes ] [-ProtocolProfile ] [-RequiredNameIdFormat ] - [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SignatureAlgorithm ] - [-SigningCertificateRevocationCheck ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### MetadataUrl -``` -Add-ADFSClaimsProviderTrust -Name [-AllowCreate ] [-AutoUpdateEnabled ] - [-AcceptanceTransformRules ] [-AcceptanceTransformRulesFile ] - [-EncryptionCertificateRevocationCheck ] [-MetadataUrl ] [-Enabled ] - [-MonitoringEnabled ] [-Notes ] [-ProtocolProfile ] [-RequiredNameIdFormat ] - [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SignatureAlgorithm ] - [-SigningCertificateRevocationCheck ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Add-ADFSClaimsProviderTrust cmdlet adds a new claims provider trust to the Federation Service. -A claims provider trust can be specified manually, or a federation metadata document may be provided to bootstrap initial configuration. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADFSClaimProviderTrust -Name 'Fabrikam' -MetadataURL 'https://fabrikam.com/federationmetadata/2007-06/federationmetadata.xml' -``` - -Description - ------------ - -Adds a claims provider trust named Fabrikam for federation. - -## PARAMETERS - -### -AcceptanceTransformRules -Specifies the claim acceptance transform rules for accepting claims from this claims provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AcceptanceTransformRulesFile -Specifies a file containing the claim acceptance transform rules for accepting claims from this claims provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreate -Specifies whether the SAML parameter AllowCreate should be sent in SAML requests to the claims provider. -By default, this parameter is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateEnabled -Specifies whether changes to the federation metadata at the MetadataURL that is being monitored are applied automatically to the configuration of the trust relationship. -Partner claims, certificates, and endpoints are updated automatically if this parameter is enabled (true). - -Note: When auto-update is enabled, fields that can be overwritten by metadata become read only. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClaimOffered -Specifies the claims that are offered by this claims provider. - -```yaml -Type: ClaimDescription[] -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies whether the claims provider trust is enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedNameIdRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificate -Specifies the certificate to be used for encrypting a NameID to this claims provider in SAML logout requests. -Encrypting the NameID is optional. - -```yaml -Type: X509Certificate2 -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificateRevocationCheck -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identifier -Specifies the unique identifier for this claims provider trust. -No other trust may use an identifier from this list. -Uniform Resource Identifiers (URIs) are often used as unique identifiers for a claims provider trust, but any string of characters may be used. - -```yaml -Type: String -Parameter Sets: AllProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataFile -Specifies a file path, such as c:\metadata.xml, that contains the federation metadata to be used when this claims provider trust is created. - -```yaml -Type: String -Parameter Sets: MetadataFile -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataUrl -Specifies a URL at which the federation metadata for this claims provider trust is available. - -```yaml -Type: Uri -Parameter Sets: MetadataUrl -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringEnabled -Specifies whether periodic monitoring of this claims provider's federation metadata is enabled. -The URL of the claims provider's federation metadata is specified by the MetadataUrl parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this claims provider trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies any notes for this claims provider trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtocolProfile -This parameter controls which protocol profiles the claims provider supports. -The protocols can be one of the following: {SAML, WsFederation, WsFed-SAML}. -By default, this parameter is WsFed-SAML. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WSFederation, WsFed-SAML, SAML - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredNameIdFormat -Specifies the format that is required for NameID claims to be included in SAML requests to the claims provider. -By default, no format is required. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlAuthenticationRequestIndex -Specifies the value of AssertionConsumerServiceIndex that will be placed in SAML authentication requests that are sent to the claims provider. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlAuthenticationRequestParameters -Specifies which of the parameters (AssertionConsumerServiceIndex, AssertionConsumerServiceUrl, ProtocolBinding) will be used in SAML authentication requests to the claims provider. -Specify a value from the set: {None, Index, Url, ProtocolBinding, UrlWithProtocolBinding} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Index, None, ProtocolBinding, Url, UrlWithProtocolBinding - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlAuthenticationRequestProtocolBinding -Specifies the value of ProtocolBinding that will be placed in SAML authentication requests to the claims provider. -Use values from the set: {Artifact, Post, Redirect} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Artifact, POST, Redirect - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlEndpoint -Specifies the SAML protocol endpoints for this claims provider. - -```yaml -Type: SamlEndpoint[] -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SignatureAlgorithm -Specifies the signature algorithm that the claims provider uses for signing and verification. -Valid values are: - -http://www.w3.org/2000/09/xmldsig#rsa-sha1 - -http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignedSamlRequestsRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateRevocationCheck -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TokenSigningCertificate -Specifies the token-signing certificates to be used by the claims provider. - -```yaml -Type: X509Certificate2[] -Parameter Sets: AllProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WSFedEndpoint -Specifies the WS-Federation Passive URL for this claims provider. - -```yaml -Type: Uri -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None -The claims provider is responsible for collecting and authenticating a user's credentials, building up claims for that user, and packaging the claims into security tokens or Information Cards. -In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. -When you configure AD FS 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that a relying party organization hosts by establishing one side of a federation trust relationship. -After the trust is established, tokens and Information Cards can be presented to the relying party across the federation trust. - -## NOTES -* The claims provider is responsible for collecting and authenticating a user's credentials, building up claims for that user, and packaging the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure AD FS 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that a relying party organization hosts by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to the relying party across the federation trust. - -## RELATED LINKS - -[Disable-ADFSClaimsProviderTrust](./Disable-ADFSClaimsProviderTrust.md) - -[Enable-ADFSClaimsProviderTrust](./Enable-ADFSClaimsProviderTrust.md) - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Remove-ADFSClaimsProviderTrust](./Remove-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Add-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Add-ADFSRelyingPartyTrust.md deleted file mode 100644 index 7df6dbc32c..0000000000 --- a/docset/winserver2012-ps/adfs/Add-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,635 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ADFSRelyingPartyTrust - -## SYNOPSIS -Adds a new relying party trust to the Federation Service. - -## SYNTAX - -### AllProperties -``` -Add-ADFSRelyingPartyTrust -Name -Identifier [-EncryptionCertificate ] - [-EncryptClaims ] [-IssuanceAuthorizationRules ] [-IssuanceAuthorizationRulesFile ] - [-DelegationAuthorizationRules ] [-DelegationAuthorizationRulesFile ] - [-EncryptionCertificateRevocationCheck ] [-ImpersonationAuthorizationRules ] - [-ImpersonationAuthorizationRulesFile ] [-IssuanceTransformRules ] - [-IssuanceTransformRulesFile ] [-AutoUpdateEnabled ] [-WSFedEndpoint ] - [-Enabled ] [-MonitoringEnabled ] [-NotBeforeSkew ] [-Notes ] - [-ClaimAccepted ] [-SamlEndpoint ] [-ProtocolProfile ] - [-RequestSigningCertificate ] [-EncryptedNameIdRequired ] - [-SignedSamlRequestsRequired ] [-SamlResponseSignature ] [-SignatureAlgorithm ] - [-SigningCertificateRevocationCheck ] [-TokenLifetime ] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### MetadataFile -``` -Add-ADFSRelyingPartyTrust -Name [-EncryptClaims ] [-IssuanceAuthorizationRules ] - [-IssuanceAuthorizationRulesFile ] [-DelegationAuthorizationRules ] - [-DelegationAuthorizationRulesFile ] [-EncryptionCertificateRevocationCheck ] - [-ImpersonationAuthorizationRules ] [-ImpersonationAuthorizationRulesFile ] - [-IssuanceTransformRules ] [-IssuanceTransformRulesFile ] [-MetadataFile ] - [-AutoUpdateEnabled ] [-Enabled ] [-MonitoringEnabled ] [-NotBeforeSkew ] - [-Notes ] [-ProtocolProfile ] [-EncryptedNameIdRequired ] - [-SignedSamlRequestsRequired ] [-SamlResponseSignature ] [-SignatureAlgorithm ] - [-SigningCertificateRevocationCheck ] [-TokenLifetime ] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### MetadataUrl -``` -Add-ADFSRelyingPartyTrust -Name [-EncryptClaims ] [-IssuanceAuthorizationRules ] - [-IssuanceAuthorizationRulesFile ] [-DelegationAuthorizationRules ] - [-DelegationAuthorizationRulesFile ] [-EncryptionCertificateRevocationCheck ] - [-ImpersonationAuthorizationRules ] [-ImpersonationAuthorizationRulesFile ] - [-IssuanceTransformRules ] [-IssuanceTransformRulesFile ] [-MetadataUrl ] - [-AutoUpdateEnabled ] [-Enabled ] [-MonitoringEnabled ] [-NotBeforeSkew ] - [-Notes ] [-ProtocolProfile ] [-EncryptedNameIdRequired ] - [-SignedSamlRequestsRequired ] [-SamlResponseSignature ] [-SignatureAlgorithm ] - [-SigningCertificateRevocationCheck ] [-TokenLifetime ] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Add-ADFSRelyingPartyTrust cmdlet adds a new relying party trust to the Federation Service. -A relying party trust can be specified manually, or a federation metadata document may be provided to bootstrap initial configuration. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Add-ADFSRelyingPartyTrust -Name 'Fabrikam' -MetadataURL 'https://fabrikam.com/federationmetadata/2007-06/federationmetadata.xml' -``` - -Description - ------------ - -Adds a relying party trust named Fabrikam for federation. - -## PARAMETERS - -### -AutoUpdateEnabled -Specifies whether changes to the federation metadata at the MetadataURL that is being monitored are applied automatically to the configuration of the trust relationship. -Partner claims, certificates, and endpoints are updated automatically if this parameter is enabled (true). - -Note: When auto-update is enabled, fields that can be overwritten by metadata become read only. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClaimAccepted -Specifies the claims that this relying party accepts. - -```yaml -Type: ClaimDescription[] -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegationAuthorizationRules -Specifies the delegation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DelegationAuthorizationRulesFile -Specifies a file that contains the delegation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies whether the relying party trust is enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptClaims -Specifies whether the claims that are sent to the relying party should be encrypted. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedNameIdRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificate -Specifies the certificate to be used for encrypting claims that are issued to this relying party. -Encrypting claims is optional. - -```yaml -Type: X509Certificate2 -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificateRevocationCheck -Specifies the type of validation that should occur for the encryption certificate it is used for encrypting claims to the relying party. -Valid values are None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identifier -Specifies the unique identifiers for this relying party trust. -No other trust may use an identifier from this list. -Uniform Resource Identifiers (URIs) are often used as unique identifiers for a relying party trust, but any string of characters may be used. - -```yaml -Type: String[] -Parameter Sets: AllProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImpersonationAuthorizationRules -Specifies the impersonation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImpersonationAuthorizationRulesFile -Specifies the file that contains the impersonation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssuanceAuthorizationRules -Specifies the issuance authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuanceAuthorizationRulesFile -Specifies the file containing the issuance authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssuanceTransformRules -Specifies the issuance transform rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuanceTransformRulesFile -Specifies the file that contains the issuance transform rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataFile -Specifies a file path, such as c:\metadata.xml, that contains the federation metadata for this relying party trust. - -```yaml -Type: String -Parameter Sets: MetadataFile -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataUrl -Specifies a URL at which the federation metadata for this relying party trust is available. - -```yaml -Type: Uri -Parameter Sets: MetadataUrl -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringEnabled -Specifies whether periodic monitoring of this relying party's federation metadata is enabled. -The URL of the relying party's federation metadata is specified by the MetadataUrl parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this relying party trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBeforeSkew -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies any notes for this relying party trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtocolProfile -This parameter controls which protocol profiles the relying party supports. -The protocols can be one of the following: {SAML, WsFederation, WsFed-SAML}. -By default, this parameter is WsFed-SAML. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WsFed-SAML, WSFederation, SAML - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestSigningCertificate -Specifies the certificate to be used to verify the signature on a request from the relying party. - -```yaml -Type: X509Certificate2[] -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SamlEndpoint -Specifies the SAML protocol endpoints for this relying party. - -```yaml -Type: SamlEndpoint[] -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SamlResponseSignature -Specifies the response signature or signatures that the relying party expects. -Valid values are AssertionOnly, MessageAndAssertion, and MessageOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AssertionOnly, MessageAndAssertion, MessageOnly - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignatureAlgorithm -Specifies the signature algorithm that the relying party uses for signing and verification. -Valid values are: - -http://www.w3.org/2000/09/xmldsig#rsa-sha1 - -http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignedSamlRequestsRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateRevocationCheck -Specifies the type of certificate validation that should occur when signatures on requests from the relying party are verified. -Valid values are None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TokenLifetime -Specifies the duration in minutes for which the claims that are issued to the relying party are valid. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WSFedEndpoint -Specifies the WS-Federation Passive URL for this relying party. - -```yaml -Type: Uri -Parameter Sets: AllProperties -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server in the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - - - -## RELATED LINKS - -[Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) - -[Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Add-AdfsFarmNode.md b/docset/winserver2012-ps/adfs/Add-AdfsFarmNode.md deleted file mode 100644 index a1147d1456..0000000000 --- a/docset/winserver2012-ps/adfs/Add-AdfsFarmNode.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.FederationServices.Deployment.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfsfarmnode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-AdfsFarmNode - -## SYNOPSIS -Adds this computer to an existing federation server farm. - -## SYNTAX - -### ADFSFarmJoin (Default) -``` -Add-AdfsFarmNode [-CertificateThumbprint ] [-OverwriteConfiguration] -PrimaryComputerName - [-PrimaryComputerPort ] -ServiceAccountCredential [] -``` - -### ADFSFarmJoinSQL -``` -Add-AdfsFarmNode [-CertificateThumbprint ] -ServiceAccountCredential - -SQLConnectionString [] -``` - -## DESCRIPTION -The Add-AdfsFarmNode cmdlet adds this computer to an existing federation server farm. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$fscredential = Get-Credential -C:\PS>Add-AdfsFarmNode -ServiceAccountCredential $fscredential -SQLConnectionString "Data Source=SQLHost;Integrated Security=True" -``` - -Description - ------------ - -Adds the local server computer as a node in an existing federation server farm that uses a Microsoft SQL Server database installed on a computer called "SQLHost". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$fscredential = Get-Credential -C:\PS>Add-AdfsFarmNode -OverwriteConfiguration -PrimaryComputerName "PrimaryWIDHost" -PrimaryComputerPort 80 -ServiceAccountCredential $fscredential -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -``` - -Description - ------------ - -Overwrites an existing AD FS configuration database and adds the local server computer as a node in an existing federation server farm that uses Windows Internal Database (WID) and whose primary node is installed on a computer called "PrimaryWIDHost". - -Note that the PrimaryComputerPort is needed even if the default HTTP port of 80 is used and that the CertificateThumbprint parameter is only required if it is not already configured as a binding in IIS. -Also when specifying a value for the CertificateThumbprint parameter, the value you use must specify the thumbprint of a certificate that is currently installed in the local machine My store, and the certificate must be the same certificate that is used as the SSL certificate on the primary node. - -## PARAMETERS - -### -CertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used in the SSL binding of the Default Web Site in IIS. -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverwriteConfiguration -This parameter must be used to remove an existing AD FS configuration database and overwrite it with a new database. - -```yaml -Type: SwitchParameter -Parameter Sets: ADFSFarmJoin -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryComputerName -Specifies the name of the primary federation server in the farm that this computer will join. - -```yaml -Type: String -Parameter Sets: ADFSFarmJoin -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryComputerPort -Specifies the value of the HTTP port that this computer uses to connect with the primary computer in order to synchronize configuration settings. -Specify a value of 80 for this parameter, or specify an alternate value if the HTTP port on the primary computer is not 80. -If this parameter is not specified, a default port value of 443 is assumed. - -```yaml -Type: Int32 -Parameter Sets: ADFSFarmJoin -Aliases: - -Required: False -Position: Named -Default value: 80 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SQLConnectionString -Specifies the SQL Server database that will store the AD FS configuration settings. -If not specified, AD FS uses Windows Internal Database to store configuration settings - -```yaml -Type: String -Parameter Sets: ADFSFarmJoinSQL -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccountCredential -Specifies the Active Directory account under which the AD FS service runs. -All nodes in the farm must use the same service account. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### none - -## OUTPUTS - -### Result object - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adfs/Add-AdfsProxy.md b/docset/winserver2012-ps/adfs/Add-AdfsProxy.md deleted file mode 100644 index 17a2319e80..0000000000 --- a/docset/winserver2012-ps/adfs/Add-AdfsProxy.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.FederationServices.Deployment.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/add-adfsproxy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-AdfsProxy - -## SYNOPSIS -Configures this computer as a federation server proxy. - -## SYNTAX - -``` -Add-AdfsProxy [-FederationServiceName] -FederationServiceTrustCredential - [-ForwardProxy ] [] -``` - -## DESCRIPTION -The Add-Adfsproxy cmdlet configures this computer as a federation server proxy. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$fsCredential = Get-Credential -C:\PS>Add-AdfsProxy -FederationServiceName fs.corp.contoso.com -FederationServiceTrustCredential $fscredential -``` - -Description - ------------ - -Adds a federation service proxy to an existing AD FS installation with federation service name fs.corp.contoso.com. -Credentials entered as FederationServiceTrustCredential can be the AD FS service account or another account that has administrative permissions on the federation server(s) on which the federation service is installed. - -## PARAMETERS - -### -FederationServiceName -Specifies the name of the federation service for which this computer will proxy requests. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FederationServiceTrustCredential -Specifies the credentials of the Active Directory identity that is authorized to register new federation server proxies. -By default, this is the account under which the federation service runs or an account that is a member of the administrators group on the federation server. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardProxy -Specifies the DNS name and port of an HTTP proxy that this federation server proxy will use to obtain access to the federation service. -For example, the syntax to use to specify a forward proxy with a host name of "proxy01" that is located within the corp.contoso.com domain and that can be reached using the HTTP port of 8080 would be "proxy-01.corp.contoso.com:8080". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### none - -## OUTPUTS - -### Result object - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adfs/Disable-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Disable-ADFSClaimsProviderTrust.md deleted file mode 100644 index 3cbef9e3b7..0000000000 --- a/docset/winserver2012-ps/adfs/Disable-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/disable-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-ADFSClaimsProviderTrust - -## SYNOPSIS -Disables a claims provider trust in the Federation Service. - -## SYNTAX - -### IdentifierObject -``` -Disable-ADFSClaimsProviderTrust -TargetClaimsProviderTrust [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### TokenSigningCertificates -``` -Disable-ADFSClaimsProviderTrust -TargetCertificate [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### Identifier -``` -Disable-ADFSClaimsProviderTrust -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### IdentifierName -``` -Disable-ADFSClaimsProviderTrust -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Disable-ADFSClaimsProviderTrust cmdlet disables a claims provider trust in the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Disable-ADFSClaimsProviderTrust -TargetName "My claims provider" -``` - -Description - ------------ - -Disables the claims provider trust named "My claims provider". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCertificate -Specifies the token-signing certificate of the claims provider trust to disable. - -```yaml -Type: X509Certificate2 -Parameter Sets: TokenSigningCertificates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimsProviderTrust -```yaml -Type: ClaimsProviderTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the claims provider trust to disable. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the claims provider trust to disable. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust -A class that represents a claims provider trust for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* The claims provider is responsible for collecting and authenticating a user's credentials, building up claims for that user, and packaging the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to a relying party across the federation trust. - -## RELATED LINKS - -[Enable-ADFSClaimsProviderTrust](./Enable-ADFSClaimsProviderTrust.md) - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Remove-ADFSClaimsProviderTrust](./Remove-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Disable-ADFSEndpoint.md b/docset/winserver2012-ps/adfs/Disable-ADFSEndpoint.md deleted file mode 100644 index 5f949a08c8..0000000000 --- a/docset/winserver2012-ps/adfs/Disable-ADFSEndpoint.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/disable-adfsendpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-ADFSEndpoint - -## SYNOPSIS -Disables an endpoint of the Federation Service. - -## SYNTAX - -### Address -``` -Disable-ADFSEndpoint [[-TargetAddressPath] ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### TargetObject -``` -Disable-ADFSEndpoint [-TargetEndpoint] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### FullUrl -``` -Disable-ADFSEndpoint [-TargetFullUrl] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Disable-ADFSEndpoint cmdlet disables an endpoint of the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Disable-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows -``` - -Description - ------------ - -Disables the WS-Trust 1.3 endpoint on the current federation server. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAddressPath -```yaml -Type: String -Parameter Sets: Address -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetEndpoint -Specifies the endpoint to disable. -This value is typically taken from the pipeline. - -```yaml -Type: Endpoint -Parameter Sets: TargetObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetFullUrl -Specifies the full URL of the endpoint to disable. - -```yaml -Type: Uri -Parameter Sets: FullUrl -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.Endpoint -A class that represents an endpoint for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token issuance, Information Card issuance, and the publishing of federation metadata. Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to AD FS 2.0 proxies. - -## RELATED LINKS - -[Enable-ADFSEndpoint](./Enable-ADFSEndpoint.md) - -[Get-ADFSEndpoint](./Get-ADFSEndpoint.md) - -[Set-ADFSEndpoint](./Set-ADFSEndpoint.md) - diff --git a/docset/winserver2012-ps/adfs/Disable-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Disable-ADFSRelyingPartyTrust.md deleted file mode 100644 index c40ad45717..0000000000 --- a/docset/winserver2012-ps/adfs/Disable-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/disable-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-ADFSRelyingPartyTrust - -## SYNOPSIS -Disables a relying party trust of the Federation Service. - -## SYNTAX - -### Identifier -``` -Disable-ADFSRelyingPartyTrust -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierObject -``` -Disable-ADFSRelyingPartyTrust -TargetRelyingParty [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### IdentifierName -``` -Disable-ADFSRelyingPartyTrust -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Disable-ADFSRelyingPartyTrust cmdlet disables a relying party trust of the federation service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Disable-ADFSRelyingPartyTrust -TargetName "My application" -``` - -Description - ------------ - -Disables a relying party trust called "My application" on the federation server. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the relying party trust to disable. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the relying party trust to disable. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetRelyingParty -Specifies the relying party trust to disable. -This value is typically taken from the pipeline. - -```yaml -Type: RelyingPartyTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust -A class that represents a relying party trust for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - -## RELATED LINKS - -[Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) - -[Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Enable-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Enable-ADFSClaimsProviderTrust.md deleted file mode 100644 index 484ad23430..0000000000 --- a/docset/winserver2012-ps/adfs/Enable-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/enable-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-ADFSClaimsProviderTrust - -## SYNOPSIS -Enables a claims provider trust in the Federation Service. - -## SYNTAX - -### IdentifierObject -``` -Enable-ADFSClaimsProviderTrust -TargetClaimsProviderTrust [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### TokenSigningCertificates -``` -Enable-ADFSClaimsProviderTrust -TargetCertificate [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### Identifier -``` -Enable-ADFSClaimsProviderTrust -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierName -``` -Enable-ADFSClaimsProviderTrust -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Enable-ADFSClaimsProviderTrust cmdlet enables a claims provider trust in the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Enable-ADFSClaimsProviderTrust -TargetName "My claims provider" -``` - -Description - ------------ - -Enables a claims provider trust with the name "My claims provider". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCertificate -Specifies the token-signing certificate of the claims provider trust to enable. - -```yaml -Type: X509Certificate2 -Parameter Sets: TokenSigningCertificates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimsProviderTrust -```yaml -Type: ClaimsProviderTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the claims provider trust to enable. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the claims provider trust to enable. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust -A class structure that represents the claims provider trusts for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* The claims provider is responsible for collecting and authenticating a user's credentials, building up claims for that user, and packaging the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to a relying party across the federation trust. - -## RELATED LINKS - -[Disable-ADFSClaimsProviderTrust](./Disable-ADFSClaimsProviderTrust.md) - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Remove-ADFSClaimsProviderTrust](./Remove-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Enable-ADFSEndpoint.md b/docset/winserver2012-ps/adfs/Enable-ADFSEndpoint.md deleted file mode 100644 index 4b8cc9a4d3..0000000000 --- a/docset/winserver2012-ps/adfs/Enable-ADFSEndpoint.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/enable-adfsendpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-ADFSEndpoint - -## SYNOPSIS -Enables an endpoint in the Federation Service. - -## SYNTAX - -### Address -``` -Enable-ADFSEndpoint [[-TargetAddressPath] ] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### TargetObject -``` -Enable-ADFSEndpoint [-TargetEndpoint] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### FullUrl -``` -Enable-ADFSEndpoint [-TargetFullUrl] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Enable-ADFSEndpoint cmdlet enables an endpoint in the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Enable-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows -``` - -Description - ------------ - -Enables the WS-Trust 1.3 endpoint for the Federation Service. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAddressPath -```yaml -Type: String -Parameter Sets: Address -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetEndpoint -Specifies the endpoint to enable. -This value is typically taken from the pipeline. - -```yaml -Type: Endpoint -Parameter Sets: TargetObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetFullUrl -Specifies the full URL of the endpoint to enable. - -```yaml -Type: Uri -Parameter Sets: FullUrl -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.Endpoint -A class structure that represents the endpoints for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token issuance, Information Card issuance, and the publishing of federation metadata. Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to AD FS 2.0 proxies. - -## RELATED LINKS - -[Disable-ADFSEndpoint](./Disable-ADFSEndpoint.md) - -[Get-ADFSEndpoint](./Get-ADFSEndpoint.md) - -[Set-ADFSEndpoint](./Set-ADFSEndpoint.md) - diff --git a/docset/winserver2012-ps/adfs/Enable-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Enable-ADFSRelyingPartyTrust.md deleted file mode 100644 index 84b5cf56db..0000000000 --- a/docset/winserver2012-ps/adfs/Enable-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/enable-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-ADFSRelyingPartyTrust - -## SYNOPSIS -Enables a relying party trust of the Federation Service. - -## SYNTAX - -### Identifier -``` -Enable-ADFSRelyingPartyTrust -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierObject -``` -Enable-ADFSRelyingPartyTrust -TargetRelyingParty [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### IdentifierName -``` -Enable-ADFSRelyingPartyTrust -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Enable-ADFSRelyingPartyTrust cmdlet enables a relying party trust of the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Enable-ADFSRelyingPartyTrust -TargetName "My application" -``` - -Description - ------------ - -Enables a relying party trust. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the relying party trust to enable. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the relying party trust to enable. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetRelyingParty -Specifies the relying party trust to enable. -This value is typically taken from the pipeline. - -```yaml -Type: RelyingPartyTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust -A class structure that represents relying party trusts for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - -## RELATED LINKS - -[Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) - -[Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Export-AdfsDeploymentSQLScript.md b/docset/winserver2012-ps/adfs/Export-AdfsDeploymentSQLScript.md deleted file mode 100644 index d4c216aa5a..0000000000 --- a/docset/winserver2012-ps/adfs/Export-AdfsDeploymentSQLScript.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -external help file: Microsoft.FederationServices.Deployment.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/export-adfsdeploymentsqlscript?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-AdfsDeploymentSQLScript - -## SYNOPSIS -Generates the SQL scripts that can be used separately to create the AD FS database and to grant permissions. - -## SYNTAX - -``` -Export-AdfsDeploymentSQLScript -DestinationFolder -ServiceAccountName [] -``` - -## DESCRIPTION -The Export-AdfsDeploymentSQLScript cmdlet generates the SQL scripts that can be used separately to create the AD FS database and to grant permissions. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Export-AdfsDeploymentSQLScript -DestinationFolder ".\scriptfolder" -ServiceAccountName DOMAIN\adfsUser -``` - -Description - ------------ - -Exports SQL deployment scripts for AD FS installation on behalf of the specified AD FS service account ("adfsUser"). - -## PARAMETERS - -### -DestinationFolder -Specifies the folder in which the generated SQL scripts will be saved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccountName -Specifies the name of the Active Directory account under which the AD FS service runs. -All nodes in the farm must use the same service account. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### none - -## OUTPUTS - -### Result object - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSAttributeStore.md b/docset/winserver2012-ps/adfs/Get-ADFSAttributeStore.md deleted file mode 100644 index b7df098dc5..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSAttributeStore.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsattributestore?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSAttributeStore - -## SYNOPSIS -Gets the attribute stores of the Federation Service. - -## SYNTAX - -``` -Get-ADFSAttributeStore [[-Name] ] [] -``` - -## DESCRIPTION -The Get-ADFSAttributeStore cmdlet retrieves the attribute stores of the Federation Service. -You can use this cmdlet with no parameters to retrieve all the attribute stores of the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADFSAttributeStore -Name "MyCustomStore" -``` - -Description - ------------ - -Gets the properties for the attribute store named MyCustomStore. - -## PARAMETERS - -### -Name -Specifies the name of the attribute store to retrieve. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.AttributeStore -A class structure that represents the attribute stores that are configured for the Federation Service. - -## NOTES -* An Active Directory Federation Services (AD FS) 2.0 attribute store is a pluggable module that the policy process for AD FS 2.0 can query to retrieve claim values. You can use either an Active Directory database or a Microsoft SQL Server database as your attribute store. You can also use your own custom attribute store. - -## RELATED LINKS - -[Add-ADFSAttributeStore](./Add-ADFSAttributeStore.md) - -[Remove-ADFSAttributeStore](./Remove-ADFSAttributeStore.md) - -[Set-ADFSAttributeStore](./Set-ADFSAttributeStore.md) - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSCertificate.md b/docset/winserver2012-ps/adfs/Get-ADFSCertificate.md deleted file mode 100644 index 4325c797e1..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSCertificate.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfscertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSCertificate - -## SYNOPSIS -Gets the certificates that are in the Federation Service. - -## SYNTAX - -### ByType (Default) -``` -Get-ADFSCertificate [[-CertificateType] ] [] -``` - -### ByReference -``` -Get-ADFSCertificate [-Thumbprint] [] -``` - -## DESCRIPTION -The Get-ADFSCertificate cmdlet retrieves the certificates that the Federation Service uses for token signing, token decrypting, card signing and securing service communications. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADFSCertificate -CertificateType "Token-Signing" -``` - -Description - ------------ - -Gets the token-signing certificates for the Federation Service. - -## PARAMETERS - -### -CertificateType -Specifies the type of the certificate to retrieve. -Possible certificate types include the following: - -Token-Signing, Token-Encryption, Service-Communications, or Infocard-Signing. - -```yaml -Type: String[] -Parameter Sets: ByType -Aliases: -Accepted values: Service-Communications, Token-Decrypting, Token-Signing - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate to retrieve. - -```yaml -Type: String[] -Parameter Sets: ByReference -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate -A class structure that represents the certificate objects for the Federation Service. - -## NOTES -* You can use the Get-ADFSCertificate cmdlet without any parameters to get all the certificates. - -## RELATED LINKS - -[Add-ADFSCertificate](./Add-ADFSCertificate.md) - -[Remove-ADFSCertificate](./Remove-ADFSCertificate.md) - -[Update-ADFSCertificate](./Update-ADFSCertificate.md) - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSClaimDescription.md b/docset/winserver2012-ps/adfs/Get-ADFSClaimDescription.md deleted file mode 100644 index b64caf4a24..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSClaimDescription.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsclaimdescription?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSClaimDescription - -## SYNOPSIS -Gets claim descriptions that are in the Federation Service. - -## SYNTAX - -### Name (Default) -``` -Get-ADFSClaimDescription [[-Name] ] [] -``` - -### Identifier -``` -Get-ADFSClaimDescription -ClaimType [] -``` - -## DESCRIPTION -The Get-ADFSClaimDescription cmdlet retrieves the claim descriptions that are in the Federation Service. -Claim descriptions describe the claims that the Federation Service uses. -They also describe how these claims are published in federation metadata. -You can use this cmdlet without parameters to get the full list of claim descriptions. - -## EXAMPLES - -### Example 1: Get a claim description -```powershell -PS C:\> Get-AdfsClaimDescription | Where-Object {$_.IsOffered} -``` - -This command gets the list of claim descriptions that the Federation Service offers. - -## PARAMETERS - -### -ClaimType -Specifies the claim type of the claim description to retrieve. - -```yaml -Type: String[] -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the claim description to retrieve. - -```yaml -Type: String[] -Parameter Sets: Name -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription -A class structure that represents the claim description resources for the Federation Service. - -## NOTES -* Claim descriptions are used to configure the list of claims available to be offered or accepted by AD FS 2.0. - -## RELATED LINKS - -[Add-ADFSClaimDescription](./Add-ADFSClaimDescription.md) - -[Remove-ADFSClaimDescription](./Remove-ADFSClaimDescription.md) - -[Set-ADFSClaimDescription](./Set-ADFSClaimDescription.md) diff --git a/docset/winserver2012-ps/adfs/Get-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Get-ADFSClaimsProviderTrust.md deleted file mode 100644 index 936d6b0384..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSClaimsProviderTrust - -## SYNOPSIS -Gets the claims provider trusts in the Federation Service. - -## SYNTAX - -### ClaimsProviderName (Default) -``` -Get-ADFSClaimsProviderTrust [[-Name] ] [] -``` - -### TokenSigningCertificates -``` -Get-ADFSClaimsProviderTrust [-Certificate] [] -``` - -### Identifier -``` -Get-ADFSClaimsProviderTrust [-Identifier] [] -``` - -## DESCRIPTION -The Get-ADFSClaimsProviderTrust cmdlet retrieves the claims provider trusts in the Federation Service. -You can use this cmdlet with no parameters to get all the claims provider trust objects. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADFSClaimsProviderTrust -name "My claims provider" -``` - -Description - ------------ - -Gets the current property settings for a specified claims provider trust named "My claims provider". - -## PARAMETERS - -### -Certificate -Specifies the token-signing certificate of the claims provider trust to retrieve. - -```yaml -Type: X509Certificate2[] -Parameter Sets: TokenSigningCertificates -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identifier -Specifies the unique identifier of the claims provider trust to retrieve. - -```yaml -Type: String[] -Parameter Sets: Identifier -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the claims provider trust to retrieve. - -```yaml -Type: String[] -Parameter Sets: ClaimsProviderName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust -A class structure that represents the claims provider trusts for the Federation Service. - -## NOTES -* If no target parameter is provided, all claims providers are listed. The claims provider collects and authenticates a user's credentials, builds up claims for that user, and packages the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of the federation trust relationship. After the federation trust is established, tokens and Information Cards can be presented to the relying party across the trust. - -## RELATED LINKS - -[Disable-ADFSClaimsProviderTrust](./Disable-ADFSClaimsProviderTrust.md) - -[Enable-ADFSClaimsProviderTrust](./Enable-ADFSClaimsProviderTrust.md) - -[Remove-ADFSClaimsProviderTrust](./Remove-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSConfiguration.md b/docset/winserver2012-ps/adfs/Get-ADFSConfiguration.md deleted file mode 100644 index 7671c53d86..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSConfiguration.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSConfiguration - -## SYNOPSIS -Gets the configuration properties of the Federation Service. - -## SYNTAX - -``` -Get-ADFSConfiguration [] -``` - -## DESCRIPTION -The Get-ADFSConfiguration cmdlet gets the configuration properties of the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Get-ADFSConfiguration -``` - -Gets the current settings for all configuration properties of the Federation Service. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ServiceProperties -A class structure that represents the properties for the Federation Service. - -## NOTES -* The ADFSConfiguration resource enumerates the current configuration properties and settings used by the Federation Service. - -## RELATED LINKS - -[Set-ADFSConfiguration](./Set-ADFSConfiguration.md) - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSEndpoint.md b/docset/winserver2012-ps/adfs/Get-ADFSEndpoint.md deleted file mode 100644 index 0fb329f44f..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSEndpoint.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsendpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSEndpoint - -## SYNOPSIS -Gets the endpoints in the Federation Service. - -## SYNTAX - -### Address (Default) -``` -Get-ADFSEndpoint [[-AddressPath] ] [] -``` - -### FullUrl -``` -Get-ADFSEndpoint [-FullUrl] [] -``` - -## DESCRIPTION -The Get-ADFSEndpoint cmdlet retrieves a specified endpoint from the Federation Service. -The collection of ADFSEndpoint objects is a list of all the supported endpoints that are on the server. -You can use this list to view the configuration of endpoints and enable or disable them. -To see the full list of endpoints, use this cmdlet with no parameters. - -## EXAMPLES - -### Example 1: Get an endpoint -``` -PS C:\> Get-AdfsEndpoint -AddressPath "/adfs/services/trust/13/Windows" -``` - -This command gets the WS-Trust 1.3 endpoint. - -## PARAMETERS - -### -AddressPath -```yaml -Type: String[] -Parameter Sets: Address -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -FullUrl -Specifies the full URL of the endpoint to retrieve. - -```yaml -Type: Uri[] -Parameter Sets: FullUrl -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.Endpoint -A class structure that represents the endpoints for the Federation Service. - -## NOTES -* Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token issuance, Information Card issuance, and the publication of federation metadata. Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to AD FS 2.0 proxies. - -## RELATED LINKS - -[Disable-ADFSEndpoint](./Disable-ADFSEndpoint.md) - -[Enable-ADFSEndpoint](./Enable-ADFSEndpoint.md) - -[Set-ADFSEndpoint](./Set-ADFSEndpoint.md) diff --git a/docset/winserver2012-ps/adfs/Get-ADFSProxyConfiguration.md b/docset/winserver2012-ps/adfs/Get-ADFSProxyConfiguration.md deleted file mode 100644 index d079f3cfbb..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSProxyConfiguration.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsproxyconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSProxyConfiguration - -## SYNOPSIS -Gets the configuration properties of the federation server proxy. - -## SYNTAX - -``` -Get-ADFSProxyConfiguration [] -``` - -## DESCRIPTION -The Get-ADFSProxyConfiguration cmdlet retrieves the configuration properties of the federation server proxy in Active Directory Federation Services (AD FS). - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Get-ADFSProxyConfiguration -``` - -Gets the configuration properties for a federation server proxy. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ProxyProperties -A class structure that represents the properties for a federation server proxy in AD FS. - -## NOTES -* This cmdlet works only when it is called on a federation server proxy. - -## RELATED LINKS - -[Set-ADFSProxyConfiguration](./Set-ADFSProxyConfiguration.md) - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md deleted file mode 100644 index ebf6319706..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSRelyingPartyTrust - -## SYNOPSIS -Gets the relying party trusts of the Federation Service. - -## SYNTAX - -### RelyingPartyName (Default) -``` -Get-ADFSRelyingPartyTrust [[-Name] ] [] -``` - -### Identifier -``` -Get-ADFSRelyingPartyTrust [-Identifier] [] -``` - -### PrefixIdentifier -``` -Get-ADFSRelyingPartyTrust [-PrefixIdentifier] [] -``` - -## DESCRIPTION -The Get-ADFSRelyingPartyTrust cmdlet retrieves the relying party trusts in the Federation Service. -You can use this cmdlet with no parameters to get all relying party trust objects. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-ADFSRelyingPartyTrust -Name SampleApp -``` - -Description - ------------ - -Gets the current property settings for a relying party trust that is specified by name SampleApp. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-ADFSRelyingPartyTrust -Identifier https://www.fabrikam.com/ -``` - -Description - ------------ - -Gets the current property settings for a relying party trust that is specified by the identifier `https://www.fabrikam.com`. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-ADFSRelyingPartyTrust | Where-Object{ $_.LastUpdateTime -le (get-date).subtract((new-timespan -hours 24))} -``` - -Description - ------------ - -Gets the current property settings for any relying party trusts that have been updated within the last 24 hours. - -## PARAMETERS - -### -Identifier -Specifies the unique identifier of the relying party trust to retrieve. - -```yaml -Type: String[] -Parameter Sets: Identifier -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the display name of the relying party trust to retrieve. - -```yaml -Type: String[] -Parameter Sets: RelyingPartyName -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PrefixIdentifier -Specifies a prefix identifier of the relying party trust to retrieve. -Prefix matching is used to support wildcard-type filtering and do matches based on a specific prefix URL. -Matches are done using string data type evaluation and are not case-sensitive. - -```yaml -Type: String -Parameter Sets: PrefixIdentifier -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust -A class structure that represents a relying party trust. - -## NOTES -* If no Target* parameter is provided, all RelyingParty objects are returned. A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - -## RELATED LINKS - -[Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) - -[Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) - -[Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) - -[Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Get-ADFSSyncConfiguration.md b/docset/winserver2012-ps/adfs/Get-ADFSSyncConfiguration.md deleted file mode 100644 index c293e3cb35..0000000000 --- a/docset/winserver2012-ps/adfs/Get-ADFSSyncConfiguration.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/get-adfssyncconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ADFSSyncConfiguration - -## SYNOPSIS -Gets the configuration database synchronization properties of the Federation Service. - -## SYNTAX - -``` -Get-ADFSSyncConfiguration [] -``` - -## DESCRIPTION -The Get-ADFSSyncConfiguration cmdlet retrieves the configuration database synchronization properties of the Federation Service. - -## EXAMPLES - -### 1: -``` -PS C:\>Get-ADFSSyncConfiguration -``` - -Gets the current synchronization properties and activity for the Federation Service. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.SyncPropertiesBase -A class structure that represents the synchronization properties for the Federation Service. - -## NOTES -* This cmdlet keeps track of when Active Directory Federation Services (AD FS) 2.0 on a server computer last synchronized its database with other federation servers in your deployment. For example, the PollDuration property specifies the length of the poll interval in seconds. - -## RELATED LINKS - -[Set-ADFSSyncConfiguration](./Set-ADFSSyncConfiguration.md) - diff --git a/docset/winserver2012-ps/adfs/Install-AdfsFarm.md b/docset/winserver2012-ps/adfs/Install-AdfsFarm.md deleted file mode 100644 index 2af5648d3d..0000000000 --- a/docset/winserver2012-ps/adfs/Install-AdfsFarm.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: Microsoft.FederationServices.Deployment.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/install-adfsfarm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdfsFarm - -## SYNOPSIS -Creates the first node of a new federation server farm. - -## SYNTAX - -### ADFSFarmCreateDefault (Default) -``` -Install-AdfsFarm -CertificateThumbprint -FederationServiceName [-OverwriteConfiguration] - -ServiceAccountCredential [-SSLPort ] [] -``` - -### ADFSFarmCreateSQL -``` -Install-AdfsFarm -CertificateThumbprint -FederationServiceName [-OverwriteConfiguration] - -ServiceAccountCredential -SQLConnectionString [-SSLPort ] [] -``` - -### ADFSFarmCreateDisableAutoCertRollover -``` -Install-AdfsFarm -CertificateThumbprint -DecryptionCertificateThumbprint - -FederationServiceName [-OverwriteConfiguration] -ServiceAccountCredential - -SigningCertificateThumbprint [-SSLPort ] [] -``` - -### ADFSFarmCreateSQLDisableAutoCertRollover -``` -Install-AdfsFarm -CertificateThumbprint -DecryptionCertificateThumbprint - -FederationServiceName [-OverwriteConfiguration] -ServiceAccountCredential - -SigningCertificateThumbprint -SQLConnectionString [-SSLPort ] [] -``` - -## DESCRIPTION -The Install-Adfsfarm cmdlet creates the first node of a new federation server farm. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$fscredential = Get-Credential -C:\PS>Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -ServiceAccountCredential $fscredential -``` - -Description - ------------ - -Creates the first node in a federation server farm that uses the Windows Internal Database (WID) on the local server computer. - -In this example, a certificate thumbprint value is supplied for the CertificateThumbprint parameter. -This certificate will be used as the SSL certificate and the service communications certificate. -Automatically generated, self signed certificates will be used for the token signing and token decryption certificates. - -To specify certificates for token signing and token decryption, specify thumbprint values for the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>dir cert:\LocalMachine\My -``` - -Description - ------------ - -Lists thumbprint values of currently installed certificates. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>$fscredential = Get-Credential -C:\PS>Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -ServiceAccountCredential $fscredential -SQLConnectionString "Data Source=SQLHost;Integrated Security=True" -``` - -Description - ------------ - -Creates the first node in a federation server farm that uses a Microsoft SQL server database on a remote computer named "SQLHost". - -In this example, a certificate thumbprint value is supplied for the CertificateThumbprint parameter. -This certificate will be used as the SSL certificate and the service communications certificate. -Automatically generated, self signed certificates will be used for the token signing and token decryption certificates. - -To specify certificates for token signing and token decryption, specify thumbprint values for the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>$fscredential = Get-Credential -C:\PS>Install-AdfsFarm -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -ServiceAccountCredential $fscredential -SQLConnectionString "Data Source=SQLHost;Integrated Security=True" -OverwriteConfiguration -SigningCertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -DecryptionCertificateThumbprint cf2e5064c521d625c8d53536bc98aa8e08f5f2ad -``` - -Description - ------------ - -Overwrites an existing AD FS configuration database and creates the first node in a federation server farm that uses a Microsoft SQL server database on a remote computer named "SQLHost". - -In this example, certificate thumbprint values are specified for the token signing certificate and for the token encryption certificate using the SigningCertificateThumbprint and DecryptionCertificateThumbprint parameters respectively. - -## PARAMETERS - -### -CertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used in the Secure Sockets Layer (SSL) binding of the Default Web Site in Internet Information Services (IIS). -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecryptionCertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used for token decryption. -If this parameter is used, the automatic certificate rollover feature will be disabled, and a token signing certificate must also be specified using the SigningCertificateThumbprint parameter. -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: ADFSFarmCreateDisableAutoCertRollover, ADFSFarmCreateSQLDisableAutoCertRollover -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FederationServiceName -Specifies the DNS name of the federation service. -This value must match the subject name of the certificate configured on the SSL binding in IIS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverwriteConfiguration -This parameter must be used to remove an existing AD FS configuration database and overwrite it with a new database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SQLConnectionString -Specifies the SQL Server database that will store the AD FS configuration settings. -If not specified, the AD FS installer uses the Windows Internal Database to store configuration settings. - -```yaml -Type: String -Parameter Sets: ADFSFarmCreateSQL, ADFSFarmCreateSQLDisableAutoCertRollover -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SSLPort -Specifies the value of the port number of the SSL binding that the AD FS web site will use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 443 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccountCredential -Specifies the Active Directory account under which the AD FS service runs. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used for token signing. -If this parameter is used, the automatic certificate rollover feature will be disabled, and a token decryption certificate must also be specified using the DecryptionCertificateThumbprint parameter. -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: ADFSFarmCreateDisableAutoCertRollover, ADFSFarmCreateSQLDisableAutoCertRollover -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### none - -## OUTPUTS - -### Result object - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adfs/Install-AdfsStandalone.md b/docset/winserver2012-ps/adfs/Install-AdfsStandalone.md deleted file mode 100644 index f9eca0b6ea..0000000000 --- a/docset/winserver2012-ps/adfs/Install-AdfsStandalone.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.FederationServices.Deployment.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/install-adfsstandalone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-AdfsStandalone - -## SYNOPSIS -Sets up this computer as a stand-alone federation server for evaluation purposes or for a small lab environment. - -## SYNTAX - -### ADFSStandAloneEnableAutoCertRollover (Default) -``` -Install-AdfsStandalone -CertificateThumbprint -FederationServiceName - [-OverwriteConfiguration] [-SSLPort ] [] -``` - -### ADFSStandAloneDisableAutoCertRollover -``` -Install-AdfsStandalone -CertificateThumbprint -DecryptionCertificateThumbprint - -FederationServiceName [-OverwriteConfiguration] -SigningCertificateThumbprint - [-SSLPort ] [] -``` - -## DESCRIPTION -The Install-AdfsStandalone cmdlet sets up this computer as a stand-alone federation server for evaluation purposes or for a small lab environment. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$fscredential = Get-Credential -C:\PS>Install-AdfsStandalone -CertificateThumbprint 8169c52b4ec6e77eb2ae17f028fe5da4e35c0bed -FederationServiceName fs.corp.contoso.com -DecryptionCertificateThumbprint ‎049e0546ca9a63d7fb5a193ccaec29badc125176 -SigningCertificateThumbprint ‎059d9546ca9a63d7fb5a193ccaec29badc236358 -ServiceAccountCredential $fscredential -``` - -Description - ------------ - -Installs a standalone AD FS server with federation service name and all certificates specified, including those that are needed to sign and decrypt AD FS service communications. - -## PARAMETERS - -### -CertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used in the SSL binding of the Default Web Site in IIS. -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DecryptionCertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used for token decryption. -If this parameter is used, the automatic certificate rollover feature will be disabled, and a token signing certificate must also be specified using the SigningCertificateThumbprint parameter. -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: ADFSStandAloneDisableAutoCertRollover -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FederationServiceName -Specifies the DNS name of the federation service. -This value must match the subject name of the certificate configured on the SSL binding in IIS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OverwriteConfiguration -This parameter must be used to remove an existing AD FS configuration database and overwrite it with a new database. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SSLPort -Specifies the value of the port number of the SSL binding that the AD FS web site will use. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 443 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateThumbprint -Specifies the value of the certificate thumbprint of the certificate that should be used for token signing. -If this parameter is used, the automatic certificate rollover feature will be disabled, and a token decryption certificate must also be specified using the DecryptionCertificateThumbprint parameter. -This value should match the thumbprint of a valid certificate in the Local Computer certificate store. - -```yaml -Type: String -Parameter Sets: ADFSStandAloneDisableAutoCertRollover -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### none - -## OUTPUTS - -### Result object - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adfs/New-ADFSClaimRuleSet.md b/docset/winserver2012-ps/adfs/New-ADFSClaimRuleSet.md deleted file mode 100644 index 0aa811656e..0000000000 --- a/docset/winserver2012-ps/adfs/New-ADFSClaimRuleSet.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/new-adfsclaimruleset?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADFSClaimRuleSet - -## SYNOPSIS -Creates a new set of claim rules. - -## SYNTAX - -### FromParams -``` -New-ADFSClaimRuleSet -ClaimRule [] -``` - -### FromFile -``` -New-ADFSClaimRuleSet -ClaimRuleFile [] -``` - -## DESCRIPTION -The New-ADFSClaimRuleSet cmdlet creates a new set of claim rules in Active Directory Federation Services (AD FS) 2.0. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$rSet = New-ADFSClaimRuleSet -ClaimRuleFile 'C:\ruleset.txt' -Set-ADFSRelyingPartyTrust -TargetName Fabrikam -IssuanceTransformRules $rSet.ClaimRulesString -``` - -Description - ------------ - -Creates a new claim rule set for a relying party trust using a text file. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$rSet = New-ADFSClaimRuleSet -ClaimRule 'c:[] => issue(claim = c);' -Set-ADFSRelyingPartyTrust -TargetName Fabrikam -IssuanceTransformRules $rSet.ClaimRulesString -``` - -Description - ------------ - -Creates a new claim rule set for a relying party trust using an inline AD FS 2.0 claims language rule. - -## PARAMETERS - -### -ClaimRule -Specifies the individual rules in this rule set. - -```yaml -Type: String[] -Parameter Sets: FromParams -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClaimRuleFile -Specifies the serialized policy text that is created by the collection of rules in the rule set. - -```yaml -Type: String -Parameter Sets: FromFile -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimRuleSet -A class structure that represents a set of AD FS 2.0 claim rules. - -## NOTES -* You can assign these claim rules to a claims provider trust or relying party trust by using the corresponding cmdlets. - -## RELATED LINKS - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/New-ADFSContactPerson.md b/docset/winserver2012-ps/adfs/New-ADFSContactPerson.md deleted file mode 100644 index 09d003fdac..0000000000 --- a/docset/winserver2012-ps/adfs/New-ADFSContactPerson.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/new-adfscontactperson?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADFSContactPerson - -## SYNOPSIS -Creates a new contact person object. - -## SYNTAX - -``` -New-ADFSContactPerson [-Company ] [-EmailAddress ] [-GivenName ] - [-TelephoneNumber ] [-Surname ] [] -``` - -## DESCRIPTION -The New-ADFSContactPerson cmdlet creates a new contact person object in the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$cp = New-ADFSContactPerson -EmailAddress "support@fabrikam.com" -Set-ADFSProperties -ContactPerson $cp -``` - -Description - ------------ - -Creates a new contact person and sets it in the Federation Service. - -## PARAMETERS - -### -Company -Specifies the company name of the contact person. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailAddress -Specifies the e-mail address of the contact person. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GivenName -Specifies the given name of the contact person. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Surname -Specifies the surname (last name) of the contact person. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TelephoneNumber -Specifies the telephone number of the contact person. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ContactPerson -A class structure that represents a contact person object in the Federation Service. - -## NOTES -* You can publish this contact person in the federation metadata of the Federation Service by using the Set-ADFSProperties cmdlet. - -## RELATED LINKS diff --git a/docset/winserver2012-ps/adfs/New-ADFSOrganization.md b/docset/winserver2012-ps/adfs/New-ADFSOrganization.md deleted file mode 100644 index c0e3ee3e0f..0000000000 --- a/docset/winserver2012-ps/adfs/New-ADFSOrganization.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/new-adfsorganization?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADFSOrganization - -## SYNOPSIS -Creates a new organization information object. - -## SYNTAX - -``` -New-ADFSOrganization -DisplayName -OrganizationUrl [-Name ] [] -``` - -## DESCRIPTION -The New-ADFSOrganization cmdlet creates a new information object for an organization in Active Directory Federation Services (AD FS) 2.0 . - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-ADFSOrganization -DisplayName Fabrikam -OrganizationUrl http://fabrikam.com -``` - -Description - ------------ - -Adds a new organization named Fabrikam in the Federation Service. - -## PARAMETERS - -### -DisplayName -Specifies the display name of the organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the organization. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationUrl -Specifies the URL of the organization. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.Organization -A class structure that represents the organization object for the Federation Service. - -## NOTES -* You can publish this information by using the Set-ADFSProperties cmdlet. - -## RELATED LINKS diff --git a/docset/winserver2012-ps/adfs/New-ADFSSamlEndpoint.md b/docset/winserver2012-ps/adfs/New-ADFSSamlEndpoint.md deleted file mode 100644 index 51fca93d9a..0000000000 --- a/docset/winserver2012-ps/adfs/New-ADFSSamlEndpoint.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/new-adfssamlendpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-ADFSSamlEndpoint - -## SYNOPSIS -Creates a new SAML protocol endpoint object. - -## SYNTAX - -``` -New-ADFSSamlEndpoint -Binding -Protocol -Uri [-IsDefault ] [-Index ] - [-ResponseUri ] [] -``` - -## DESCRIPTION -The New-ADFSSamlEndpoint cmdlet creates a new SAML protocol endpoint object. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$ep = New-ADFSSamlEndpoint -Binding "POST" -Protocol "SAMLAssertionConsumer" -Uri "https://fabrikam.com/saml/ac" -Set-ADFSRelyingPartyTrust -Name "My application" -SamlEndpoint $ep -``` - -Description - ------------ - -Creates a new SAML endpoint and assigns it to a relying party trust named "My application". - -## PARAMETERS - -### -Binding -Specifies the binding type of the endpoint. -The possible binding types are POST, SOAP, Artifact, and Redirect. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Artifact, POST, Redirect, SOAP - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Index -Specifies the index that is defined for this endpoint. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsDefault -Specifies that this is a default endpoint for the particular protocol type. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Protocol -Specifies the type of service at the endpoint. -The possible values are SAMLSingleSignOn, SAMLArtifactResolution, SAMLLogout, and SAMLAssertionConsumer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: SAMLArtifactResolution, SAMLAssertionConsumer, SAMLLogout, SAMLSingleSignOn - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseUri -Specifies the response URI for the endpoint. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Uri -Specifies the URI of this endpoint. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.SamlEndpoint -A class structure that represents a SAML endpoint resource object. - -## NOTES -* You can associate this object with a relying party trust or claims provider trust by using the corresponding cmdlets. - -## RELATED LINKS - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Remove-ADFSAttributeStore.md b/docset/winserver2012-ps/adfs/Remove-ADFSAttributeStore.md deleted file mode 100644 index e1755f1433..0000000000 --- a/docset/winserver2012-ps/adfs/Remove-ADFSAttributeStore.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/remove-adfsattributestore?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFSAttributeStore - -## SYNOPSIS -Removes an attribute store from the Federation Service. - -## SYNTAX - -### Name -``` -Remove-ADFSAttributeStore [-TargetName] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-ADFSAttributeStore [-TargetAttributeStore] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Remove-ADFSAttributeStore cmdlet removes an attribute store from the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFSAttributeStore -TargetName "My Attribute Store" -``` - -Description - ------------ - -Removes an attribute store from the Federation Service. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAttributeStore -Specifies the attribute store to remove. -This value is typically taken from the pipeline. - -```yaml -Type: AttributeStore -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the attribute store to remove. - -```yaml -Type: String -Parameter Sets: Name -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.AttributeStore -A class structure that represents an AD FS 2.0 attribute store object - -## OUTPUTS - -### None - -## NOTES -* An Active Directory Federation Services (AD FS) 2.0 attribute store is a pluggable module that the policy process for AD FS 2.0 can query to retrieve claim values. You can use either an Active Directory database or a Microsoft SQL Server database as your attribute store, or you can create your own custom attribute store. - -## RELATED LINKS - -[Add-ADFSAttributeStore](./Add-ADFSAttributeStore.md) - -[Get-ADFSAttributeStore](./Get-ADFSAttributeStore.md) - -[Set-ADFSAttributeStore](./Set-ADFSAttributeStore.md) - diff --git a/docset/winserver2012-ps/adfs/Remove-ADFSCertificate.md b/docset/winserver2012-ps/adfs/Remove-ADFSCertificate.md deleted file mode 100644 index c9ea0ee0b3..0000000000 --- a/docset/winserver2012-ps/adfs/Remove-ADFSCertificate.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/remove-adfscertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFSCertificate - -## SYNOPSIS -Removes a certificate from the Federation Service. - -## SYNTAX - -### TargetCertificate (Default) -``` -Remove-ADFSCertificate [-TargetCertificate] [-WhatIf] [-Confirm] [] -``` - -### ByProperties -``` -Remove-ADFSCertificate -CertificateType -Thumbprint [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-ADFSCertificate cmdlet removes a certificate from the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFSCertificate -CertificateType Token-Signing -Thumbprint ‎fedd995b45e633d4ef30fcbc8f3a48b627e9a28b -``` - -Description - ------------ - -Removes a token-signing certificate from the Federation Service. - -## PARAMETERS - -### -CertificateType -Specifies the type of the certificate to remove. -Possible certificate types are - -Token-Signing, Token-Encryption, Service-Communications, or Infocard-Signing. - -```yaml -Type: String -Parameter Sets: ByProperties -Aliases: -Accepted values: Token-Decrypting, Token-Signing - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCertificate -Specifies the certificate to remove. -This value is typically taken from the pipeline. - -```yaml -Type: ServiceCertificate -Parameter Sets: TargetCertificate -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate to remove. - -```yaml -Type: String -Parameter Sets: ByProperties -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate -A class structure that represents the service certificates for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* Removing a certificate removes it only from the Active Directory Federation Services (AD FS) 2.0 configuration data. It does not remove or delete the certificate from the local certificate store on the server computer. - -## RELATED LINKS - -[Add-ADFSCertificate](./Add-ADFSCertificate.md) - -[Update-ADFSCertificate](./Update-ADFSCertificate.md) - diff --git a/docset/winserver2012-ps/adfs/Remove-ADFSClaimDescription.md b/docset/winserver2012-ps/adfs/Remove-ADFSClaimDescription.md deleted file mode 100644 index bce13426f3..0000000000 --- a/docset/winserver2012-ps/adfs/Remove-ADFSClaimDescription.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/remove-adfsclaimdescription?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFSClaimDescription - -## SYNOPSIS -Removes a claim description from the Federation Service. - -## SYNTAX - -### Name -``` -Remove-ADFSClaimDescription [-TargetName] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### Identifier -``` -Remove-ADFSClaimDescription [-TargetClaimType] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Remove-ADFSClaimDescription [-TargetClaimDescription] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Remove-ADFSClaimDescription cmdlet removes a claim description from the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFSClaimDescription -TargetName "Role" -``` - -Description - ------------ - -Removes the "Role" claim description. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetClaimDescription -Specifies the claim description to remove. -This value is typically taken from the pipeline. - -```yaml -Type: ClaimDescription -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimType -Specifies the claim type of the claim description to remove. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the claim description to remove. - -```yaml -Type: String -Parameter Sets: Name -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription -A class structure that represents a claim description object for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* Claim descriptions are used to configure the list of claims that are available to be offered or accepted by the Federation Service. - -## RELATED LINKS - -[Add-ADFSClaimDescription](./Add-ADFSClaimDescription.md) - -[Get-ADFSClaimDescription](./Get-ADFSClaimDescription.md) - -[Set-ADFSClaimDescription](./Set-ADFSClaimDescription.md) - diff --git a/docset/winserver2012-ps/adfs/Remove-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Remove-ADFSClaimsProviderTrust.md deleted file mode 100644 index 3bb0e2be00..0000000000 --- a/docset/winserver2012-ps/adfs/Remove-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/remove-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFSClaimsProviderTrust - -## SYNOPSIS -Removes a claims provider trust from the Federation Service. - -## SYNTAX - -### IdentifierObject -``` -Remove-ADFSClaimsProviderTrust -TargetClaimsProviderTrust [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### TokenSigningCertificates -``` -Remove-ADFSClaimsProviderTrust -TargetCertificate [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### Identifier -``` -Remove-ADFSClaimsProviderTrust -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierName -``` -Remove-ADFSClaimsProviderTrust -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-ADFSClaimsProviderTrust cmdlet removes a claims provider trust from the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFSClaimsProviderTrust -TargetName "My claims provider" -``` - -Description - ------------ - -Removes the claims provider trust named "My claims provider". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCertificate -Specifies the token-signing certificate of the claims provider trust to remove. - -```yaml -Type: X509Certificate2 -Parameter Sets: TokenSigningCertificates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimsProviderTrust -```yaml -Type: ClaimsProviderTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the claims provider trust to remove. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the claims provider trust to remove. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust -A class structure that represents a claims provider trust. - -## OUTPUTS - -### None - -## NOTES -* The claims provider collects and authenticates a user's credentials, builds up claims for that user, and packages the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to a relying party across the federation trust. - -## RELATED LINKS - -[Disable-ADFSClaimsProviderTrust](./Disable-ADFSClaimsProviderTrust.md) - -[Enable-ADFSClaimsProviderTrust](./Enable-ADFSClaimsProviderTrust.md) - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Remove-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Remove-ADFSRelyingPartyTrust.md deleted file mode 100644 index 919f74e214..0000000000 --- a/docset/winserver2012-ps/adfs/Remove-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/remove-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ADFSRelyingPartyTrust - -## SYNOPSIS -Removes a relying party trust from the Federation Service. - -## SYNTAX - -### Identifier -``` -Remove-ADFSRelyingPartyTrust -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierObject -``` -Remove-ADFSRelyingPartyTrust -TargetRelyingParty [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### IdentifierName -``` -Remove-ADFSRelyingPartyTrust -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Remove-ADFSRelyingPartyTrust cmdlet removes a relying party trust from the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-ADFSRelyingPartyTrust -TargetName "Sample App" -``` - -Description - ------------ - -Removes a relying party trust named "Sample App". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the relying party trust to remove. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the relying party trust to remove. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetRelyingParty -Specifies the relying party trust to remove. -This value is typically taken from the pipeline. - -```yaml -Type: RelyingPartyTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust -A class structure that represents a relying party trust. - -## OUTPUTS - -### None - -## NOTES -* A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server in the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - -## RELATED LINKS - -[Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) - -[Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) - -[Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Revoke-ADFSProxyTrust.md b/docset/winserver2012-ps/adfs/Revoke-ADFSProxyTrust.md deleted file mode 100644 index 482b536e4a..0000000000 --- a/docset/winserver2012-ps/adfs/Revoke-ADFSProxyTrust.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/revoke-adfsproxytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Revoke-ADFSProxyTrust - -## SYNOPSIS -Revokes trust for all federation server proxies configured for the Federation Service. - -## SYNTAX - -``` -Revoke-ADFSProxyTrust [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -Revokes trust for all federation server proxies by resetting the trust ID for the Federation Service. -This operation is provided for lockdown purposes in the event of an attack or confirmed possible threat to your deployment. -Once performed, operation effectively revokes trust to all configured proxies immediately. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Revoke-ADFSProxyTrust -``` - -Description - ------------ - -Revokes all trust between the current federation server and any of its configured federation server proxies. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* This cmdlet should only be used in the vent of a security breach in live deployment. If you wish to practice using this cmdlet, use of a test lab environment to rehearse or validate this lockdown operation is recommended. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSAttributeStore.md b/docset/winserver2012-ps/adfs/Set-ADFSAttributeStore.md deleted file mode 100644 index 64f5cbedd5..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSAttributeStore.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsattributestore?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSAttributeStore - -## SYNOPSIS -Sets the properties of the attribute store. - -## SYNTAX - -### Name -``` -Set-ADFSAttributeStore [-Name ] [-Configuration ] [-TargetName] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Set-ADFSAttributeStore [-Name ] [-Configuration ] [-TargetAttributeStore] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-ADFSAttributeStore cmdlet configures the attribute stores in the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADFSAttributeStore -TargetName 'MyCustomStore' -Configuration @("runmode" = "verbose"; configParaName2 = configParaValueNew) -``` - -Description - ------------ - -Sets configuration for a custom attribute store. - -## PARAMETERS - -### -Configuration -Specifies the initialization parameters of the attribute store, such as a connection string. - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this attribute store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAttributeStore -Specifies the attribute store that will be modified by the cmdlet. -This value is typically taken from the pipeline. - -```yaml -Type: AttributeStore -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the attribute store that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: Name -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSCertificate.md b/docset/winserver2012-ps/adfs/Set-ADFSCertificate.md deleted file mode 100644 index 63994f3e1b..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSCertificate.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfscertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSCertificate - -## SYNOPSIS -Sets the properties of an existing certificate that the Federation Service uses to sign, decrypt, or secure communications. - -## SYNTAX - -``` -Set-ADFSCertificate -CertificateType -Thumbprint [-IsPrimary] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-AdfsCertificate** cmdlet sets the properties of an existing certificate that Active Directory Federation Services (AD FS) uses to sign, decrypt, or secure communications. - -## EXAMPLES - -### Example 1: Set a certificate -``` -PS C:\>Set-AdfsCertificate -IsPrimary -CertificateType "Token-Signing" -Thumbprint ‎"fedd995b45e633d4ef30fcbc8f3a48b627e9a28b" -``` - -Description - ------------ - -Sets the primary token-signing certificate. - -## PARAMETERS - -### -CertificateType -Specifies the certificate type (that is, how the Federation Service uses the certificate). -The acceptable values for this parameter are: - -- Service-Communications -- Token-Decrypting -- Token-Signing - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Service-Communications, Token-Decrypting, Token-Signing - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPrimary -Specifies whether the certificate is primary or not. -Primary token-signing certificates are used to digitally sign outgoing claims. -Primary token-encrypting certificates are published in federation metadata for use by trusted claims providers. -Information Card signing and service communications certificates are always primary. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Thumbprint -Specifies the thumbprint of the certificate to use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ServiceCertificate -A class structure that represents a service certificate. - -## OUTPUTS - -### None - -## NOTES -* Use the **Set-AdfsRelyingPartyTrust** or **Set-AdfsClaimsProviderTrust** cmdlets, as appropriate, to modify the certificates that are associated with a relying party or a claims provider. - -## RELATED LINKS - -[Add-ADFSCertificate](./Add-ADFSCertificate.md) - -[Get-ADFSCertificate](./Get-ADFSCertificate.md) - -[Remove-ADFSCertificate](./Remove-ADFSCertificate.md) - -[Update-ADFSCertificate](./Update-ADFSCertificate.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSClaimDescription.md b/docset/winserver2012-ps/adfs/Set-ADFSClaimDescription.md deleted file mode 100644 index 0685f9419b..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSClaimDescription.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsclaimdescription?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSClaimDescription - -## SYNOPSIS -Sets the properties of an existing claim description. - -## SYNTAX - -### Name -``` -Set-ADFSClaimDescription [-IsAccepted ] [-IsOffered ] [-IsRequired ] - [-Notes ] [-Name ] [-ClaimType ] [-TargetName] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### Identifier -``` -Set-ADFSClaimDescription [-IsAccepted ] [-IsOffered ] [-IsRequired ] - [-Notes ] [-Name ] [-ClaimType ] [-TargetClaimType] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### InputObject -``` -Set-ADFSClaimDescription [-IsAccepted ] [-IsOffered ] [-IsRequired ] - [-Notes ] [-Name ] [-ClaimType ] [-TargetClaimDescription] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-ADFSClaimDescription cmdlet sets properties on an existing AD FS claim description. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADFSClaimDescription -TargetName "Role" -Name "New Role Claim Name" -``` - -Description - ------------ - -Sets a new name for the "Role" claim description. - -## PARAMETERS - -### -ClaimType -Specifies the claim type URI of the claim. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsAccepted -Specifies that the claim should be published in federation metadata as a claim that is accepted by the federation service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsOffered -Specifies that the claim should be published in federation metadata as a claim that is offered by the federation service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsRequired -Specifies that the claim should be published in federation metadata as a claim that is required by the federation service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this claim. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies any notes for this claim description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetClaimDescription -Specifies the claim description that will be modified by the cmdlet. -This value is typically taken from the pipeline. - -```yaml -Type: ClaimDescription -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimType -Specifies the claim type of the claim description that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the friendly name of the claim description that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: Name -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimDescription -A class structure for representing a claim description object for the Federation Service. - -## OUTPUTS - -### None - -## NOTES -* All Set-* cmdlets have a positional parameter (at position 0) with a name that starts with Target*. This parameter defines the search criteria (and the parameter set). For example, Set-ADFSRelyingParty has the parameters TargetName, TargetIdentifierUri, and TargetRelyingParty. You can use only one of these Target* parameters to identify which RelyingParty will be modified. Because these parameters are positional, their name does not have be specified. Therefore, the following commands are identical in effect. - -Changes the RelyingParty object whose name is RP1, setting its name to RP2 Set-ADFSRelyingParty -TargetName RP1Name -Name RP2Name OR Set-ADFSRelyingParty RP1Name -Name RP2Name - -## RELATED LINKS - -[Add-ADFSClaimDescription](./Add-ADFSClaimDescription.md) - -[Get-ADFSClaimDescription](./Get-ADFSClaimDescription.md) - -[Remove-ADFSClaimDescription](./Remove-ADFSClaimDescription.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Set-ADFSClaimsProviderTrust.md deleted file mode 100644 index 24d470ed28..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,599 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSClaimsProviderTrust - -## SYNOPSIS -Sets the properties of a claims provider trust. - -## SYNTAX - -### IdentifierObject -``` -Set-ADFSClaimsProviderTrust [-Name ] [-Identifier ] [-SignatureAlgorithm ] - [-TokenSigningCertificate ] [-MetadataUrl ] [-AcceptanceTransformRules ] - [-AcceptanceTransformRulesFile ] [-AllowCreate ] [-AutoUpdateEnabled ] - [-WSFedEndpoint ] [-EncryptionCertificate ] - [-EncryptionCertificateRevocationCheck ] [-MonitoringEnabled ] [-Notes ] - [-ClaimOffered ] [-SamlEndpoint ] [-ProtocolProfile ] - [-RequiredNameIdFormat ] [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SigningCertificateRevocationCheck ] - -TargetClaimsProviderTrust [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### TokenSigningCertificates -``` -Set-ADFSClaimsProviderTrust [-Name ] [-Identifier ] [-SignatureAlgorithm ] - [-TokenSigningCertificate ] [-MetadataUrl ] [-AcceptanceTransformRules ] - [-AcceptanceTransformRulesFile ] [-AllowCreate ] [-AutoUpdateEnabled ] - [-WSFedEndpoint ] [-EncryptionCertificate ] - [-EncryptionCertificateRevocationCheck ] [-MonitoringEnabled ] [-Notes ] - [-ClaimOffered ] [-SamlEndpoint ] [-ProtocolProfile ] - [-RequiredNameIdFormat ] [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SigningCertificateRevocationCheck ] - -TargetCertificate [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### Identifier -``` -Set-ADFSClaimsProviderTrust [-Name ] [-Identifier ] [-SignatureAlgorithm ] - [-TokenSigningCertificate ] [-MetadataUrl ] [-AcceptanceTransformRules ] - [-AcceptanceTransformRulesFile ] [-AllowCreate ] [-AutoUpdateEnabled ] - [-WSFedEndpoint ] [-EncryptionCertificate ] - [-EncryptionCertificateRevocationCheck ] [-MonitoringEnabled ] [-Notes ] - [-ClaimOffered ] [-SamlEndpoint ] [-ProtocolProfile ] - [-RequiredNameIdFormat ] [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SigningCertificateRevocationCheck ] - -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierName -``` -Set-ADFSClaimsProviderTrust [-Name ] [-Identifier ] [-SignatureAlgorithm ] - [-TokenSigningCertificate ] [-MetadataUrl ] [-AcceptanceTransformRules ] - [-AcceptanceTransformRulesFile ] [-AllowCreate ] [-AutoUpdateEnabled ] - [-WSFedEndpoint ] [-EncryptionCertificate ] - [-EncryptionCertificateRevocationCheck ] [-MonitoringEnabled ] [-Notes ] - [-ClaimOffered ] [-SamlEndpoint ] [-ProtocolProfile ] - [-RequiredNameIdFormat ] [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] - [-SamlAuthenticationRequestIndex ] [-SamlAuthenticationRequestParameters ] - [-SamlAuthenticationRequestProtocolBinding ] [-SigningCertificateRevocationCheck ] - -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-ADFSClaimsProviderTrust cmdlet configures the trust relationship with a claims provider. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADFSClaimsProviderTrust -TargetName "My claims provider" -AutoUpdateEnabled $false -``` - -Description - ------------ - -Enables auto-update for the claims provider trust. - -## PARAMETERS - -### -AcceptanceTransformRules -Specifies the claim acceptance transform rules for accepting claims from this claims provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AcceptanceTransformRulesFile -Specifies a file that contains the claim acceptance transform rules for accepting claims from this claims provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCreate -Specifies whether the SAML parameter AllowCreate should be sent in SAML requests to the claims provider. -By default, this parameter is true. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoUpdateEnabled -Specifies whether changes to the federation metadata at the MetadataURL that is being monitored are automatically applied to the configuration of the trust relationship. -Partner claims, certificates, and endpoints are updated automatically if this parameter is enabled (true). - -Note: When auto-update is enabled, fields that can be overwritten by metadata become read only. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClaimOffered -Specifies the claims that are offered by this claims provider. - -```yaml -Type: ClaimDescription[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedNameIdRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificate -Specifies the certificate to be used for encrypting a NameID to this claims provider in SAML logout requests. -Encrypting the NameID is optional. - -```yaml -Type: X509Certificate2 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificateRevocationCheck -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identifier -Specifies the unique identifier for this claims provider trust. -No other trust may use an identifier from this list. -Uniform Resource Identifiers (URIs) are often used as unique identifiers for a claims provider trust, but any string of characters may be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataUrl -Specifies the URL at which the federation metadata for this claims provider trust is available. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringEnabled -Specifies whether periodic monitoring of this claims provider's federation metadata is enabled. -The URL of the claims provider's federation metadata is specified by the MetadataUrl parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this claims provider trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies any notes for this claims provider trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtocolProfile -This parameter controls which protocol profiles the claims provider supports. -It must be set to one of the following recognized strings: {SAML, WsFederation, WsFed-SAML}. -By default, both SAML and WS-Federation protocols are supported (WsFed-SAML). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WsFed-SAML, WSFederation, SAML - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequiredNameIdFormat -Specifies the format that is required for NameID claims to be included in SAML requests to the claims provider. -By default, no format is required. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlAuthenticationRequestIndex -Specifies the value of AssertionConsumerServiceIndex that will be placed in SAML authentication requests that are sent to the claims provider. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlAuthenticationRequestParameters -Specifies which of the parameters (AssertionConsumerServiceIndex, AssertionConsumerServiceUrl, ProtocolBinding) will be used in SAML authentication requests to the claims provider. -Specify a value from the following set: {None, Index, Url, ProtocolBinding, UrlWithProtocolBinding}. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Index, None, , ProtocolBinding, Url, UrlWithProtocolBinding - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlAuthenticationRequestProtocolBinding -Specifies the value of ProtocolBinding that will be placed in SAML authentication requests to the claims provider. -Use values from the following set: {Artifact, Post, Redirect}. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Artifact, , POST, Redirect - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlEndpoint -Specifies the SAML protocol endpoints for this claims provider. - -```yaml -Type: SamlEndpoint[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SignatureAlgorithm -Specifies the signature algorithm that the claims provider uses for signing and verification. -Valid values are as follows: - -http://www.w3.org/2000/09/xmldsig#rsa-sha1 - -http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignedSamlRequestsRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateRevocationCheck -Specifies the type of certificate validation that should occur when signatures are verified on responses or assertions from the claims provider. -Valid values are None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCertificate -Specifies the certificate of the claims provider trust that will be modified by the cmdlet. - -```yaml -Type: X509Certificate2 -Parameter Sets: TokenSigningCertificates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimsProviderTrust -```yaml -Type: ClaimsProviderTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the claims provider trust that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the friendly name of the claims provider trust that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TokenSigningCertificate -Specifies the token-signing certificates that the claims provider uses. - -```yaml -Type: X509Certificate2[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WSFedEndpoint -Specifies the WS-Federation Passive URL for this claims provider. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust -A class structure that represents a claims provider trust. - -## OUTPUTS - -### None - -## NOTES -* The claims provider collects and authenticates a user's credentials, builds up claims for that user, and packages the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to a relying party across the federation trust. - -## RELATED LINKS - -[Disable-ADFSClaimsProviderTrust](./Disable-ADFSClaimsProviderTrust.md) - -[Enable-ADFSClaimsProviderTrust](./Enable-ADFSClaimsProviderTrust.md) - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Remove-ADFSClaimsProviderTrust](./Remove-ADFSClaimsProviderTrust.md) - -[Update-ADFSClaimsProviderTrust](./Update-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSConfiguration.md b/docset/winserver2012-ps/adfs/Set-ADFSConfiguration.md deleted file mode 100644 index b5ebaabd50..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSConfiguration.md +++ /dev/null @@ -1,640 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSConfiguration - -## SYNOPSIS -Sets the configuration properties of the Federation Service. - -## SYNTAX - -``` -Set-ADFSConfiguration [-AuthenticationContextOrder ] [-AcceptableIdentifiers ] - [-AddProxyAuthorizationRules ] [-ArtifactDbConnection ] [-AutoCertificateRollover ] - [-CertificateCriticalThreshold ] [-CertificateDuration ] - [-CertificateGenerationThreshold ] [-CertificatePromotionThreshold ] - [-CertificateRolloverInterval ] [-CertificateThresholdMultiplier ] - [-ClientCertRevocationCheck ] [-ContactPerson ] [-DisplayName ] - [-FederationPassiveAddress ] [-HostName ] [-HttpPort ] [-HttpsPort ] - [-Identifier ] [-LogLevel ] [-MonitoringInterval ] [-NetTcpPort ] - [-NtlmOnlySupportedClientAtProxy ] [-OrganizationInfo ] - [-PreventTokenReplays ] [-ExtendedProtectionTokenCheck ] [-ProxyTrustTokenLifetime ] - [-ReplayCacheExpirationInterval ] [-SignedSamlRequestsRequired ] - [-SamlMessageDeliveryWindow ] [-SignSamlAuthnRequests ] [-SsoLifetime ] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-ADFSConfiguration cmdlet sets the global properties and configuration of the Federation Service. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Set-ADFSConfiguration -DisplayName "Fabrikam STS" -Identifier "https://fabrikam.com" -``` - -Sets the identifier for the Federation Service named "Fabrikam STS". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -PS C:\>Set-ADFSProperties -HttpPort 8123 -``` - -Sets the HTTP port to 8123. - -Before restarting the Federation service, update the ACLs for the corresponding endpoint URLs to ensure that the service can be restarted successfully using the new port numbers. -For example, use a Netsh command similar to the following example to add the required ACL for the updated URL. - -`netsh http addurlacl url=http://+:8123/adfs/services/ -user "Network Service"` - -## PARAMETERS - -### -AcceptableIdentifiers -Specifies identifiers that are acceptable names for the Federation Service when it checks the audience for claims that it receives from another claims provider. - -```yaml -Type: Uri[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddProxyAuthorizationRules -Specifies a policy rule set that can be used to establish authorization permissions for setting up trust proxies. -The default value allows the AD FS service user account or any member of BUILTIN\Administrators to register a federation server proxy with the Federation Service. -Modifying this property should only be done if you want to enable another account beyond those accounts authorized by default to enable federation server proxies. -If the authorization rules you add are configured incorrectly, you can potentially disable registering new proxies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ArtifactDbConnection -Specifies the connection string to use for the database that maintains the artifacts that the artifact resolution service uses. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationContextOrder -Specifies a list of authentication contexts, in order by relative strength. -Each authentication context must be a URI. - -```yaml -Type: Uri[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoCertificateRollover -Specifies whether the system will manage certificates for the administrator and generate new certificates before the expiration date of current certificates. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateCriticalThreshold -Specifies the period of time (in days) before a current primary signing or decryption certificate expires. -When this threshold occurs, the Federation Service initiates the auto-rollover service, generates a new certificate, and promotes it to be the primary certificate. -This rollover process occurs even if the critical threshold interval does not provide sufficient time for partners to replicate the new metadata. -This should be a short period of time that is used only in extreme conditions when the Federation Service has not been able to generate a new certificate in advance. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateDuration -Specifies the period of time (in days) that any certificates that the Federation Service generates remain valid. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateGenerationThreshold -Specifies the period of time (in days) before a new primary certificate is generated to replace the current primary certificate. -When this threshold occurs, the Federation Service initiates an auto-rollover process that generates a new certificate and adds it to the secondary collection. -This rollover process occurs so that federation partners can consume this metadata in advance and trust is not broken when this newly generated certificate is promoted to be a primary certificate. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificatePromotionThreshold -Specifies the period of time (in days) during which a newly generated certificate remains a secondary certificate before being promoted to be the primary certificate. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateRolloverInterval -Specifies the certificate rollover interval (in minutes). -This value determines the frequency at which the Federation Service initiates the rollover service by polling to check whether new certificates need to be generated. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThresholdMultiplier -Specifies the certificate threshold multiplier. -By default, this parameter uses the number of minutes in a day (1440) as a multiplier. -This should be changed only if you want to use a more finely detailed measure of time (such as less than a single day) for calculating the time periods for other certificate threshold parameters in this cmdlet. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientCertRevocationCheck -Specifies the type of validation that should occur for the client encryption certificate before it is used for decrypting claims from a claims provider. -Valid values are None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContactPerson -Specifies contact information for support. - -```yaml -Type: ContactPerson -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the friendly name for this Federation Service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtendedProtectionTokenCheck -Specifies the level of extended protection for authentication supported by the federation server. -Extended Protection for Authentication helps protect against man-in-the-middle (MITM) attacks, in which an attacker intercepts a client's credentials and forwards them to a server. -Protection against such attacks is made possible through a Channel Binding Token (CBT) which can be either required, allowed or not required by the server when establishing communications with clients. - -Possible values for this setting are: as follows "Require" (server is full hardened, extended protection is enforced), "Allow" (server is partially hardened, extended protection is enforced where systems involved have been patched to support it) and "None" (Server is vulnerable, extended protection is not enforced). -The default setting is "Allow". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Allow, Require, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FederationPassiveAddress -Specifies the relative address for the federation passive virtual directory. -By default, /adfs/ls/ address is configured by the AD FS 2.0 Federation Server Configuration Wizard. -If you need to change this value, change this value only after you modify the Internet Information Services (IIS) virtual directory on all federation servers in the Federation Service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the network addressable host name of the Federation Service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPort -Specifies the HTTP port for the server. - -If you use this parameter to modify the HTTP port number you also need to manually reset ACLs on the HTTP endpoint URL used by the Federation service. -For more information, see Example 2 below. - -By default, the federation server proxy service is configured to use TCP port 80 for HTTP traffic for communication with the federation server. -To configure alternate ports, such as port 81 for HTTP, see the topic "Configuring an Alternate TCP/IP Port for Proxy Operations" in the AD FS Deployment Guide. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsPort -Specifies the HTTPS port for the server. - -By default, the federation server proxy service is configured to use TCP port 443 for HTTPS traffic for communication with the federation server. -To configure alternate ports, such as TCP port 444 for HTTPS, see the topic "Configuring an Alternate TCP/IP Port for Proxy Operations" in the AD FS Deployment Guide. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identifier -Specifies the URI that uniquely identifies the Federation Service. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the level of logging detail. -The list defines which types of events are logged. - -Possible values are Errors, Warnings, Information, SuccessAudits, and FailureAudits. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: Errors, FailureAudits, Information, Verbose, None, SuccessAudits, Warnings - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringInterval -Specifies how often the Federation Service will monitor the federation metadata of relying parties and claims providers (in minutes) that are enabled for federation metadata monitoring. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetTcpPort -Specifies the TCP port for the server. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NtlmOnlySupportedClientAtProxy -Used to enable support for NTLM-based authentication in situations where the active federation server proxy does not support Negotiate method of authentication. -This setting only affects the Windows transport endpoint. -If this value is changed, the federation server proxy needs to be restarted. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OrganizationInfo -Specifies information about the organization as published in the federation metadata for the Federation Service. - -```yaml -Type: Organization -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes the newly extended AD FS configuration object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventTokenReplays -Specifies whether the Federation Service is configured to prevent the replay of security tokens. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyTrustTokenLifetime -Sets the valid token lifetime for proxy trust tokens (in minutes). -This value is used by the federation server proxy to authenticate with its associated federation server. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplayCacheExpirationInterval -Specifies the cache duration for token replay detection (in minutes). -This value determines the lifetime in the replay cache for tokens. -When the age of a cached token exceeds this interval, the Federation Service determines the token has expired and does not allow replay of it. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SamlMessageDeliveryWindow -Specifies the duration for which the SAML messages that the Federation Service sends should be considered valid (in minutes). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignSamlAuthnRequests -Indicates whether the Federation Service will sign SAML protocol authentication requests to claims providers. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignedSamlRequestsRequired -Specifies whether the Federation Service indicates in its federation metadata that it requires signed SAML protocol authentication requests. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SsoLifetime -Specifies the duration of the single sign-on (SSO) experience for Web browser clients (in minutes). - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-ADFSConfiguration](./Get-ADFSConfiguration.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSEndpoint.md b/docset/winserver2012-ps/adfs/Set-ADFSEndpoint.md deleted file mode 100644 index 6546a5bea7..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSEndpoint.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsendpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSEndpoint - -## SYNOPSIS -Sets the properties of a Federation Service endpoint. - -## SYNTAX - -### Address -``` -Set-ADFSEndpoint [[-TargetAddressPath] ] -Proxy [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### TargetObject -``` -Set-ADFSEndpoint -TargetEndpoint -Proxy [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -### FullUrl -``` -Set-ADFSEndpoint [-TargetFullUrl] -Proxy [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-ADFSEndpoint cmdlet can be used to enable and disable endpoints on the federation server proxy. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADFSEndpoint -TargetAddress /adfs/services/trust/13/Windows -Proxy $true -``` - -Description - ------------ - -Enables the WS-Trust 1.3 endpoint for proxy use. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Proxy -Specifies whether the endpoint is available on the federation server proxy. -This is the only field of the endpoint that can be set. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetAddressPath -```yaml -Type: String -Parameter Sets: Address -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetEndpoint -Specifies the endpoint that will be modified by the cmdlet. -his value is typically taken from the pipeline. - -```yaml -Type: Endpoint -Parameter Sets: TargetObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetFullUrl -Specifies the full URL of the endpoint that will be modified by the cmdlet. - -```yaml -Type: Uri -Parameter Sets: FullUrl -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.Endpoint -A class structure that represents an endpoint. - -## OUTPUTS - -### None - -## NOTES -* This cmdlet has three parameter-sets. You can use Address, FullUrl, or TargetEndpoint (over the pipeline) to identify the endpoint. Set-ADFSEndpoint only allows you to modify the Proxy property of the endpoint. - - Endpoints provide access to the federation server functionality of Active Directory Federation Services (AD FS) 2.0, such as token issuance, Information Card issuance, and the publishing of federation metadata. -Depending on the type of endpoint, you can enable or disable the endpoint or control whether the endpoint is published to AD FS 2.0 proxies. - -## RELATED LINKS - -[Disable-ADFSEndpoint](./Disable-ADFSEndpoint.md) - -[Enable-ADFSEndpoint](./Enable-ADFSEndpoint.md) - -[Get-ADFSEndpoint](./Get-ADFSEndpoint.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSProxyConfiguration.md b/docset/winserver2012-ps/adfs/Set-ADFSProxyConfiguration.md deleted file mode 100644 index bc12041e66..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSProxyConfiguration.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsproxyconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSProxyConfiguration - -## SYNOPSIS -Sets the configuration properties of the federation server proxy. - -## SYNTAX - -``` -Set-ADFSProxyConfiguration [-HostName ] [-HttpPort ] [-HttpsPort ] [-LogLevel ] - [-ForwardProxyUrl ] [-ProxyTrustRenewPeriod ] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Set-ADFSProxyConfiguration cmdlet changes the properties of a federation server proxy that has been previously configured. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Set-ADFSProxyProperties -Hostname "fs.fabrikam.com" -``` - -Sets the properties for the federation server proxy with the name "fs.fabrikam.com". - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForwardProxyUrl -Specifies the URL of a forward proxy to use for communication to the federation service, if any. -By default, there is no forward proxy configured. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostName -Specifies the network addressable host name of the Federation Service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpPort -Specifies the HTTP port for the server. -The default value is 80. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HttpsPort -Specifies the HTTPS port for the server. -The default value is 443. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the level of logging detail. -The list defines which types of events are logged. - -Possible values are Errors, Warnings, Information, SuccessAudits, and FailureAudits. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: -Accepted values: Errors, FailureAudits, Information, Verbose, None, SuccessAudits, Warnings - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProxyTrustRenewPeriod -Sets the interval (in minutes) that the federation server proxy uses to check with its associated federation server for updated trust tokens. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* This cmdlet may be used only on a computer that is configured in Active Directory Federation Services (AD FS) as a federation server proxy. It will not work on a federation server. - -## RELATED LINKS - -[Get-ADFSProxyConfiguration](./Get-ADFSProxyConfiguration.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Set-ADFSRelyingPartyTrust.md deleted file mode 100644 index b23ecad133..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,666 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSRelyingPartyTrust - -## SYNOPSIS -Sets the properties of a relying party trust. - -## SYNTAX - -### Identifier -``` -Set-ADFSRelyingPartyTrust [-Name ] [-NotBeforeSkew ] [-Identifier ] - [-EncryptionCertificate ] [-EncryptionCertificateRevocationCheck ] - [-EncryptClaims ] [-MetadataUrl ] [-IssuanceAuthorizationRules ] - [-IssuanceAuthorizationRulesFile ] [-DelegationAuthorizationRules ] - [-DelegationAuthorizationRulesFile ] [-ImpersonationAuthorizationRules ] - [-ImpersonationAuthorizationRulesFile ] [-IssuanceTransformRules ] - [-IssuanceTransformRulesFile ] [-AutoUpdateEnabled ] [-WSFedEndpoint ] - [-MonitoringEnabled ] [-Notes ] [-ClaimAccepted ] - [-SamlEndpoint ] [-ProtocolProfile ] [-RequestSigningCertificate ] - [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] [-SamlResponseSignature ] - [-SignatureAlgorithm ] [-SigningCertificateRevocationCheck ] [-TokenLifetime ] - -TargetIdentifier [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierObject -``` -Set-ADFSRelyingPartyTrust [-Name ] [-NotBeforeSkew ] [-Identifier ] - [-EncryptionCertificate ] [-EncryptionCertificateRevocationCheck ] - [-EncryptClaims ] [-MetadataUrl ] [-IssuanceAuthorizationRules ] - [-IssuanceAuthorizationRulesFile ] [-DelegationAuthorizationRules ] - [-DelegationAuthorizationRulesFile ] [-ImpersonationAuthorizationRules ] - [-ImpersonationAuthorizationRulesFile ] [-IssuanceTransformRules ] - [-IssuanceTransformRulesFile ] [-AutoUpdateEnabled ] [-WSFedEndpoint ] - [-MonitoringEnabled ] [-Notes ] [-ClaimAccepted ] - [-SamlEndpoint ] [-ProtocolProfile ] [-RequestSigningCertificate ] - [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] [-SamlResponseSignature ] - [-SignatureAlgorithm ] [-SigningCertificateRevocationCheck ] [-TokenLifetime ] - -TargetRelyingParty [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### IdentifierName -``` -Set-ADFSRelyingPartyTrust [-Name ] [-NotBeforeSkew ] [-Identifier ] - [-EncryptionCertificate ] [-EncryptionCertificateRevocationCheck ] - [-EncryptClaims ] [-MetadataUrl ] [-IssuanceAuthorizationRules ] - [-IssuanceAuthorizationRulesFile ] [-DelegationAuthorizationRules ] - [-DelegationAuthorizationRulesFile ] [-ImpersonationAuthorizationRules ] - [-ImpersonationAuthorizationRulesFile ] [-IssuanceTransformRules ] - [-IssuanceTransformRulesFile ] [-AutoUpdateEnabled ] [-WSFedEndpoint ] - [-MonitoringEnabled ] [-Notes ] [-ClaimAccepted ] - [-SamlEndpoint ] [-ProtocolProfile ] [-RequestSigningCertificate ] - [-EncryptedNameIdRequired ] [-SignedSamlRequestsRequired ] [-SamlResponseSignature ] - [-SignatureAlgorithm ] [-SigningCertificateRevocationCheck ] [-TokenLifetime ] - -TargetName [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Set-ADFSRelyingParty cmdlet configures the trust relationship with a specified relying party object. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-ADFSRelyingPartyTrust -TargetName SampleApp -Identifier http://SampleApp.SampleServerNew.org -``` - -Description - ------------ - -Sets the name and identifier for the specified relying party trust. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-ADFSRelyingPartyTrust -TargetIdentifier http://SampleApp.SampleServer.org -Identifier http://SampleApp.SampleServerNew.org -``` - -Description - ------------ - -Sets the target identifier for the specified relying party trust. - -## PARAMETERS - -### -AutoUpdateEnabled -Specifies whether changes to the federation metadata at the MetadataURL that is being monitored are automatically applied to the configuration of the trust relationship. -Partner claims, certificates, and endpoints are automatically updated if this parameter is enabled (true). - -Note: When auto-update is enabled, fields that can be overwritten by metadata become read only. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClaimAccepted -Specifies the claims that this relying party accepts. - -```yaml -Type: ClaimDescription[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegationAuthorizationRules -Specifies the delegation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DelegationAuthorizationRulesFile -Specifies a file that contains the delegation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptClaims -Specifies whether the claims that are sent to the relying party should be encrypted. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptedNameIdRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificate -Specifies the certificate to be used for encrypting claims that are issued to this relying party. -Encrypting claims is optional. - -```yaml -Type: X509Certificate2 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionCertificateRevocationCheck -Specifies the type of validation that should occur for the encryption certificate before it is used for encrypting claims to the relying party. -Valid values are None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identifier -Specifies the unique identifiers for this relying party trust. -No other trust may use an identifier from this list. -Uniform Resource Identifiers (URIs) are often used as unique identifiers for a relying party trust, but any string of characters may be used. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ImpersonationAuthorizationRules -Specifies the impersonation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImpersonationAuthorizationRulesFile -Specifies a file that containis the impersonation authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssuanceAuthorizationRules -Specifies the issuance authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuanceAuthorizationRulesFile -Specifies a file that contains the issuance authorization rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IssuanceTransformRules -Specifies the issuance transform rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IssuanceTransformRulesFile -Specifies a file that contains the issuance transform rules for issuing claims to this relying party. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataUrl -Specifies a URL at which the federation metadata for this relying party trust is available. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringEnabled -Specifies whether periodic monitoring of this relying party's federation metadata is enabled. -The URL of the relying party's federation metadata is specified by the MetadataUrl parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of this relying party trust. - -Note: You can use the Name parameter as an identifier for the object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NotBeforeSkew -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies any notes for this relying party trust. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProtocolProfile -This parameter controls which protocol profiles the relying party supports. -The protocol can be one of the following: {SAML, WsFederation}. -By default, this parameter is blank, which indicates that both protocols are supported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: WsFed-SAML, WSFederation, SAML - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestSigningCertificate -Specifies the certificate that is used to verify the signature on a request from the relying party. - -```yaml -Type: X509Certificate2[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SamlEndpoint -Specifies the SAML protocol endpoints for this relying party. - -```yaml -Type: SamlEndpoint[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SamlResponseSignature -Specifies the response signatures that the relying party expects. -Valid values are AssertionOnly, MessageAndAssertion, and MessageOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: AssertionOnly, MessageAndAssertion, MessageOnly - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignatureAlgorithm -Specifies the signature algorithm that the relying party uses for signing and verification. -Valid values are as follows: - -http://www.w3.org/2000/09/xmldsig#rsa-sha1 - -http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignedSamlRequestsRequired -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SigningCertificateRevocationCheck -Specifies the type of certificate validation that should occur when signatures on requests from the relying party are verified. -Valid values are None, CheckEndCert, CheckEndCertCacheOnly, CheckChain, CheckChainCacheOnly, CheckChainExcludingRoot, and CheckChainExcludingRootCacheOnly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CheckChain, CheckChainCacheOnly, CheckChainExcludeRoot, CheckChainExcludeRootCacheOnly, CheckEndCert, CheckEndCertCacheOnly, None - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the relying party trust that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the friendly name of the relying party trust that will be modified by the cmdlet. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetRelyingParty -Specifies the relying party trust that will be modified by the cmdlet. -This value is typically taken from the pipeline. - -```yaml -Type: RelyingPartyTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TokenLifetime -Specifies the duration (in minutes) for which the claims that are issued to the relying party are valid. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WSFedEndpoint -Specifies the WS-Federation Passive URL for this relying party. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust -A class structure that represents a relying party trust. - -## OUTPUTS - -### None - -## NOTES -* A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - -## RELATED LINKS - -[Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) - -[Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) - -[Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) - -[Update-ADFSRelyingPartyTrust](./Update-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Set-ADFSSyncConfiguration.md b/docset/winserver2012-ps/adfs/Set-ADFSSyncConfiguration.md deleted file mode 100644 index 04c15d14ad..0000000000 --- a/docset/winserver2012-ps/adfs/Set-ADFSSyncConfiguration.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/set-adfssyncconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ADFSSyncConfiguration - -## SYNOPSIS -Sets the configuration properties of the database synchronization engine for the federation server farm. - -## SYNTAX - -``` -Set-ADFSSyncConfiguration [-PrimaryComputerName ] [-PrimaryComputerPort ] - [-PollDuration ] [-Role ] [] -``` - -## DESCRIPTION -The Set-ADFSSyncConfiguration cmdlet changes the frequency of AD FS configuration database synchronization. -It also specifies which federation server is the primary federation server in the federation server farm - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Set-ADFSSyncConfiguration -PrimaryComputerName fs1.fabrikam.com -``` - -Sets the name of the primary federation server in a federation server farm. - -## PARAMETERS - -### -PollDuration -Specifies (in seconds) how often the AD FS configuration database is synchronized from the primary federation server. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryComputerName -Specifies the name of the primary federation server in the federation server farm. -Settings for the Federation Service may be modified on the primary federation server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryComputerPort -Specifies the TCP port to use on the primary computer in the federation service farm. -Settings for the federation service may be modified on the primary computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Role -Specifies whether this federation server is the primary federation server or a secondary federation server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* This cmdlet is for use when working with server computers as part of a federation server farm. - -## RELATED LINKS - -[Get-ADFSSyncConfiguration](./Get-ADFSSyncConfiguration.md) - diff --git a/docset/winserver2012-ps/adfs/Update-ADFSCertificate.md b/docset/winserver2012-ps/adfs/Update-ADFSCertificate.md deleted file mode 100644 index 64e03ec91d..0000000000 --- a/docset/winserver2012-ps/adfs/Update-ADFSCertificate.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/update-adfscertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ADFSCertificate - -## SYNOPSIS -Updates the certificates of the Federation Service. - -## SYNTAX - -``` -Update-ADFSCertificate [[-CertificateType] ] [-Urgent] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Update-ADFSCertificate cmdlet creates new certificates for the Federation Service. -When automatic certificate rollover is enabled and Active Directory Federation Services (AD FS) 2.0 is managing the certificates that are used for signing, this update cmdlet can be used to initiate a rollover. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Update-ADFSCertificate -CertificateType Token-Signing -``` - -Description - ------------ - -Updates the token-signing certificate. - -## PARAMETERS - -### -CertificateType -Indicates the type of certificate to rollover. -Valid types include Token-Encryption and Token-Signing. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Token-Decrypting, Token-Signing - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Urgent -Specifies that the certificate rollover should happen immediately. -An urgent rollover removes older certificates immediately. -It might result in a service outage as trusts update to use the new certificates. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* The Urgent parameter option is useful for emergency rollover situations in which a key might be compromised. - -## RELATED LINKS - -[Add-ADFSCertificate](./Add-ADFSCertificate.md) - -[Remove-ADFSCertificate](./Remove-ADFSCertificate.md) - diff --git a/docset/winserver2012-ps/adfs/Update-ADFSClaimsProviderTrust.md b/docset/winserver2012-ps/adfs/Update-ADFSClaimsProviderTrust.md deleted file mode 100644 index 3a86bba461..0000000000 --- a/docset/winserver2012-ps/adfs/Update-ADFSClaimsProviderTrust.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/update-adfsclaimsprovidertrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ADFSClaimsProviderTrust - -## SYNOPSIS -Updates the claims provider trust from federation metadata. - -## SYNTAX - -### IdentifierObject -``` -Update-ADFSClaimsProviderTrust [-MetadataFile ] -TargetClaimsProviderTrust - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### TokenSigningCertificates -``` -Update-ADFSClaimsProviderTrust [-MetadataFile ] -TargetCertificate [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### Identifier -``` -Update-ADFSClaimsProviderTrust [-MetadataFile ] -TargetIdentifier [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### IdentifierName -``` -Update-ADFSClaimsProviderTrust [-MetadataFile ] -TargetName [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Update-ADFSClaimsProviderTrust cmdlet updates the claims provider trust from federation metadata that is available at the federation metadata URL of the claims provider. -This cmdlet updates claims, endpoints, and certificates. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Update-ADFSClaimsProviderTrust -TargetName "My claims provider" -Identifier https://contoso.com/adfs/ls/ -``` - -Description - ------------ - -Update the identifier for an existing claims provider trust. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataFile -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetCertificate -Specifies the token-signing certificate of the claims provider trust to update. - -```yaml -Type: X509Certificate2 -Parameter Sets: TokenSigningCertificates -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetClaimsProviderTrust -```yaml -Type: ClaimsProviderTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the claims provider trust to update. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the claims provider trust to update. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.ClaimsProviderTrust -A class structure that represents a claims provider trust. - -## OUTPUTS - -### None - -## NOTES -* The claims provider collects and authenticates a user's credentials, builds up claims for that user, and packages the claims into security tokens or Information Cards. In other words, a claims provider represents the organization for whose users the claims provider issues security tokens or Information Cards on their behalf. When you configure Active Directory Federation Services (AD FS) 2.0 to use federation services, the role of the claims provider is to enable its users to access resources that are hosted in a relying party organization by establishing one side of a federation trust relationship. After the trust is established, tokens and Information Cards can be presented to a relying party across the federation trust. - -## RELATED LINKS - -[Get-ADFSClaimsProviderTrust](./Get-ADFSClaimsProviderTrust.md) - -[Set-ADFSClaimsProviderTrust](./Set-ADFSClaimsProviderTrust.md) - diff --git a/docset/winserver2012-ps/adfs/Update-ADFSRelyingPartyTrust.md b/docset/winserver2012-ps/adfs/Update-ADFSRelyingPartyTrust.md deleted file mode 100644 index 408c2f62a3..0000000000 --- a/docset/winserver2012-ps/adfs/Update-ADFSRelyingPartyTrust.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.IdentityServer.PowerShell.dll-Help.xml -Module Name: ADFS -online version: https://learn.microsoft.com/powershell/module/adfs/update-adfsrelyingpartytrust?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ADFSRelyingPartyTrust - -## SYNOPSIS -Updates the relying party trust from federation metadata. - -## SYNTAX - -### Identifier -``` -Update-ADFSRelyingPartyTrust [-MetadataFile ] -TargetIdentifier [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### IdentifierObject -``` -Update-ADFSRelyingPartyTrust [-MetadataFile ] -TargetRelyingParty [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### IdentifierName -``` -Update-ADFSRelyingPartyTrust [-MetadataFile ] -TargetName [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Update-ADFSRelyingPartyTrust cmdlet updates the relying party trust from the federation metadata that is available at the federation metadata URL. -This cmdlet updates claims, endpoints, and certificates. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Update-ADFSRelyingPartyTrust -TargetName "Sample App" -``` - -Description - ------------ - -Updates a relying party trust object. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MetadataFile -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Passes an object to the pipeline. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIdentifier -Specifies the identifier of the relying party trust to update. - -```yaml -Type: String -Parameter Sets: Identifier -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the relying party trust to update. - -```yaml -Type: String -Parameter Sets: IdentifierName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetRelyingParty -Specifies the relying party trust to update. -This value is typically taken from the pipeline. - -```yaml -Type: RelyingPartyTrust -Parameter Sets: IdentifierObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.IdentityServer.PowerShell.Resources.RelyingPartyTrust -A class structure that represents a relying party trust. - -## OUTPUTS - -### None - -## NOTES -* A relying party in Active Directory Federation Services (AD FS) 2.0 is an organization in which Web servers that host one or more Web-based applications reside. Tokens and Information Cards that originate from a claims provider can then be presented and ultimately consumed by the Web-based resources that are located in the relying party organization. When AD FS 2.0 is configured in the role of the relying party, it acts as a partner that trusts a claims provider to authenticate users. Therefore, the relying party consumes the claims that are packaged in security tokens that come from users in the claims provider. In other words, a relying party is the organization whose Web servers are protected by the resource-side federation server. The federation server at the relying party uses the security tokens that the claims provider produces to issue tokens to the Web servers that are located in the relying party. - -## RELATED LINKS - -[Add-ADFSRelyingPartyTrust](./Add-ADFSRelyingPartyTrust.md) - -[Disable-ADFSRelyingPartyTrust](./Disable-ADFSRelyingPartyTrust.md) - -[Enable-ADFSRelyingPartyTrust](./Enable-ADFSRelyingPartyTrust.md) - -[Get-ADFSRelyingPartyTrust](./Get-ADFSRelyingPartyTrust.md) - -[Remove-ADFSRelyingPartyTrust](./Remove-ADFSRelyingPartyTrust.md) - -[Set-ADFSRelyingPartyTrust](./Set-ADFSRelyingPartyTrust.md) - diff --git a/docset/winserver2012-ps/adrms/ADRMS.md b/docset/winserver2012-ps/adrms/ADRMS.md deleted file mode 100644 index 1d686641e7..0000000000 --- a/docset/winserver2012-ps/adrms/ADRMS.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: a127fb5d-22a6-4056-a043-b16196305cc7 -Module Name: ADRMS ---- - -# ADRMS Module -## Description -This topic contains brief descriptions of the Windows PowerShell cmdlets that are used to deploy in Windows Server 2012. Each cmdlet in the table is linked to additional information about that cmdlet. These cmdlets allow you to install, upgrade, or remove a cluster using Windows PowerShell. - -## ADRMS Cmdlets -### [Install-ADRMS](./Install-ADRMS.md) -Configures a new deployment of AD RMS Server. - -### [Uninstall-ADRMS](./Uninstall-ADRMS.md) -Removes configuration for an existing deployment of AD RMS Server. - -### [Update-ADRMS](./Update-ADRMS.md) -Updates an existing deployment of rms_2 Server. - diff --git a/docset/winserver2012-ps/adrms/Install-ADRMS.md b/docset/winserver2012-ps/adrms/Install-ADRMS.md deleted file mode 100644 index 5d4437a5e5..0000000000 --- a/docset/winserver2012-ps/adrms/Install-ADRMS.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Configuration.dll-Help.xml -Module Name: ADRMS -online version: https://learn.microsoft.com/powershell/module/adrms/install-adrms?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-ADRMS - -## SYNOPSIS -Configures a new deployment of AD RMS Server. - -## SYNTAX - -### MainProvisioningParameterSet -``` -Install-ADRMS [-Path] [-Credential ] [-Force] [-WhatIf] [-Confirm] [] -``` - -### ADFSProvisioningParameterSet -``` -Install-ADRMS [-ADFSUrl] [-Credential ] [-Force] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Install-ADRMS cmdlet configures the Active Directory Rights Management Services (AD RMS) server role. -Before running this cmdlet, create a Windows PowerShell drive specifying the ADRmsInstall provider and the type of installation (RootCluster, LicensingCluster, or JoinCluster) as the root, and then set properties on the containers and child items in the drive to specify the initial values for provisioning the server. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Install-ADRMS -Path adrmsDrive:\ -``` - -Description - ------------ - -This command configures AD RMS by using configuration settings that were previously set on items in the adrmsdrive:\ drive. -For more information on using this cmdlet, see http://go.microsoft.com/fwlink/?LinkId=136806. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Install-ADRMS -ADFSUrl https://sampleadfsurl.com -Force -``` - -Description - ------------ - -This command configures Identity Federation Support for the AD RMS cluster and sets the federation server URL. -For more information on using this cmdlet, see http://go.microsoft.com/fwlink/?LinkId=136806. - -## PARAMETERS - -### -ADFSUrl -Configures the AD RMS cluster to support Active Directory Federation Services (AD FS) and specifies the federation server URL. - -```yaml -Type: String -Parameter Sets: ADFSProvisioningParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies user credentials to use for the configuration process. -If this parameter is specified, you will be prompted to enter credentials. -This parameter operates in a similar manner to the RunAs command. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces completion of the command by overriding restrictions that would prevent it from succeeding (so long as a the changes made do not compromise security). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String -Parameter Sets: MainProvisioningParameterSet -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string, PSCredential - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/adrms/Uninstall-ADRMS.md b/docset/winserver2012-ps/adrms/Uninstall-ADRMS.md deleted file mode 100644 index 245b1449c7..0000000000 --- a/docset/winserver2012-ps/adrms/Uninstall-ADRMS.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Configuration.dll-Help.xml -Module Name: ADRMS -online version: https://learn.microsoft.com/powershell/module/adrms/uninstall-adrms?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-ADRMS - -## SYNOPSIS -Removes configuration for an existing deployment of AD RMS Server. - -## SYNTAX - -``` -Uninstall-ADRMS [-ADFSOnly] [-Credential ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-ADRMS cmdlet removes configuration for the Active Directory Rights Management Services (AD RMS) server role and, if appropriate, role services that were installed with AD RMS. -To remove configuration for Identity Federation Support only, specify the ADFSOnly parameter. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Uninstall-ADRMS -Force -``` - -Description - ------------ - -This command removes the rms_2 configuration on this computer. -For more information on using this cmdlet, see http://go.microsoft.com/fwlink/?LinkId=136806 - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Uninstall-ADRMS -ADFSOnly -Force -``` - -Description - ------------ - -This command removes the Identity Federation Support configuration on this computer. -For more information on using this cmdlet, see http://go.microsoft.com/fwlink/?LinkId=136806 - -## PARAMETERS - -### -ADFSOnly -Removes configuration support for Active Directory Federated Services (AD FS) from this computer, but does not otherwise change the AD RMS configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies user credentials to use for the configuration process. -If this parameter is specified, you will be prompted to enter credentials. -This parameter operates in a similar manner to the RunAs command. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces completion of the command by overriding restrictions that would prevent it from succeeding (so long as a the changes made do not compromise security). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### SwitchParameter, PSCredential - -## OUTPUTS - -## NOTES -* To totally remove the rms_2 role from the system, the **Remove-WindowsFeature** cmdlet must be run after this cmdlet is used. The command to do so is the **Remove-WindowsFeature ADRMS -IncludeManagementTools** command. - -## RELATED LINKS - -[Install-ADRMS](./Install-ADRMS.md) - -[Update-ADRMS](./Update-ADRMS.md) - diff --git a/docset/winserver2012-ps/adrms/Update-ADRMS.md b/docset/winserver2012-ps/adrms/Update-ADRMS.md deleted file mode 100644 index e6afc67c38..0000000000 --- a/docset/winserver2012-ps/adrms/Update-ADRMS.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Configuration.dll-Help.xml -Module Name: ADRMS -online version: https://learn.microsoft.com/powershell/module/adrms/update-adrms?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ADRMS - -## SYNOPSIS -Updates an existing deployment of rms_2 Server. - -## SYNTAX - -``` -Update-ADRMS [-ServiceAccount] [[-PrivateKeyPassword] ] [[-NewCspName] ] - [-UpdateCryptographicModeOnly] [-Credential ] [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Update-ADRMS cmdlet updates the Active Directory Rights Management Services (AD RMS) server role on a server that has been upgraded to this version of Windows. -The cmdlet can also be used to update the rms_2 cryptographic mode on a server. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>$mySecureStringPassword = ConvertTo-SecureString -String -AsPlainText -Force -$myCred = Get-Credential -Update-ADRMS -PrivateKeyPassword $mySecureStringPassword -ServiceAccount $myCred -``` - -Description - ------------ - -Upgrades an rms_2 server and cluster that is using a cluster key password. -The password must be specified securely as console input. -The **Get-Credential** cmdlet will launch a popup dialog to enter the rms_2 Service Account credentials (username and password) that are also required to upgrade rms_2. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>$myCred = Get-Credential -Update-ADRMS -UpdateCryptographicModeOnly -ServiceAccount $myCred -``` - -Description - ------------ - -Updates an rms_2 server that is using a cluster key password to cryptographic mode 2. -The **Get-Credential** command will launch a popup dialog to enter the rms_2 Service Account credentials (username and password) which are required for this update. -The cluster key password is not required; but if the server is using CSP key storage, the **-NewCspName** parameter must be included. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies user credentials to use for the update process. -If this parameter is specified, you will be prompted to enter credentials. -This parameter operates in a similar manner to the RunAs command. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces completion of the command by overriding restrictions that would prevent it from succeeding (so long as a the changes made do not compromise security). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewCspName -Specifies the new name of the cryptographic service provider (CSP) to use for storing the private key of the rms_2 server. -This parameter is used in combination with the **-UpdateCryptographicMode** parameter for rms_2 servers that are using CSP key storage. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivateKeyPassword -Specifies the password for the AD RMS centrally managed key. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceAccount -Specifies the identity of the domain account that is used for the rms_2 service account. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateCryptographicModeOnly -If set, indicates that only the cryptographic mode of the server is to be updated. -To update the cryptographic mode of an rms_2 server, you must be logged in with an account that has membership in the local rms_2 Enterprise Administrators Group on that server. -If the rms_2 server is using CSP key storage, the **-NewCspName** parameter should also be specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### SwitchParameter, string, PSCredential, SecureString - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/adrmsadmin/ADRMSAdmin.md b/docset/winserver2012-ps/adrmsadmin/ADRMSAdmin.md deleted file mode 100644 index db77a104a3..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/ADRMSAdmin.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: beb3db13-eed6-4f7b-8420-079e395b58f9 -Module Name: ADRMSAdmin ---- - -# ADRMSAdmin Module -## Description -This topic contains brief descriptions of the Windows PowerShell cmdlets that are for use in administering Active Directory Rights Management Services (AD RMS). Each cmdlet in the table is linked to additional information about that cmdlet. These cmdlets give you the ability to administer an AD RMS cluster using PowerShell. - -## ADRMSAdmin Cmdlets -### [Export-RmsReportDefinitionLanguage](./Export-RmsReportDefinitionLanguage.md) -Exports all report definition (.rdl) files for this version of Active Directory Rights Management Services (AD RMS). - -### [Export-RmsTPD](./Export-RmsTPD.md) -Exports a trusted publishing domain (TPD) in Active Directory Rights Management Services (AD RMS) to a file. - -### [Export-RmsTUD](./Export-RmsTUD.md) -Exports a trusted user domain (TUD) in Active Directory Rights Management Services (AD RMS) to a file. - -### [Get-RmsCertChain](./Get-RmsCertChain.md) -Generates a report containing information about the certificate chain of a particular user request for the Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsCertInfo](./Get-RmsCertInfo.md) -Generates a report containing information about a particular certificate used in a user request for the Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsChildCert](./Get-RmsChildCert.md) -Returns all child certificates from a parent certificate used in a user request for the Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsEncryptedIL](./Get-RmsEncryptedIL.md) -Returns use-license information from an issuance license used in a user request for the Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsRequestInfo](./Get-RmsRequestInfo.md) -Generates a report containing information about a particular user request for the Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsSvcAccount](./Get-RmsSvcAccount.md) -Gets service account credentials for an Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsSystemHealthReport](./Get-RmsSystemHealthReport.md) -Generates a system health report of the Active Directory Rights Management Services (AD RMS) cluster. - -### [Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) -Generates a user requests statistical report for the Active Directory Rights Management Services (AD RMS) cluster. - -### [Import-RmsTPD](./Import-RmsTPD.md) -Imports a trusted publishing domain (TPD) from a file in Active Directory Rights Management Services (AD RMS). - -### [Import-RmsTUD](./Import-RmsTUD.md) -Imports a trusted user domain (TUDs) from a file in Active Directory Rights Management Services (AD RMS) or specifies to trust Microsoft account IDs. - -### [Initialize-RmsCryptoMode2](./Initialize-RmsCryptoMode2.md) -Prepares an AD RMS server for transitioning to Cryptographic Mode 2. - -### [Install-RmsMfgEnrollment](./Install-RmsMfgEnrollment.md) -Enrolls an AD RMS server with Microsoft Federation Gateway. - -### [Install-RmsMfgSupport](./Install-RmsMfgSupport.md) -Adds Microsoft Federation Gateway support to an AD RMS server. - -### [Set-RmsSvcAccount](./Set-RmsSvcAccount.md) -Sets the service account for an Active Directory Rights Management Services (AD RMS) cluster. - -### [Uninstall-RmsMfgEnrollment](./Uninstall-RmsMfgEnrollment.md) -Terminates the enrollment of an rms_2 server with the Microsoft Federation Gateway. - -### [Uninstall-RmsMfgSupport](./Uninstall-RmsMfgSupport.md) -Removes Microsoft Federation Gateway support from an AD RMS server. - -### [Update-RmsCluster](./Update-RmsCluster.md) -Updates the Active Directory Rights Management Services (AD RMS) cluster information. - -### [Update-RmsMfgEnrollment](./Update-RmsMfgEnrollment.md) -Updates enrollment information for an AD RMS server enrolled with the Microsoft Federation Gateway service. - diff --git a/docset/winserver2012-ps/adrmsadmin/Export-RmsReportDefinitionLanguage.md b/docset/winserver2012-ps/adrmsadmin/Export-RmsReportDefinitionLanguage.md deleted file mode 100644 index 134d30ed31..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Export-RmsReportDefinitionLanguage.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/export-rmsreportdefinitionlanguage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-RmsReportDefinitionLanguage - -## SYNOPSIS -Exports all report definition (.rdl) files for this version of Active Directory Rights Management Services (AD RMS). - -## SYNTAX - -``` -Export-RmsReportDefinitionLanguage [-ExportLocation] [-Force] [-Path] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -HelpLongDescription This cmdlet exports the following report definition (.rdl) files for this version of Active Directory Rights Management Services (AD RMS). - -Report_Health_MultiReport.rdl - -Report_TroubleShooting_UserRequestSummary.rdl - -Report_TroubleShooting_UserRequestTypeList.rdl - -Report_TroubleShooting_UserRequestDetail.rdl - -Report_TroubleShooting_UserRequestCertificateInfo.rdl - -Report_TroubleShooting_AllILsFromCLC.rdl.rdl - -Report_TroubleShooting_AllEULsFromIssuanceLicense.rdl - -The file Report_TroubleShooting_DecryptILRightsLabel.rdl is not exported because it cannot be used by the SQL Server report service because it would require a private key. - -To export the report definition files, specify the ExportLocation where you want the files to be saved and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -## EXAMPLES - -### -------------- EXAMPLE1 -------------- -``` -C:\PS>Export-RmsReportDefinitionLanguage path . -ExportLocation c:\temp\ -``` - -This command exports the .rdl files to the directory c:\temp\. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportLocation -Specifies the path of the exported file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Force -Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. -For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsSystemHealthReport](./Get-RmsSystemHealthReport.md) - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Export-RmsTPD.md b/docset/winserver2012-ps/adrmsadmin/Export-RmsTPD.md deleted file mode 100644 index f736ecf33c..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Export-RmsTPD.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/export-rmstpd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-RmsTPD - -## SYNOPSIS -Exports a trusted publishing domain (TPD) in Active Directory Rights Management Services (AD RMS) to a file. - -## SYNTAX - -``` -Export-RmsTPD [-SavedFile] [-Password] [-V1Compatible] [-Force] [-Path] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Export-RmsTPD cmdlet exports a trusted publishing domain (TPD) in Active Directory Rights Management Services (AD RMS) to a file. - -To perform the export, set the SavedFilePath parameter to the export file path, and then set the Path parameter to the AD RMS provider subpath "\:\TrustPolicy\TrustedPublishingDomain\\\" where \ is the provider drive ID and \ is the ID of the TPD that you want to export. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Export-RmsTPD -Path .\100 -SavedFile c:\temp\test.xml -``` - -This command exports the TPD with the ID of 100 to the file c:\temp\test.xml. -Because the -Password parameter is not used, the command prompts for the password. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>$pswd=Read-Host -AsSecureString -Export-RmsTPD -Path 100 -SavedFile c:\temp\test.xml -Password $pswd -``` - -The first command prompts for a password and saves it in the variable $pswd. -The variable is then passed to the Export-RmsTPD command as the Password parameter. -Note that the Export-RmsTPD command prompts for a confirmation password that must match the password stored in the $pswd variable. - -### -------------- EXAMPLE 3 -------------- -``` -C:\PS>$pswd=Read-Host -AsSecureString -Export-RmsTPD -Path 100 -SavedFile c:\temp\test.xml -Password $pswd -Force -``` - -The first command prompts for a password and saves it in the variable $pswd. -The variable is then passed to the Export-RmsTPD command as the Password parameter. -Because the Force parameter was used, the Export-RmsTPD command does not prompt for a confirmation password. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. -For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Password -Specifies a password as a SecureString object. -To create a SecureString object that contains a password, use the Read-Host cmdlet and specify the AsSecureString parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SavedFile -Specifies the full path and filename of the file that receives the exported content. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -V1Compatible -Allows the trusted publishing domain to be imported to Windows Rights Management Services (RMS) 1.0. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Export-RmsTUD](./Export-RmsTUD.md) - -[Import-RmsTPD](./Import-RmsTPD.md) - -[Import-RmsTUD](./Import-RmsTUD.md) - -[Read-Host](/powershell/module/microsoft.powershell.utility/read-host) - -[ADRMSAdmin Module](./ADRMSAdmin.md) diff --git a/docset/winserver2012-ps/adrmsadmin/Export-RmsTUD.md b/docset/winserver2012-ps/adrmsadmin/Export-RmsTUD.md deleted file mode 100644 index 501b821985..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Export-RmsTUD.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/export-rmstud?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-RmsTUD - -## SYNOPSIS -Exports a trusted user domain (TUD) in Active Directory Rights Management Services (AD RMS) to a file. - -## SYNTAX - -``` -Export-RmsTUD [-SavedFile] [-Force] [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Export-RmsTUD cmdlet exports the internal enterprise trusted user domain (TUD) in Active Directory Rights Management Services (AD RMS) to a file. - -To perform the export, set the SavedFilePath parameter to the export file path, and then set the Path parameter to the AD RMS provider subpath "\:\TrustPolicy\TrustedUserDomain\\\" where \ is the provider drive ID and \ is the ID of the internal TUD. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Export-RmsTuD -Path .\100 -SavedFile c:\temp\test.xml -``` - -This command exports the TUD with the ID of 100 to the file c:\temp\test.xml. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. -For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SavedFile -Specifies the full path and filename of the file that receives the exported content. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Export-RmsTPD](./Export-RmsTPD.md) - -[Import-RmsTPD](./Import-RmsTPD.md) - -[Import-RmsTUD](./Import-RmsTUD.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsCertChain.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsCertChain.md deleted file mode 100644 index a9e7e5f174..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsCertChain.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmscertchain?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsCertChain - -## SYNOPSIS -Generates a report containing information about the certificate chain of a particular user request for the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsCertChain -RequestId [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet generates a report that contains information about the certificate chain of a particular user request on the Active Directory Rights Management Services (AD RMS) cluster. - -To obtain the report, specify the RequestID of the user request for which you want a report and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -Use the Get-RmsUserRequestReport cmdlet to obtain the RequestID of the user request for which you want a certificate chain report. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsCertChain -Path . -RequestId 100 -``` - -This command displays the certification chain of the request with the ID of 100. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>Get-RmsUserRequestReport -Path . -RequestType GetClientLicensorCertificate -UserId 1 | Get-RmsCertChain -Path . -``` - -This command uses the Get-RmsUserRequestReport cmdlet to retrieve the ID of a user request and then pipes the ID to the Get-RmsCertChain cmdlet to display the certificate chain of the request. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestId -Specifies the unique internal ID of a user request. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsCertInfo](./Get-RmsCertInfo.md) - -[Get-RmsChildCert](./Get-RmsChildCert.md) - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsCertInfo.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsCertInfo.md deleted file mode 100644 index ebeeebc51c..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsCertInfo.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmscertinfo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsCertInfo - -## SYNOPSIS -Generates a report containing information about a particular certificate used in a user request for the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsCertInfo -CertificateId [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet generates a report that contains information about a particular certificate used in a user request on the Active Directory Rights Management Services (AD RMS) cluster. - -To obtain the report, specify the CertificateID of the certificate for which you want a report and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -Use the Get-RmsCertChain cmdlet to obtain the CertificateID of the certificate for which you want a report. -The CertificateID value returned is valid only for the cluster identified by the Path parameter of Get-RmsCertChain. -You cannot use a CertificateID to identify the same certificate in different clusters - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsCertInfo -Path . -CertificateId sH+lchPGEP9IKIajmnw5QGUqOl4= -``` - -This command displays detailed information for a particular certificate. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>$certs= Get-RmsCertChain -Path . -RequestId 2 | Where {$_.CertificateType -eq 'DRM-CA-Certificate'} -$certs[0] | Get-RmsCertInfo -Path . -``` - -This command stores filtered results of the Get-RmsCertChain cmdlet in a variable and then pipes the first certificate in the array to the Get-RmsCertInfo cmdlet to display details about that certificate. - -## PARAMETERS - -### -CertificateId -Specifies a unique internal certificate ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsCertChain](./Get-RmsCertChain.md) - -[Get-RmsChildCert](./Get-RmsChildCert.md) - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsChildCert.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsChildCert.md deleted file mode 100644 index 05b65f13af..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsChildCert.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmschildcert?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsChildCert - -## SYNOPSIS -Returns all child certificates from a parent certificate used in a user request for the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsChildCert [-StartTime ] [-EndTime ] -ParentCertId -ParentCertType - [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet returns all issuance licenses from a parent client licensor certificate (CLC) or all end-user licenses (EULs) from a parent issuance license used in a user request on the Active Directory Rights Management Services (AD RMS) cluster. - -To obtain licenses, specify the ParentCertID and ParentCertType of the parent certificate for which you want to retrieve child certificates and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -Use the Get-RmsCertChain cmdlet to obtain the ParentCertID and the ParentCertType of the certificate for which you to retrieve child certificates. -The ParentCertID value returned is valid only for the cluster identified by the Path parameter of Get-RmsCertChain. -You cannot use a ParentCertID to identify the same certificate in different clusters. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsChildCert -Path . -parentCertId 8AGI9GoWuobJDsTmr/CUHTCEpsI= -ParentCertType CLC -``` - -This command returns all child certificates from a parent client licensor certificate. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>$parentCert = Get-RmsCertChain -Path . -RequestID 3 | Where {$_.CertificateType -eq 'Client-Licensor-Certificate'} -Get-RmsChildCert -Path . -ParentCertId $parentCert.CertificateID -ParentCertType $parentCert.CertificateType -``` - -This command stores a certificate obtained from the Get-RmsCertChain cmdlet in a variable and then uses that variable to pass the certificate ID and type to the Get-RmsChildCert cmdlet to return child certificates. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end of a time period for a system health report. -This parameter specifies a time value. -See the description of the StartTime parameter for information on specifying a time. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ParentCertId -Specifies the parent certificate for which child certificates are to be returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ParentCertType -Specifies the type of parent certificate for which child certificates are to be returned. -Possible values for this parameter are Client-Licensor-Certificate (or CLC) or Issuance-License (or IL). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: CLC, Client-Licensor-Certificate, IL, Issuance-License - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartTime -Specifies the beginning of a time period. -This parameter specifies a time value. - -The following examples show commonly-used syntax to specify a time. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. - -- "4/17/2006" - -- "Monday, April 17, 2006" - -- "2:22:45 PM" - -- "Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -- "4/17/2006 2:22 PM" - -- "Monday, April 17, 2006 2:22 PM" - -- "2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - --"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - --"2000-04-17T14:22:48.0000000" - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsCertChain](./Get-RmsCertChain.md) - -[Get-RmsCertInfo](./Get-RmsCertInfo.md) - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsEncryptedIL.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsEncryptedIL.md deleted file mode 100644 index c070ee479e..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsEncryptedIL.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmsencryptedil?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsEncryptedIL - -## SYNOPSIS -Returns use-license information from an issuance license used in a user request for the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsEncryptedIL -ILCertificateId [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet generates a report containing information about an issuance license used in a user request on the Active Directory Rights Management Services (AD RMS) cluster. -You must be logged in as an Enterprise Administrator to use this cmdlet. - -To obtain licenses, specify the ILCertificateID of the certificate for which you want to obtain use-license information and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -Use the Get-RmsCertChain cmdlet to obtain the ILCertificateID of the certificate for which you want to obtain use-license information. -The ILCertificateID value returned is valid only for the cluster identified by the Path parameter of Get-RmsCertChain. -You cannot use an ILCertificateID to identify the same certificate in different clusters. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsEncryptedIL -Path . -ILCertificateId "YJ3HGsG/ADg3rLm5LwWGgpAJmz4=" | Out-File -FilePath C:\temp\RightsPolicyData.xml -``` - -This command returns use-license information from an issuance license and saves the results in a file. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ILCertificateId -Specifies the issuance license certificate hash ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsCertChain](./Get-RmsCertChain.md) - -[Get-RmsCertInfo](./Get-RmsCertInfo.md) - -[Get-RmsChildCert](./Get-RmsChildCert.md) - -[Get-RmsRequestInfo](./Get-RmsRequestInfo.md) - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsRequestInfo.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsRequestInfo.md deleted file mode 100644 index 706ae17eea..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsRequestInfo.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmsrequestinfo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsRequestInfo - -## SYNOPSIS -Generates a report containing information about a particular user request for the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsRequestInfo -RequestId [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet generates a report that contains detailed information about a particular user request on the Active Directory Rights Management Services (AD RMS) cluster. - -To obtain the report, specify the RequestID of the user request for which you want a report and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -Use the Get-RmsUserRequestReport cmdlet to obtain the RequestID of the user request for which you want a detailed report. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsRequestInfo -Path . -RequestID 1000 -``` - -This command displays information about a particular user request. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>Get-RmsUserRequestReport -Path . -RequestType AcquireLicense -UserID 1 | Get-RmsRequestInfo -Path . -``` - -This command displays detailed information about a user's request to acquire a license. -The Get-RmsUserRequestReport cmdlet retrieves the user's license request and then pipes the results to the Get-RmsRequestInfo cmdlet to display the details of the request. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestId -Specifies the unique internal ID of a user request. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsSvcAccount.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsSvcAccount.md deleted file mode 100644 index b692edb4fd..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsSvcAccount.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmssvcaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsSvcAccount - -## SYNOPSIS -Gets service account credentials for an Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsSvcAccount [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -HelpLongDescription The Get-RmsSvcAccount cmdlet gets service account credentials for an Active Directory Rights Management Services (AD RMS) cluster. - - - -To get the service account credentials, set the Path parameter to "\:\" where \ is the drive ID of the provider drive associated with AD RMS cluster. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsSvcAccount -Path . -``` - -This command displays the AD RMS service account. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: String.empty -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Management.Automation.PSCredential - -## NOTES - -## RELATED LINKS - -[Set-RmsSvcAccount](./Set-RmsSvcAccount.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsSystemHealthReport.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsSystemHealthReport.md deleted file mode 100644 index c5e4584e12..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsSystemHealthReport.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmssystemhealthreport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsSystemHealthReport - -## SYNOPSIS -Generates a system health report of the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsSystemHealthReport [-StartTime ] [-EndTime ] [-ServerName ] - [-RequestType ] [-DomainName ] [-UserName ] -ReportType - [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet generates a report that contains information about the overall health of the Active Directory Rights Management Services (AD RMS) cluster. - -To obtain the report, set the parameters for the type of report you want and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. - -The cmdlet generates a summary report for the specified ReportType unless you specify RequestType, ServerName, DomainName, or UserName. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsSystemHealthReport -Path . -ReportType Request -``` - -This command displays a summary report of requests processed by the AD RMS cluster. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>Get-RmsSystemHealthReport -Path . -StartTime 12/1/2008 -EndTime 12/31/2008 -ReportType User -``` - -This command displays a summary report of user activity during calendar year 2008. - -### -------------- EXAMPLE 3 -------------- -``` -C:\PS>Get-RmsSystemHealthReport -Path . -ReportType User -Domain Research -``` - -This command displays a summary report of requests by all users in the Research domain. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the domain name of the e-mail of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end of a time period for a system health report. -This parameter specifies a time value. -See the description of the StartTime parameter for information on specifying a time. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -Specifies the type of report. -Possible values are "Server", "Request", "Domain", and "User". - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: -Accepted values: Server, Request, Domain, User - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RequestType -Specifies the type of user request, such as "Acquire License", "Pre-Certify", and "Get Client Licensor Certificate". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ServerName -Specifies the name of the server for which you are requesting the health report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the beginning of a time period. -This parameter specifies a time value. - -The following examples show commonly-used syntax to specify a time. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. - -- "4/17/2006" - -- "Monday, April 17, 2006" - -- "2:22:45 PM" - -- "Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -- "4/17/2006 2:22 PM" - -- "Monday, April 17, 2006 2:22 PM" - -- "2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - --"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - --"2000-04-17T14:22:48.0000000" - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -UserName -Specifies the user name for which you are requesting a system health report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsUserRequestReport](./Get-RmsUserRequestReport.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Get-RmsUserRequestReport.md b/docset/winserver2012-ps/adrmsadmin/Get-RmsUserRequestReport.md deleted file mode 100644 index 92bd483071..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Get-RmsUserRequestReport.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/get-rmsuserrequestreport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-RmsUserRequestReport - -## SYNOPSIS -Generates a user requests statistical report for the Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Get-RmsUserRequestReport [-StartTime ] [-EndTime ] [-UserName ] - [-RequestType ] [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -This cmdlet generates a report that contains statistics about the request activity of a single user on the Active Directory Rights Management Services (AD RMS) cluster. - -To obtain the report, specify the UserName of the user for which you want a report and then set the Path parameter to the AD RMS provider drive subpath "\:\Report" where \ is the provider drive ID. -You can also specify a relative path. -For example, "." specifies the current location. -This will return a UserId and applicable request types that you can then use with the cmdlet to produce a more detailed report. - -The UserID value returned for a particular UserName is valid only for the cluster identified by the Path parameter specified when the UserID value was returned. -You cannot use the UserID to identify the same user in different clusters. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Get-RmsUserRequestReport -Path . -UserName CONTOSO\RSun -``` - -This command displays a summary report of the requests from the user RSun of the Research domain. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>Get-RmsUserRequestReport -Path . -StartTime 2/1/2009 -EndTime 2/28/2009 -UserName CONTOSO\RSun -RequestType AcquireLicense -``` - -This command displays the request by a specified user to acquire a license. - -### -------------- EXAMPLE 3 -------------- -``` -C:\PS>Get-RmsUserRequestReport -Path . -RequestType AcquireLicense -UserName CONTOSO\RSun | Get-RmsRequestInfo -Path . -``` - -This command displays detailed information about a user's request to acquire a license. -The Get-RmsUserRequestReport cmdlet retrieves the user's license request and then pipes the results to the Get-RmsRequestInfo cmdlet to display the details of the request. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndTime -Specifies the end of a time period for a system health report. -This parameter specifies a time value. -See the description of the StartTime parameter for information on specifying a time. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequestType -Specifies the type of user request, such as "Acquire License", "Pre-Certify", and "Get Client Licensor Certificate". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -StartTime -Specifies the beginning of a time period. -This parameter specifies a time value. - -The following examples show commonly-used syntax to specify a time. -Time is assumed to be local time unless otherwise specified. -When a time value is not specified, the time is assumed to 12:00:00 AM local time. -When a date is not specified, the date is assumed to be the current date. - -- "4/17/2006" - -- "Monday, April 17, 2006" - -- "2:22:45 PM" - -- "Monday, April 17, 2006 2:22:45 PM" - -These examples specify the same date and the time without the seconds. - -- "4/17/2006 2:22 PM" - -- "Monday, April 17, 2006 2:22 PM" - -- "2:22 PM" - -The following example shows how to specify a date and time by using the RFC1123 standard. -This example defines time by using Greenwich Mean Time (GMT). - --"Mon, 17 Apr 2006 21:22:48 GMT" - -The following example shows how to specify a round-trip value as Coordinated Universal Time (UTC). -This example represents Monday, April 17, 2006 at 2:22:48 PM UTC. - --"2000-04-17T14:22:48.0000000" - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -UserName -Specifies the user for which you are requesting a user request report, in the format \\\\. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-RmsCertChain](./Get-RmsCertChain.md) - -[Get-RmsCertInfo](./Get-RmsCertInfo.md) - -[Get-RmsRequestInfo](./Get-RmsRequestInfo.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Import-RmsTPD.md b/docset/winserver2012-ps/adrmsadmin/Import-RmsTPD.md deleted file mode 100644 index a0a8c09640..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Import-RmsTPD.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/import-rmstpd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-RmsTPD - -## SYNOPSIS -Imports a trusted publishing domain (TPD) from a file in Active Directory Rights Management Services (AD RMS). - -## SYNTAX - -``` -Import-RmsTPD [-DisplayName] [-SourceFile] [-Password] [-Force] [-PassThru] - [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Import-RmsTPD cmdlet imports a trusted publishing domain from a file in Active Directory Rights Management Services (AD RMS). - -To perform the import, specify the DisplayName, SourceFile and Password parameters, and then set the Path parameter to the AD RMS provider drive subpath "\:\TrustPolicy\TrustedPublishingDomain" where \ is the provider drive ID. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Import-TPD -Path . -DisplayName Fabrikam -SourceFile c:\transfer\fabrikam.xml -``` - -This command imports the TPD information stored in the specified file and assigns the name Fabrikam to the TPD. -Note that because the Password parameter was not used, the Import-TPD cmdlet prompts for the domain password. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>$pswd = Read-Host -Prompt "Password:" -AsSecureString -Import-RmsTPD -Path . -DisplayName Fabrikam -SourceFile c:\transfer\fabrikam.xml -Password $pswd -``` - -This command uses the Read-Host cmdlet to prompt the user for a password and then stores the password in a variable that is passed to the Import-RmsTPD cmdlet. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the name that will be used to identify the domain being imported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Force -Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Passes the object created by this cmdlet through the pipeline. -By default, this cmdlet does not pass any objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Password -Specifies a password as a SecureString object. -To create a SecureString object that contains a password, use the Read-Host cmdlet and specify the AsSecureString parameter. - -```yaml -Type: SecureString -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFile -Specifies the path to the file that contains the domain information to import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.RightsManagementServices.PowerShell.TrustedPublishingDomainImportedItem - -## NOTES - -## RELATED LINKS - -[Export-RmsTPD](./Export-RmsTPD.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Import-RmsTUD.md b/docset/winserver2012-ps/adrmsadmin/Import-RmsTUD.md deleted file mode 100644 index fe8ee40c3c..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Import-RmsTUD.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/import-rmstud?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-RmsTUD - -## SYNOPSIS -Imports a trusted user domain (TUDs) from a file in Active Directory Rights Management Services (AD RMS) or specifies to trust Microsoft account IDs. - -## SYNTAX - -### EnterpriseTUD (Default) -``` -Import-RmsTUD [-DisplayName] [-SourceFile] [-TrustADFederatedUser] [-PassThru] - [-Path] [-WhatIf] [-Confirm] [] -``` - -### WindowsLiveID -``` -Import-RmsTUD [-WindowsLiveId] [-PassThru] [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Import-RmsTUD cmdlet imports an enterprise trusted user domain (TUD) from a file in Active Directory Rights Management Services (AD RMS) or it specifies to trust a Microsoft account ID. - -To perform the import enterprise TUDs, specify the DisplayName and SourceFile parameters and set the Path parameter to the AD RMS provider drive subpath "\:\TrustPolicy\TrustedUserDomain" where \ is the provider drive ID. - -To trust a Microsoft account ID, specify the WindowsLiveID parameter, and set the Path parameter to the AD RMS provider drive subpath "\:\TrustPolicy\TrustedUserDomain" - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Import-TUD -Path . -DisplayName Fabrikam -SourceFile c:\transfer\fabrikam.xml -``` - -This command imports the TUD information stored in the specified file and assigns the name Fabrikam to the TUD. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>Import-RmsTUD -Path . -WindowsLiveId -``` - -This command configures the AD RMS cluster to trust Microsoft account IDs. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the name that will be used to identify the domain being imported. - -```yaml -Type: String -Parameter Sets: EnterpriseTUD -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Passes the object created by this cmdlet through the pipeline. -By default, this cmdlet does not pass any objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceFile -Specifies the path to the file that contains the domain information to import. - -```yaml -Type: String -Parameter Sets: EnterpriseTUD -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -TrustADFederatedUser -Specifies to trust Active Directory Federation Services (ADFS) users. - -```yaml -Type: SwitchParameter -Parameter Sets: EnterpriseTUD -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WindowsLiveId -Specifies to trust Microsoft account IDs. - -```yaml -Type: SwitchParameter -Parameter Sets: WindowsLiveID -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.RightsManagementServices.PowerShell.TrustedUserDomainImportedItem - -## NOTES - -## RELATED LINKS - -[Export-RmsTUD](./Export-RmsTUD.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Initialize-RmsCryptoMode2.md b/docset/winserver2012-ps/adrmsadmin/Initialize-RmsCryptoMode2.md deleted file mode 100644 index 289e5325a6..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Initialize-RmsCryptoMode2.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/initialize-rmscryptomode2?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Initialize-RmsCryptoMode2 - -## SYNOPSIS -Prepares an AD RMS server for transitioning to Cryptographic Mode 2. - -## SYNTAX - -``` -Initialize-RmsCryptoMode2 -FilePath [-CspName ] [-Regenerate] [-Force] [-Path] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Initialize-RmsCryptoMode2 cmdlet prepares an AD RMS server for transitioning to Cryptographic Mode 2. - -Cryptographic Mode 2 is an updated and enhanced AD RMS cryptographic implementation. -It supports 2048-bit RSA encryption and 256-bit length keys using the SHA-2 hashing algorithm (SHA-2/SHA-256) standards. - -While this cmdlet is useful for performing the initial steps required in transitioning an AD RMS deployment to Cryptographic Mode 2. -Additional tasks are required. -First, all client computers in the AD RMS cluster environment must be patched to support this updated and enhanced mode. -Depending on your deployment configuration, some or all servers might need to be updated as well. -When all computers have been updated, as a the final transition task to Cryptographic Mode 2, you can run the Update-ADRMS cmdlet with the -UpdateCryptographicModeOnly parameter specified to effectively switch the cluster to using mode 2 instead of mode 1. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -PS C:\>Initialize-RmsCryptoMode2 -path . -FilePath c:\test.tud -``` - -Exports the server licensor certificate (SLC) for the current AD RMS server to the c:\test.tud for a server that uses centrally managed keys. - -### -------------- EXAMPLE 2 -------------- -``` -PS C:\>Initialize-RmsCryptoMode2 -path . -FilePath c:\test2.tud -Regenerate -Initialize cryptographic mode 2 - -This will regenerate the cryptographic mode 2 key pair. Are you sure you want to continue? - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -Forces regeneration of the cryptographic mode 2 keys. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CspName -The name of the cryptographic service provider (CSP) to use for generating the mode 2 TUD when this cmdlet is executed. -This CSP must be of the type PROV_RSA_AES to support mode 2 operation (in contrast to mode 1 keys which use the CSP type PROV_RSA_FULL). - -Note that this parameter is for CSP-based installs only. -If a CSP name is specified for a server with a centrally managed key, an error is returned if this parameter is included in the command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -FilePath -Specifies the name and location for the file generated when this cmdlet is executed. -This file contains the mode 2 SLC (server licensor certificate) which is exported as part of transitioning a trusted user domain (TUD) to mode operation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Force -Forces the cmdlet to save (overwrite) an existing file if one is found to exist under the name and location specified as part of the **-FilePath** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -This parameter is for CSP-based installs only. -If a CSP name is specified for a server with a centrally managed key, an error is returned if this parameter is included in the command. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Regenerate -Forces the AD RMS server to generate a new key even if the cmdlet has already been run previously. -This overwrites any previously generated key. -Since this cmdlet can be run multiple times, if this parameter is omitted, the same key will be exported each subsequent time the cmdlet is run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### string[], string, bool, SwitchParameter - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adrmsadmin/Install-RmsMfgEnrollment.md b/docset/winserver2012-ps/adrmsadmin/Install-RmsMfgEnrollment.md deleted file mode 100644 index dd3e81e84b..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Install-RmsMfgEnrollment.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/install-rmsmfgenrollment?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-RmsMfgEnrollment - -## SYNOPSIS -Enrolls an AD RMS server with Microsoft Federation Gateway. - -## SYNTAX - -``` -Install-RmsMfgEnrollment [-Force] [-GetDefaultCertificate] [-CertificateThumbprint ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Install-RmsMfgEnrollment cmdlet enrolls an AD RMS server with the Microsoft Federation Gateway. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -PS C:\>Install-RmsMfgEnrollment -GetDefaultCertificate -``` - -Enrolls the AD RMS cluster in the Microsoft Federation Gateway by retrieving and using the thumbprint hash of the AD RMS default certificate. - -### -------------- EXAMPLE 2 -------------- -``` -PS C:\>Install-RmsMfgEnrollment -CertificateThumbprint a909502dd82ae41433e6f83886b00d4277a32a7b -``` - -Enrolls the AD RMS cluster in the Microsoft Federation Gateway using the thumbprint hash of a non-default certificate. - -## PARAMETERS - -### -CertificateThumbprint -Specifies a string containing the thumbprint hash of the certificate being used to enroll with the Microsoft Federation Gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the process of enrollment to be completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -GetDefaultCertificate -When specified, indicates that the thumbprint hash of the AD RMS default certificate should be retrieved and used to enroll with the Microsoft Federation Gateway. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Uninstall-RmsMfgEnrollment](./Uninstall-RmsMfgEnrollment.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Install-RmsMfgSupport.md b/docset/winserver2012-ps/adrmsadmin/Install-RmsMfgSupport.md deleted file mode 100644 index 598020d270..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Install-RmsMfgSupport.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/install-rmsmfgsupport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-RmsMfgSupport - -## SYNOPSIS -Adds Microsoft Federation Gateway support to an AD RMS server. - -## SYNTAX - -``` -Install-RmsMfgSupport [-Force] [-FederationUrl ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Install-RmsMfgSupport cmdlet adds Microsoft Federation Gateway support to an AD RMS server. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -PS C:\>Install-RmsMfgSupport -``` - -Adds Microsoft Federation Gateway support to an AD RMS server. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FederationUrl -Specifies the uniform resource locator (URL) that the AD RMS server is to use when connecting to the Microsoft Federation Gateway. -If this parameter is not supplied, AD RMS will connect to the Microsoft Federation Gateway using default - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Force -Forces the installation process to be completed, even if there are issues. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* Before adding Microsoft Federation Gateway Support, it is very important that you back up the AD RMS configuration database. - - Do not run this command if the AD RMS snap-in is open in the Microsoft Management Console (MMC). -If you do, the command will not respond until you close the AD RMS MMC snap-in. - - Before uninstalling Service Pack 1 for nextref_windows_7, you must remove Microsoft Federation Gateway Support from the AD RMS cluster by running the **Uninstall-RmsMfgSupport** cmdlet. -Failure to do this may cause an inconsistent configuration of your AD RMS cluster. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/adrmsadmin/Set-RmsSvcAccount.md b/docset/winserver2012-ps/adrmsadmin/Set-RmsSvcAccount.md deleted file mode 100644 index a7c10cb0dc..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Set-RmsSvcAccount.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/set-rmssvcaccount?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-RmsSvcAccount - -## SYNOPSIS -Sets the service account for an Active Directory Rights Management Services (AD RMS) cluster. - -## SYNTAX - -``` -Set-RmsSvcAccount [-Credential] [-Force] [-PassThru] [-Path] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The Set-RmsSvcAccount cmdlet sets the service account of an Active Directory Rights Management Services (AD RMS) cluster. - -To specify the service account, set the Credential parameter to the service account credentials, and then set the Path parameter to "\:\" where \ is the AD RMS provider drive ID. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Set-RmsSvcAccount -Path . -``` - -This command changes the AD RMS service account. -Because the Credential parameter is not used, the Set-RmsSvcAccount cmdlet prompts for the user name and password of the new service account. - -### -------------- EXAMPLE 2 -------------- -``` -C:\PS>Set-RmsSvcAccount -Path . -Force -PassThru -Credential ITDOMAIN\adrmssvc -``` - -This command changes the AD RMS service account. -Because the Credential specifies the domain and user name of the account, the Set-RmsSvcAccount cmdlet prompts for the password of the new service account. - -### -------------- EXAMPLE 3 -------------- -``` -C:\PS>$userAccount = Get-Credential ITDOMAIN\adrmssvc -Set-RmsSvcAccount -Path . -Force -PassThru -Credential $userAccount -``` - -This command uses the Get-Credential cmdlet to prompt for the password for the ITDOMAIN\adrmsvc account and then stores the account credentials securely in a variable, which is then passed to the Set-RmsSvcAccount cmdlet. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies a user name and password as a PSCredential object. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Passes the object created by this cmdlet through the pipeline. -By default, this cmdlet does not pass any objects through the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: String.empty -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### PSCredential - -## NOTES - -## RELATED LINKS - -[Get-RmsSvcAccount](./Get-RmsSvcAccount.md) - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Uninstall-RmsMfgEnrollment.md b/docset/winserver2012-ps/adrmsadmin/Uninstall-RmsMfgEnrollment.md deleted file mode 100644 index 8bc9d22ac5..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Uninstall-RmsMfgEnrollment.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/uninstall-rmsmfgenrollment?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-RmsMfgEnrollment - -## SYNOPSIS -Terminates the enrollment of an rms_2 server with the Microsoft Federation Gateway. - -## SYNTAX - -``` -Uninstall-RmsMfgEnrollment [-Force] [-GetDefaultCertificate] [-CertificateThumbprint ] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-RmsMfgEnrollment cmdlet terminates the enrollment of an rms_2 server with the Microsoft Federation Gateway. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -PS C:\>Uninstall-RmsMfgEnrollment -CertificateThumbprint a909502dd82ae41433e6f83886b00d4277a32a7b -``` - -Removes support for Microsoft Federation Gateway form the AD RMS server using the specified certificate thumbprint. - -### -------------- EXAMPLE 2 -------------- -``` -PS C:\>Uninstall-RmsMfgEnrollment -GetDefaultCertificate -``` - -Removes support for Microsoft Federation Gateway from the AD RMS server by retrieving and using the certificate thumbprint hash for the AD RMS default certificate. - -## PARAMETERS - -### -CertificateThumbprint -Specifies a string containing the thumbprint hash of the certificate that was used to enroll rms_2 with the Microsoft Federation Gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the unenrollment process to be completed, even if there are issues. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -GetDefaultCertificate -When specified, indicates that the thumbprint hash of the AD RMS default certificate should be retrieved and used during the removal of support for the AD RMS server to use the Microsoft Federation Gateway. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Install-RmsMfgEnrollment](./Install-RmsMfgEnrollment.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Uninstall-RmsMfgSupport.md b/docset/winserver2012-ps/adrmsadmin/Uninstall-RmsMfgSupport.md deleted file mode 100644 index c4de6a2216..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Uninstall-RmsMfgSupport.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/uninstall-rmsmfgsupport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-RmsMfgSupport - -## SYNOPSIS -Removes Microsoft Federation Gateway support from an AD RMS server. - -## SYNTAX - -``` -Uninstall-RmsMfgSupport [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Uninstall-RmsMfgSupport cmdlet removes Microsoft Federation Gateway support from an AD RMS server. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -PS C:\>Uninstall-RmsMfgSupport -Force -``` - -Forces removal of Microsoft Federation Gateway support for AD RMS. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces completion of the current operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES -* Before uninstalling Service Pack 1 for nextref_server_7, you must remove Microsoft Federation Gateway Support from the AD RMS cluster. Failure to do this may cause an inconsistent configuration of your AD RMS cluster. - -## RELATED LINKS - -[Install-RmsMfgSupport](./Install-RmsMfgSupport.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Update-RmsCluster.md b/docset/winserver2012-ps/adrmsadmin/Update-RmsCluster.md deleted file mode 100644 index b6835feccd..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Update-RmsCluster.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/update-rmscluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-RmsCluster - -## SYNOPSIS -Updates the Active Directory Rights Management Services (AD RMS) cluster information. - -## SYNTAX - -``` -Update-RmsCluster [-Force] [-Path] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Update-RmsCluster cmdlet updates the cluster information including the hierarchy of content that defines the cluster in Active Directory Rights Management Services (AD RMS). -The AD RMS cluster hierarchy is reflected in the directory structure of the provider drive associated with the cluster. -For example, you can access the rights policy template information from the RightsPolicyTemplate subdirectory. - -To update AD RMS cluster information, set the Path parameter to \:\ where \ is the AD RMS provider drive ID associated with the cluster that you want to update. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -C:\PS>Update-RmsCluster -Path . -Force -``` - -This command updates the AD RMS cluster information. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a provider drive and path or relative path on the current drive. -This parameter is required. -Use a dot (.) to specify the current location. -This parameter does not accept wildcards and has no default value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: String.empty -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[ADRMSAdmin Module](./ADRMSAdmin.md) - diff --git a/docset/winserver2012-ps/adrmsadmin/Update-RmsMfgEnrollment.md b/docset/winserver2012-ps/adrmsadmin/Update-RmsMfgEnrollment.md deleted file mode 100644 index c4cd299dfb..0000000000 --- a/docset/winserver2012-ps/adrmsadmin/Update-RmsMfgEnrollment.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Microsoft.RightsManagementServices.Admin.dll-Help.xml -Module Name: ADRMSAdmin -online version: https://learn.microsoft.com/powershell/module/adrmsadmin/update-rmsmfgenrollment?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-RmsMfgEnrollment - -## SYNOPSIS -Updates enrollment information for an AD RMS server enrolled with the Microsoft Federation Gateway service. - -## SYNTAX - -``` -Update-RmsMfgEnrollment [-TokenCert] [-SigningCert] [-SetCertificatePermissions] [-Force] - [-GetDefaultCertificate] [-CertificateThumbprint ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The Update-RmsMfgEnrollment cmdlet updates enrollment information for an AD RMS server enrolled with the Microsoft Federation Gateway service. - -## EXAMPLES - -### -------------- EXAMPLE 1 -------------- -``` -PS C:\>Update-RmsMfgEnrollment -GetDefaultCertificate -``` - -Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server by retrieving and using the thumbprint hash of the AD RMS default certificate. - -### -------------- EXAMPLE 2 -------------- -``` -PS C:\>Update-RmsMfgEnrollment -CertificateThumbprint a909502dd82ae41433e6f83886b00d4277a32a7b -``` - -Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server using the thumbprint hash of a non-default certificate. - -### -------------- EXAMPLE 3 -------------- -``` -PS C:\>Update-RmsMfgEnrollment -SigningCert -``` - -Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server using the thumbprint hash of a non-default certificate. - -### -------------- EXAMPLE 4 -------------- -``` -PS C:\>Update-RmsMfgEnrollment -TokenCert -``` - -Updates the Microsoft Federation Gateway support enrollment for the current AD RMS server using the thumbprint hash of a non-default certificate. - -### -------------- EXAMPLE 5 -------------- -``` -PS C:\>Update-RmsMfgEnrollment -SetCertificatePermissions -``` - -Sets certificate permissions for the Microsoft Federation Gateway support enrollment for the current AD RMS. - -## PARAMETERS - -### -CertificateThumbprint -Specifies a string containing the thumbprint hash of the certificate being used to update enrollment with the Microsoft Federation Gateway. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the process of updating the enrollment to be completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -GetDefaultCertificate -When specified, indicates that the thumbprint hash of the AD RMS default certificate should be retrieved and used to update enrollment with the Microsoft Federation Gateway. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SetCertificatePermissions -When specified, indicates that permissions are to be set on the AD RMS server enrollment with the Microsoft Federation Gateway. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -SigningCert -When specified, indicates that the Microsoft Federation Gateway signing certificate should be updated (or refreshed in metadata) for the current AD RMS server enrollment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -TokenCert -When specified, indicates that the token decryption certificate should be updated for the AD RMS server enrollment with the Microsoft Federation Gateway. - -You can update the token decryption certificate or the Microsoft Federation Gateway certificate, as needed. -Because the token decryption certificate is the SSL certificate for the AD RMS cluster, you must update the token decryption certificate if the cluster SSL certificate expires. -After you update the token decryption certificate, you must grant the AD RMS Services group permission to access the certificate on all servers in the AD RMS cluster. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/applocker/AppLocker.md b/docset/winserver2012-ps/applocker/AppLocker.md deleted file mode 100644 index a71dd0f726..0000000000 --- a/docset/winserver2012-ps/applocker/AppLocker.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 9dafd409-67de-4108-8ee9-73cd61f5b7bf -Module Name: AppLocker ---- - -# AppLocker Module -## Description -The Windows PowerShell cmdlets for AppLocker are designed to streamline the administration of application control policies. The cmdlets can be used to help author, test, maintain, and troubleshoot application control policies and can be used in conjunction with the AppLocker user interface that is accessed through the Microsoft Management Console (MMC) snap-in extension to the Local Security Policy snap-in and Group Policy Management Console. -## AppLocker Cmdlets -### [Get-AppLockerFileInformation](./Get-AppLockerFileInformation.md) -Gets the file information necessary to create AppLocker rules from a list of files or an event log. - -### [Get-AppLockerPolicy](./Get-AppLockerPolicy.md) -Gets the local, the effective, or a domain AppLocker policy. - -### [New-AppLockerPolicy](./New-AppLockerPolicy.md) -Creates a new AppLocker policy from a list of file information and other rule creation options. - -### [Set-AppLockerPolicy](./Set-AppLockerPolicy.md) -Sets the AppLocker policy for the specified Group Policy Object (GPO). - -### [Test-AppLockerPolicy](./Test-AppLockerPolicy.md) -Specifies the AppLocker policy to determine whether the input files will be allowed to run for a given user. - diff --git a/docset/winserver2012-ps/applocker/Get-AppLockerFileInformation.md b/docset/winserver2012-ps/applocker/Get-AppLockerFileInformation.md deleted file mode 100644 index aa6429214a..0000000000 --- a/docset/winserver2012-ps/applocker/Get-AppLockerFileInformation.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: Microsoft.Security.ApplicationId.PolicyManagement.Cmdlets.dll-Help.xml -Module Name: AppLocker -online version: https://learn.microsoft.com/powershell/module/applocker/get-applockerfileinformation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppLockerFileInformation - -## SYNOPSIS -Gets the file information necessary to create AppLocker rules from a list of files or an event log. - -## SYNTAX - -### ByFilePath (Default) -``` -Get-AppLockerFileInformation [[-Path] ] [] -``` - -### ByAppx -``` -Get-AppLockerFileInformation - [[-Packages] ] - [] -``` - -### ByDirectory -``` -Get-AppLockerFileInformation -Directory - [-FileType ] - [-Recurse] [] -``` - -### ByEventLog -``` -Get-AppLockerFileInformation [-EventLog] [-LogPath ] - [-EventType ] - [-Statistics] [] -``` - -## DESCRIPTION -The **Get-AppLockerFileInformation** cmdlet gets the AppLocker file information from a list of files or an event log. -File information includes the publisher information, file hash, and file path. - -The file information from an event log may not contain all of the publisher information, file hash, and file path fields. -Files that are not signed will not have any publisher information. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-AppLockerFileInformation -Directory C:\Windows\system32\ -Recurse -FileType exe, script -``` - -This example gets the file information for all the .exe files and scripts under %windir%\system32. - -### EXAMPLE 2 -``` -PS C:\>Get-AppLockerFileInformation -Path "C:\Program Files (x86)\Internet Explorer\iexplore.exe" | Format-List -Path : %PROGRAMFILES%\INTERNET EXPLORER\IEXPLORE.EXE -Publisher : CN=WINDOWS MAIN BUILD LAB ACCOUNT\WINDOWS® INTERNET EXPLORER\IEXPLORE.EXE,10.0.8421.0 -Hash : SHA256 0x5F374C2DD91A6F9E9E96F149EE221EC0454649F50E1AF6D3DAEFB849FB7C551C -AppX : False - - -PS C:\>Get-AppLockerFileInformation -Path "C:\Program Files\Internet Explorer\iexplore.exe" | Format-List -Path : %PROGRAMFILES%\INTERNET EXPLORER\IEXPLORE.EXE -Publisher : CN=WINDOWS MAIN BUILD LAB ACCOUNT\WINDOWS® INTERNET EXPLORER\IEXPLORE.EXE,10.0.8421.0 -Hash : SHA256 0x5F374C2DD91A6F9E9E96F149EE221EC0454649F50E1AF6D3DAEFB849FB7C551C -AppX : False -``` - -This example gets the file information for the file specified by the path. - -### EXAMPLE 3 -``` -PS C:\>Get-AppXPackage -AllUsers | Get-AppLockerFileInformation -Path : windows.immersivecontrolpanel_6.2.0.0_neutral_neutral_cw5n1h2txyewy.appx -Publisher : CN=Microsoft Windows, O=Microsoft Corporation, L=Redmond, S=Washington, - C=US\windows.immersivecontrolpanel\APPX,6.2.0.0 -Hash : -AppX : True - -Path : windows.RemoteDesktop_1.0.0.0_neutral_neutral_cw5n1h2txyewy.appx -Publisher : CN=Microsoft Windows, O=Microsoft Corporation, L=Redmond, S=Washington, - C=US\windows.RemoteDesktop\APPX,1.0.0.0 -Hash : -AppX : True - -Path : WinStore_1.0.0.0_neutral_neutral_cw5n1h2txyewy.appx -Publisher : CN=Microsoft Windows, O=Microsoft Corporation, L=Redmond, S=Washington, C=US\WinStore\APPX,1.0.0.0 -Hash : -AppX : True -``` - -This example outputs the file information for all the packaged applications installed on this machine for all users. - -### EXAMPLE 4 -``` -PS C:\>Get-AppLockerFileInformation -EventLog -EventType Audited -``` - -This example outputs the file information for all the Audited events in the local event log. -Audited events correspond to the Warning event in the AppLocker audit log. - -### EXAMPLE 5 -``` -PS C:\>Get-AppLockerFileInformation -EventLog -EventType Allow -Statistics -``` - -This example displays statistics for all the Allowed events in the local event log. -For each file in the event log, the cmdlet will sum the number of times the event type occurred. - -### EXAMPLE 6 -``` -PS C:\>Get-AppLockerFileInformation -EventLog -EventType Audited | New-AppLockerPolicy -RuleType Publisher, Hash, Path -User Everyone -Optimize | Set-AppLockerPolicy -LDAP LDAP://TestGPO -``` - -This example creates a new AppLocker policy from the warning events in the local event log and sets the policy of a test Group Policy Object (GPO). - -## PARAMETERS - -### -Directory -Specifies the directory containing the files for which to get the file information. -If all subfolders and files in the specified directory are to be searched, then include the **Recurse** parameter - -```yaml -Type: String -Parameter Sets: ByDirectory -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventLog -Specifies that the file information is retrieved from the event log. - -```yaml -Type: SwitchParameter -Parameter Sets: ByEventLog -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventType -Specifies the event type by which to filter the events. -The acceptable values for this parameter are: Allowed, Denied, or Audited. -The event types correspond to the Informational, Error, and Warning level events in the AppLocker event logs. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Security.ApplicationId.PolicyManagement.Cmdlets.AppLockerEventType] -Parameter Sets: ByEventLog -Aliases: -Accepted values: Allowed, Denied, Audited - -Required: False -Position: Named -Default value: Allowed, Denied, Audited -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileType -Specifies the generic file type for which to search. -All files having the appropriate file name extension will be included. -The acceptable values for this parameter are: EXE, Script, MSI, and DLL. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.AppLockerFileType] -Parameter Sets: ByDirectory -Aliases: -Accepted values: Exe, Dll, WindowsInstaller, Script, Appx - -Required: False -Position: Named -Default value: Exe, Script, MSI, Dll -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the log name or file path of the event log where the AppLocker events are located. -If this parameter is not specified, the local Microsoft-Windows-AppLocker/EXE and DLL channel is used by default. - -```yaml -Type: String -Parameter Sets: ByEventLog -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Packages -Specifies a list of installed packaged applications, from which the file information is retrieved. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage] -Parameter Sets: ByAppx -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a list of paths to the files from which the file information is retrieved. -Supports regular expressions. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: ByFilePath -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Recurse -Specifies that all files and folders within the specified directory will be searched. - -```yaml -Type: SwitchParameter -Parameter Sets: ByDirectory -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Statistics -Specifies the statistics to retrieve on the files included in the event log. -Calculates a simple sum of the number of times a file is included in the event log based upon specified parameters. - -```yaml -Type: SwitchParameter -Parameter Sets: ByEventLog -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.FileInformation - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AppLockerPolicy](./Get-AppLockerPolicy.md) - -[New-AppLockerPolicy](./New-AppLockerPolicy.md) - -[Set-AppLockerPolicy](./Set-AppLockerPolicy.md) - -[Test-AppLockerPolicy](./Test-AppLockerPolicy.md) - -[Get-AppXPackage](../appx/Get-AppxPackage.md) - diff --git a/docset/winserver2012-ps/applocker/Get-AppLockerPolicy.md b/docset/winserver2012-ps/applocker/Get-AppLockerPolicy.md deleted file mode 100644 index 4126210c95..0000000000 --- a/docset/winserver2012-ps/applocker/Get-AppLockerPolicy.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Microsoft.Security.ApplicationId.PolicyManagement.Cmdlets.dll-Help.xml -Module Name: AppLocker -online version: https://learn.microsoft.com/powershell/module/applocker/get-applockerpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppLockerPolicy - -## SYNOPSIS -Gets the local, the effective, or a domain AppLocker policy. - -## SYNTAX - -### LocalPolicy (Default) -``` -Get-AppLockerPolicy [-Local] [-Xml] [] -``` - -### DomainPolicy -``` -Get-AppLockerPolicy [-Domain] -Ldap [-Xml] [] -``` - -### EffectivePolicy -``` -Get-AppLockerPolicy [-Effective] [-Xml] [] -``` - -## DESCRIPTION -The **Get-AppLockerPolicy** cmdlet retrieves the AppLocker policy from the local Group Policy Object (GPO), a specified Group Policy Object (GPO), or the effective policy on the computer. - -By default, the output is an AppLockerPolicy object. -If the **XML** parameter is used, then the output will be the AppLocker policy as an XML-formatted string. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-AppLockerPolicy -Local - Version RuleCollections RuleCollectionTypes - ------- --------------- ------------------- - 1 {} {} -``` - -This example gets the local AppLocker policy as an AppLockerPolicy object. - -### EXAMPLE 2 -``` -PS C:\>Get-AppLockerPolicy -Domain -LDAP "LDAP:// DC13.Contoso.com/CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Contoso,DC=com" -``` - -This example gets the AppLocker policy of the unique GPO specified by the LDAP path as an AppLockerPolicy object. - -### EXAMPLE 3 -``` -PS C:\>Get-AppLockerPolicy -Effective -Xml | Set-Content ('c:\temp\curr.xml') -``` - -This example gets the effective policy on the computer, and then sends it in XML-format to the specified file on an existing path. - -### EXAMPLE 4 -``` -PS C:\>Get-AppLockerPolicy -Local | Test-AppLockerPolicy -Path C:\Windows\System32\*.exe -User Everyone -``` - -This example gets the local AppLocker policy on the computer, and then tests the policy using the Test-AppLockerPolicy cmdlet to test whether the .exe files in C:\Windows\System32 will be allowed to run by the Everyone group. - -## PARAMETERS - -### -Domain -Gets the AppLocker policy from the GPO specified by the path given in the **Ldap** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: DomainPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Effective -Gets the effective AppLocker policy on the local computer. -The effective policy is the merge of the local AppLocker policy and any applied AppLocker domain policies on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: EffectivePolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ldap -Specifies the LDAP path of the GPO and must specify a unique GPO. - -```yaml -Type: String -Parameter Sets: DomainPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -Gets the AppLocker policy from the local GPO. - -```yaml -Type: SwitchParameter -Parameter Sets: LocalPolicy -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Xml -Specifies that the AppLocker policy be output as an XML-formatted string. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.AppLockerPolicy -AppLockerPolicy - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AppLockerFileInformation](./Get-AppLockerFileInformation.md) - -[New-AppLockerPolicy](./New-AppLockerPolicy.md) - -[Set-AppLockerPolicy](./Set-AppLockerPolicy.md) - -[Test-AppLockerPolicy](./Test-AppLockerPolicy.md) - diff --git a/docset/winserver2012-ps/applocker/New-AppLockerPolicy.md b/docset/winserver2012-ps/applocker/New-AppLockerPolicy.md deleted file mode 100644 index cbe0afb37c..0000000000 --- a/docset/winserver2012-ps/applocker/New-AppLockerPolicy.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Microsoft.Security.ApplicationId.PolicyManagement.Cmdlets.dll-Help.xml -Module Name: AppLocker -online version: https://learn.microsoft.com/powershell/module/applocker/new-applockerpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-AppLockerPolicy - -## SYNOPSIS -Creates a new AppLocker policy from a list of file information and other rule creation options. - -## SYNTAX - -``` -New-AppLockerPolicy - [-FileInformation] - [-RuleType ] - [-RuleNamePrefix ] [-User ] [-Optimize] [-IgnoreMissingFileInformation] [-Xml] - [] -``` - -## DESCRIPTION -The **New-AppLockerPolicy** cmdlet uses a list of file information to automatically generate a list of rules for a given user or group. -Rules can be generated based on publisher, hash, or path information. - -Run the Get-AppLockerFileInformation cmdlet to create the list of file information. - -By default, the output is an AppLockerPolicy object. -If the **XML** parameter is specified, the output will be the AppLocker policy as an XML-formatted string. - -## EXAMPLES - -### EXAMPLE 1 -``` -C:\PS>Get-ChildItem C:\Windows\System32\*.exe | Get-AppLockerFileInformation | New-AppLockerPolicy -RuleType Publisher, Hash -User Everyone -RuleNamePrefix System32 - Version RuleCollections RuleCollectionTypes - ------- --------------- ------------------- - 1 {Microsoft.Security.ApplicationId.Po... {Exe} -``` - -This example creates an AppLocker policy containing allow rules for all of the executable files in C:\Windows\System32. -The policy contains publisher rules for those files with publisher information and hash rules for those that do not. -The rules are prefixed with `System32:` and the rules apply to the Everyone group. - -### EXAMPLE 2 -``` -C:\PS>Get-ChildItem C:\Windows\System32\*.exe | Get-AppLockerFileInformation | New-AppLockerPolicy -RuleType Path -User Everyone -Optimize -XML - - -``` - -This example creates an XML-formatted AppLocker policy for all of the executable files in C:\Windows\System32. -The policy contains only path rules, the rules are applied to the Everyone group, and the **Optimize** parameter indicates that similar rules are grouped together where possible. - -### EXAMPLE 3 -``` -C:\PS>Get-AppLockerFileInformation -EventLog -LogPath "Microsoft-Windows-AppLocker/EXE and DLL" -EventType Audited | New-AppLockerPolicy -RuleType Publisher,Hash -User domain\FinanceGroup -IgnoreMissingFileInformation | Set-AppLockerPolicy -LDAP "LDAP://DC13.TailspinToys.com/CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=WingTipToys,DC=com" -``` - -This example creates a new AppLocker policy from the audited events in the local Microsoft-Windows-AppLocker/EXE and DLL event log. -All of the rules will be applied to the domain\FinanceGroup group. -Publisher rules are created when the publisher information is available, and hash rules are created if the publisher information is not available. -If only path information is available for a file, then the file is skipped because the **IgnoreMissingFileInformation** parameter is specified, and the file is included in the warning log. -If the **IgnoreMissingFileInformation** parameter is not specified when file information is missing, then the cmdlet exits because it cannot create the specified rule type. -After the new AppLocker policy is created, the AppLocker policy of the specified Group Policy Object (GPO) is set. -The existing AppLocker policy in the specified GPO will be overwritten. - -## PARAMETERS - -### -FileInformation -Specifies a file that can contain publisher, path, and hash information. -Some information may be missing, such as publisher information for an unsigned file. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.FileInformation] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -IgnoreMissingFileInformation -Specifies that, if a rule cannot be created for a file due to missing file information, then evaluation of the remaining file information will continue and a warning log of the files skipped will be generated. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Optimize -Specifies that similar rules will be grouped together. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleNamePrefix -Specifies a name to add as the prefix for each rule that is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RuleType -Specifies the type of rules to create from the file information. -Publisher, path, or hash rules can be created from the file information. -Multiple rule types may be specified, so that there are backup rule types if the necessary file information is not available. - -For example, if `Publisher, Hash` is specified for this parameter, then the hash rules are applied when publisher information is not available. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Security.ApplicationId.PolicyManagement.RuleType] -Parameter Sets: (All) -Aliases: -Accepted values: Publisher, Path, Hash - -Required: False -Position: Named -Default value: Publisher, Hash -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -Specifies the user or group to which the rules are applied. -The acceptable values for this parameter are: - - -- DNS user name (domain\username) - - -- User Principal Name (username@domain.com) - - -- SAM user name (username) - - -- Security identifier (S-1-5-21-3165297888-301567370-576410423-1103) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Xml -Specifies that the output of the AppLocker policy be as an XML-formatted string. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.FileInformation - -## OUTPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.AppLockerPolicy -AppLockerPolicy - -### System.String - -## NOTES - -## RELATED LINKS - -[Get-AppLockerFileInformation](./Get-AppLockerFileInformation.md) - -[Get-AppLockerPolicy](./Get-AppLockerPolicy.md) - -[Set-AppLockerPolicy](./Set-AppLockerPolicy.md) - -[Test-AppLockerPolicy](./Test-AppLockerPolicy.md) - diff --git a/docset/winserver2012-ps/applocker/Set-AppLockerPolicy.md b/docset/winserver2012-ps/applocker/Set-AppLockerPolicy.md deleted file mode 100644 index 5e4579b419..0000000000 --- a/docset/winserver2012-ps/applocker/Set-AppLockerPolicy.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Microsoft.Security.ApplicationId.PolicyManagement.Cmdlets.dll-Help.xml -Module Name: AppLocker -online version: https://learn.microsoft.com/powershell/module/applocker/set-applockerpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-AppLockerPolicy - -## SYNOPSIS -Sets the AppLocker policy for the specified Group Policy Object (GPO). - -## SYNTAX - -### ByXmlPolicy (Default) -``` -Set-AppLockerPolicy [-XmlPolicy] [-Ldap ] [-Merge] [-WhatIf] [-Confirm] [] -``` - -### ByPolicyObject -``` -Set-AppLockerPolicy [-PolicyObject] [-Ldap ] [-Merge] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-AppLockerPolicy cmdlet** sets the specified GPO to contain the specified AppLocker policy. -If no Lightweight Directory Access Protocol (LDAP) is specified, then the default is the local GPO. - -The input values for the AppLocker policy can be an AppLockerPolicy object or an XML-formatted file containing the AppLocker policy. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-AppLockerPolicy -XMLPolicy C:\Policy.xml -``` - -This example sets the local AppLocker policy to the policy specified in C:\Policy.xml. - -### EXAMPLE 2 -``` -PS C:\> Set-AppLockerPolicy -XMLPolicy C:\Policy.xml -LDAP "LDAP://DC13.Contoso.com/CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Contoso,DC=com" -``` - -This example sets the GPO specified in the LDAP path to contain the AppLocker policy that is specified in C:\Policy.xml. - -### EXAMPLE 3 -``` -PS C:\> Get-AppLockerPolicy -Local | Set-AppLockerPolicy -LDAP "LDAP://DC13.Contoso.com/CN={31B2F340-016D-11D2-945F-00C04FB984F9},CN=Policies,CN=System,DC=Contoso,DC=com" -Merge -``` - -This example gets the local AppLocker policy, and then merges the policy with the existing AppLocker policy in the GPO specified in the LDAP path. -See the **Merge** parameter description for more details on how two policies are merged. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ldap -Specifies the LDAP path of the GPO. -It must specify a unique GPO. -If this parameter is not specified, then the local AppLocker policy is set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Merge -Merges the rules in the specified AppLocker policy with the AppLocker rules in the target GPO specified in the LDAP path. -The merging of policies will remove rules with duplicate rule IDs, and the enforcement setting specified by the AppLocker policy in the target GPO will be preserved. -If the **Merge** parameter is not specified, then the new policy will overwrite the existing policy. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyObject -Specifies the **AppLockerPolicy** object that contains the AppLocker policy. -Can be obtained from the Get-AppLockerPolicy and the New-AppLockerPolicy cmdlets. - -```yaml -Type: AppLockerPolicy -Parameter Sets: ByPolicyObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XmlPolicy -Specifies the path where the XML-formatted file containing the AppLocker policy is saved. - -```yaml -Type: String -Parameter Sets: ByXmlPolicy -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.AppLockerPolicy -AppLockerPolicy - -### System.String - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-AppLockerFileInformation](./Get-AppLockerFileInformation.md) - -[Get-AppLockerPolicy](./Get-AppLockerPolicy.md) - -[New-AppLockerPolicy](./New-AppLockerPolicy.md) - -[Test-AppLockerPolicy](./Test-AppLockerPolicy.md) - diff --git a/docset/winserver2012-ps/applocker/Test-AppLockerPolicy.md b/docset/winserver2012-ps/applocker/Test-AppLockerPolicy.md deleted file mode 100644 index 032933a1f2..0000000000 --- a/docset/winserver2012-ps/applocker/Test-AppLockerPolicy.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Security.ApplicationId.PolicyManagement.Cmdlets.dll-Help.xml -Module Name: AppLocker -online version: https://learn.microsoft.com/powershell/module/applocker/test-applockerpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-AppLockerPolicy - -## SYNOPSIS -Specifies the AppLocker policy to determine whether the input files will be allowed to run for a given user. - -## SYNTAX - -### ByXmlPolicy (Default) -``` -Test-AppLockerPolicy [-XmlPolicy] -Path - [-User ] - [-Filter ] - [] -``` - -### ByXmlPolicyAppx -``` -Test-AppLockerPolicy [-XmlPolicy] - -Packages - [-User ] - [-Filter ] - [] -``` - -### ByPolicyObject -``` -Test-AppLockerPolicy [-PolicyObject] -Path - [-User ] - [-Filter ] - [] -``` - -## DESCRIPTION -The **Test-AppLockerPolicy** cmdlet specifies the AppLocker policy to determine whether a list of files is allowed to run on the local computer for a specified user. - -To test AppLocker rules for a nested group, a representative member of the nested group should be specified for the **User** parameter. -For example, a rule that allows the Everyone group to run calc.exe may not appear to apply correctly when the nested Finance group for the **User** parameter is specified. -Instead, a representative member of the Finance group should be specified for the **User** parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Test-AppLockerPolicy -XMLPolicy C:\Policy.xml -Path c:\windows\system32\calc.exe, C:\windows\system32\notepad.exe -User Everyone -``` - -This example reports if calc.exe and notepad.exe will be allowed to run for Everyone under the policy specified by C:\Policy.xml. - -### EXAMPLE 2 -``` -PS C:\>Get-ChildItem C:\windows\system32\*.exe | Test-AppLockerPolicy c:\Policy.xml -Filter DeniedByDefault -``` - -This example lists the executables under C:\Windows\System32 that everyone will be denied by the policy specified by C:\Policy.xml because there is no explicit rule for the file. - -### EXAMPLE 3 -``` -PS C:\>Get-AppLockerPolicy -Local | Test-AppLockerPolicy -Path C:\Windows\System32\*.exe -User contoso\saradavis -Filter Denied | Format-List -Property | Set-Content (ꞌC:\temp\DeniedFiles.txtꞌ) -``` - -This example gets the local AppLocker policy, uses the policy to determine which executables in C:\Windows\System32 that contoso\saradavis is explicitly denied access to run, and then redirects the list to a text file. - -### EXAMPLE 4 -``` -PS C:\>Get-AppxPackage -AllUsers | Test-AppLockerPolicy -XmlPolicy .\SamplePolicy.xml -``` - -This example lists all the packages installed on this computer, for all the users, and tests them against a saved policy. - -## PARAMETERS - -### -Filter -Specifies the policy decision by which to filter the output for each input file. -The acceptable values for this parameter are: Allowed, Denied, DeniedByDefault, or AllowedByDefault. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Security.ApplicationId.PolicyManagement.PolicyDecision] -Parameter Sets: (All) -Aliases: -Accepted values: Allowed, AllowedByDefault, Denied, DeniedByDefault - -Required: False -Position: Named -Default value: All -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Packages -Specifies a list of installed packaged applications, from which the file information is retrieved. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage] -Parameter Sets: ByXmlPolicyAppx -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the list of the file paths to test. -Regular expressions are supported. - -```yaml -Type: System.Collections.Generic.List`1[System.String] -Parameter Sets: ByXmlPolicy, ByPolicyObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PolicyObject -Specifies the Applocker policy. -Can be obtained from the Get-AppLockerPolicy or the New-AppLockerPolicy cmdlet. - -```yaml -Type: AppLockerPolicy -Parameter Sets: ByPolicyObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -User -Defines the user or group to be used for testing the rules in a specified AppLocker policy. -The acceptable values for this parameter are: - - -- DNS user name (`domain\username`) - - -- User Principal Name (`username@domain.com`) - - -- SAM user name (`username`) - - -- Security identifier (`S-1-5-21-3165297888-301567370-576410423-1103`) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Everyone -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XmlPolicy -Specifies the file path and name of the XML-formatted file that contains the AppLocker policy. - -```yaml -Type: String -Parameter Sets: ByXmlPolicy, ByXmlPolicyAppx -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.PolicyModel.AppLockerPolicy -AppLockerPolicy - -## OUTPUTS - -### Microsoft.Security.ApplicationId.PolicyManagement.AppLockerPolicyDecision - -## NOTES - -## RELATED LINKS - -[Get-AppLockerFileInformation](./Get-AppLockerFileInformation.md) - -[Get-AppLockerPolicy](./Get-AppLockerPolicy.md) - -[New-AppLockerPolicy](./New-AppLockerPolicy.md) - -[Set-AppLockerPolicy](./Set-AppLockerPolicy.md) - -[Get-AppxPackage](../appx/Get-AppxPackage.md) - diff --git a/docset/winserver2012-ps/appx/Add-AppxPackage.md b/docset/winserver2012-ps/appx/Add-AppxPackage.md deleted file mode 100644 index ae43ef4be5..0000000000 --- a/docset/winserver2012-ps/appx/Add-AppxPackage.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml -Module Name: Appx -online version: https://learn.microsoft.com/powershell/module/appx/add-appxpackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-AppxPackage - -## SYNOPSIS -Adds a signed app package to a user account. - -## SYNTAX - -### AddSet (Default) -``` -Add-AppxPackage [-Path] [-DependencyPath ] [-ForceApplicationShutdown] [-WhatIf] [-Confirm] - [] -``` - -### RegisterSet -``` -Add-AppxPackage [-Path] [-DependencyPath ] [-Register] [-DisableDevelopmentMode] - [-ForceApplicationShutdown] [-WhatIf] [-Confirm] [] -``` - -### UpdateSet -``` -Add-AppxPackage [-Path] [-DependencyPath ] [-ForceApplicationShutdown] [-Update] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Add-AppxPackage** cmdlet adds a signed app package (.appx) to a user account. -An app package has an .appx file name extension. -Use the *DependencyPath* parameter to add all other packages that are required for the installation of the app package. - -You can use the *Register* parameter to install from a folder of unpackaged files during development of Windows® Store apps. - -To update an already installed package, the new package must have the same package family name. - -## EXAMPLES - -### Example 1: Add an app package -``` -PS C:\>Add-AppxPackage -Path "C:\Users\user1\Desktop\MyApp.appx" -DependencyPath "C:\Users\user1\Desktop\winjs.appx" -``` - -This command adds an app package and the signing certificate that the package contains. - -### Example 2: Add a disabled app package in development mode -``` -PS C:\>$ManifestPath = (Get-AppxPackage -Name "*WindowsCalculator*").InstallLocation + "\Appxmanifest.xml" -PS C:\> Add-AppxPackage -Path $ManifestPath -Register -DisableDevelopmentMode -``` - -This command gets the full path of the package manifest file of an installed Windows Store app, and then registers that package. -You can use *DisableDevelopmentMode* to register an application that is staged by the **StagePackageAsync** API, has been disabled, or has become corrupted during testing. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DependencyPath -Specifies an array of file paths of dependency packages that are required for the installation of the app package. -The app package has an .appx or .appxbundle file name extension. -You can specify the paths to more than one dependency package. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableDevelopmentMode -Indicates that this cmdlet registers an existing app package installation that has been disabled, did not register, or has become corrupted. -Use the current parameter to specify that the manifest is from an existing installation, and not from a collection of files in development mode. -You can also use this parameter to register an application that the Package Manager APIhttp://go.microsoft.com/fwlink/?LinkId=245447 has staged. -Use the *Register* parameter to specify the location of the app package manifest .xml file from the installation location. - -```yaml -Type: SwitchParameter -Parameter Sets: RegisterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceApplicationShutdown -Forces all active processes that are associated with the package or its dependencies to shut down. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the file path of the app package. -An app package has an .appx or .appxbundle file name extension. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: PSPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Register -Indicates that this cmdlet registers an application in development mode. -You can use development mode to install applications from a folder of unpackaged files. -You can use the current parameter to test your Windows® Store apps before you deploy them as app packages. -To register an existing app package installation, you must specify the *DisableDevelopmentMode* parameter and the *Register* parameter. -In order to specify dependency packages, specify the *DependencyPath* parameter and the *DisableDevelopmentMode* parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: RegisterSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Update -Indicates that the package being added is a dependency package update. -A dependency package is removed from the user account when the parent app is removed. -If you do not use this parameter, the package being added is a primary package and is not removed from the user account if the parent app is removed. -To update an already installed package, the new package must have the same package family name. - -```yaml -Type: SwitchParameter -Parameter Sets: UpdateSet -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### System.IO.FileInfo - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[PackageManager class](https://go.microsoft.com/fwlink/?LinkId=245447) - -[Sideload Apps with DISM](https://go.microsoft.com/fwlink/?LinkID=231020) - diff --git a/docset/winserver2012-ps/appx/Appx.md b/docset/winserver2012-ps/appx/Appx.md deleted file mode 100644 index dab43fee5a..0000000000 --- a/docset/winserver2012-ps/appx/Appx.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.2.0 -Locale: en-US -Module Guid: aeef2bef-eba9-4a1d-a3d2-d0b52df76deb -Module Name: Appx ---- - -# Appx Module -## Description -The Windows PowerShell cmdlets for AppX are designed to streamline the administration of AppX package management. - -## Appx Cmdlets -### [Add-AppxPackage](./Add-AppxPackage.md) -Adds a signed app package to a user account. - -### [Get-AppxLastError](./Get-AppxLastError.md) -Get the last error reported in the app package installation logs. - -### [Get-AppxLog](./Get-AppxLog.md) -Gets an app package installation log. - -### [Get-AppxPackage](./Get-AppxPackage.md) -Gets a list of the app packages that are installed in a user profile. - -### [Get-AppxPackageManifest](./Get-AppxPackageManifest.md) -Gets the manifest of an app package. - -### [Remove-AppxPackage](./Remove-AppxPackage.md) -Removes an app package from a user account. - diff --git a/docset/winserver2012-ps/appx/Get-AppxLastError.md b/docset/winserver2012-ps/appx/Get-AppxLastError.md deleted file mode 100644 index 25dc3b3f70..0000000000 --- a/docset/winserver2012-ps/appx/Get-AppxLastError.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml -Module Name: Appx -online version: https://learn.microsoft.com/powershell/module/appx/get-appxlasterror?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppxLastError - -## SYNOPSIS -Get the last error reported in the app package installation logs. - -## SYNTAX - -``` -Get-AppxLastError [] -``` - -## DESCRIPTION -The **Get-AppxLastError** cmdlet gets the last error reported in the app package installation logs for the current Windows PowerShell® session. -An app package has an .appx file name extension. - -## EXAMPLES - -### Example 1: Get the last error -``` -PS C:\>Get-AppxLastError -``` - -This command gets the last error reported in the app installation logs. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### System.Diagnostics.Eventing.Reader.EventLogRecord - -## NOTES - -## RELATED LINKS - -[PackageManager class](https://go.microsoft.com/fwlink/?LinkId=245447) - -[Sideload Apps with DISM](https://go.microsoft.com/fwlink/?LinkID=231020) - diff --git a/docset/winserver2012-ps/appx/Get-AppxLog.md b/docset/winserver2012-ps/appx/Get-AppxLog.md deleted file mode 100644 index c89afcea85..0000000000 --- a/docset/winserver2012-ps/appx/Get-AppxLog.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-help.xml -Module Name: Appx -online version: https://learn.microsoft.com/powershell/module/appx/get-appxlog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppxLog - -## SYNOPSIS -Gets an app package installation log. - -## SYNTAX - -### All (Default) -``` -Get-AppxLog [-All] [] -``` - -### ActivityId -``` -Get-AppxLog [-ActivityId ] [] -``` - -## DESCRIPTION -The **Get-AppxLog** cmdlet gets the app package installation log created during the deployment of an app package. -An app package has an .appx file name extension. -The log contains errors, warnings, and additional information about the processes initiated by cmdlets in the Appx Windows PowerShell® module. - -When Add-AppxPackage or Remove-AppxPackage report a failure, they return the **ActivityID** to use with **Get-AppxLog**. - -For more information about common error codes, see Troubleshooting packaging, deployment, and query of Windows Store appshttp://go.microsoft.com/fwlink/?LinkId=271201. - -## EXAMPLES - -### Example 1: Get logs for the most recent deployment -``` -PS C:\>Get-AppxLog -``` - -This command gets the logs associated with the most recent deployment operation. - -### Example 2: Get logs for all logs -``` -PS C:\>Get-AppxLog -All -``` - -This command gets all of the app package installation logs on the computer. - -## PARAMETERS - -### -ActivityId -Specifies an activity ID. -This cmdlet uses the ID to get the log for a particular app package installation. - -```yaml -Type: String -Parameter Sets: ActivityId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -Indicates that the cmdlet gets all logs on the computer. -You can get additional information when you run this cmdlets from Windows PowerShell as an administrator. - -```yaml -Type: SwitchParameter -Parameter Sets: All -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -## OUTPUTS - -### System.Diagnostics.Eventing.Reader.EventLogRecord - -## NOTES - -## RELATED LINKS - -[PackageManager class](https://go.microsoft.com/fwlink/?LinkId=245447) - -[Sideload Apps with DISM](https://go.microsoft.com/fwlink/?LinkID=231020) - -[Troubleshooting packaging, deployment, and query of Windows Store apps](https://go.microsoft.com/fwlink/?LinkId=271201) - diff --git a/docset/winserver2012-ps/appx/Get-AppxPackage.md b/docset/winserver2012-ps/appx/Get-AppxPackage.md deleted file mode 100644 index 4d8eb82d77..0000000000 --- a/docset/winserver2012-ps/appx/Get-AppxPackage.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml -Module Name: Appx -online version: https://learn.microsoft.com/powershell/module/appx/get-appxpackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppxPackage - -## SYNOPSIS -Gets a list of the app packages that are installed in a user profile. - -## SYNTAX - -``` -Get-AppxPackage [-AllUsers] [[-Name] ] [[-Publisher] ] [-User ] [] -``` - -## DESCRIPTION -The **Get-AppxPackage** cmdlet gets a list of the app packages that are installed in a user profile. -An app package has an .appx file name extension. -To get the list of packages for a user profile other than the profile for the current user, you must run this command by using administrator permissions. - -## EXAMPLES - -### Example 1: Get all app packages for every user account -``` -PS C:\>Get-AppxPackage -AllUsers -``` - -This command lists the app packages that are installed for every user account on the computer. - -### Example 2: Get an app package for a specific a user -``` -PS C:\>Get-AppxPackage -Name "Package17" -User "Contoso\EvanNarvaez" -``` - -This command displays information about Package17 if it is installed in the specified user profile. - -## PARAMETERS - -### -AllUsers -Indicates that this cmdlet lists app packages for all user accounts on the computer. -To use this parameter, you must run the command by using administrator permissions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a particular package. -If you specify this parameter, the cmdlet returns results for this package only. -Wildcards are permitted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Publisher -Specifies the publisher of a particular package. -If you specify this parameter, the cmdlet returns results only for this publisher. -Wildcards are permitted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -User -Specifies a user. -If you specify this parameter, the cmdlet returns a list of app packages that are installed for only the user that this cmdlet specifies. -To get the list of packages for a user profile other than the profile for the current user, you must run this command by using administrator permissions. -The user name can be in one of these formats: - -- domain\user_name -- user_name@fqn.domain.tld -- user_name -- SID-string - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage -This cmdlet returns an **AppxPackage** object that contains information, including the full name of the app package. - -## NOTES - -## RELATED LINKS - -[PackageManager class](https://go.microsoft.com/fwlink/?LinkId=245447) - -[Sideload Apps with DISM](https://go.microsoft.com/fwlink/?LinkID=231020) - diff --git a/docset/winserver2012-ps/appx/Get-AppxPackageManifest.md b/docset/winserver2012-ps/appx/Get-AppxPackageManifest.md deleted file mode 100644 index 0e079de842..0000000000 --- a/docset/winserver2012-ps/appx/Get-AppxPackageManifest.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml -Module Name: Appx -online version: https://learn.microsoft.com/powershell/module/appx/get-appxpackagemanifest?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppxPackageManifest - -## SYNOPSIS -Gets the manifest of an app package. - -## SYNTAX - -``` -Get-AppxPackageManifest [-Package] [[-User] ] [] -``` - -## DESCRIPTION -The **Get-AppxPackageManifest** cmdlet gets the manifest of an app package. -An app package has an .appx file name extension. -The manifest is an .xml document that contains information about the package, like the package ID. - -## EXAMPLES - -### Example 1: Get the manifest for an app package -``` -PS C:\>Get-AppxPackageManifest -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" -``` - -This command gets the manifest for an app package named package1_1.0.0.0_neutral__8wekyb3d8bbwe. - -### Example 2: Get the application ID for an app package -``` -PS C:\>(Get-AppxPackage -Name "*WinJS*" | Get-AppxPackageManifest).package.applications.application.id -``` - -This command gets the application ID for an app package that has the string WinJS in the name. - -### Example 3: Get app capabilities -``` -PS C:\>(Get-AppxPackage -Name "*ZuneMusic*" | Get-AppxPackageManifest).Package.Capabilities -``` - -This command gets the capabilities for an app package that has the string ZuneMusic in the name. - -## PARAMETERS - -### -Package -Specifies an **AppxPackage** object or the full name of a package. -To get the manifest of a package on the computer that is not installed for the current user, you must run this command by using administrator permissions. -Wildcards are permitted. - -```yaml -Type: AppxPackage -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -User -Specifies a user. -This cmdlet gets the manifest of packages that are installed for the user that this parameter specifies. -To get the list of packages for a user profile other than the profile for the current user, you must run this command by using administrator permissions. -The user name can be in one of these formats: - -- domain\user_name -- user_name@fqn.domain.tld -- user_name -- SID-string - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage[] -This cmdlet accepts an array of **AppxPackage** objects that contain information, including the full name of the app package. - -## OUTPUTS - -### System.XML.XMLDocument -This cmdlet returns a read-only .xml document that contains information about the app package, like the package ID. - -## NOTES - -## RELATED LINKS - -[PackageManager class](https://go.microsoft.com/fwlink/?LinkId=245447) - -[Sideload Apps with DISM](https://go.microsoft.com/fwlink/?LinkID=231020) - diff --git a/docset/winserver2012-ps/appx/Remove-AppxPackage.md b/docset/winserver2012-ps/appx/Remove-AppxPackage.md deleted file mode 100644 index 244e0a466b..0000000000 --- a/docset/winserver2012-ps/appx/Remove-AppxPackage.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml -Module Name: Appx -online version: https://learn.microsoft.com/powershell/module/appx/remove-appxpackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-AppxPackage - -## SYNOPSIS -Removes an app package from a user account. - -## SYNTAX - -``` -Remove-AppxPackage [-Package] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-AppxPackage** cmdlet removes an app package from a user account. -An app package has an .appx file name extension. - -## EXAMPLES - -### Example 1: Remove an app package -``` -PS C:\>Remove-AppxPackage -Package "package1_1.0.0.0_neutral__8wekyb3d8bbwe" -``` - -This command removes an app package named package1_1.0.0.0_neutral__8wekyb3d8bbwe from the account of the current user. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Package -Specifies an **AppxPackage** object or the full name of a package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Windows.Appx.PackageManager.Commands.AppxPackage -An **AppxPackage** object that contain information, including the full name of the app package. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[PackageManager class](https://go.microsoft.com/fwlink/?LinkId=245447) - -[Sideload Apps with DISM](https://go.microsoft.com/fwlink/?LinkID=231020) - diff --git a/docset/winserver2012-ps/bestpractices/BestPractices.md b/docset/winserver2012-ps/bestpractices/BestPractices.md deleted file mode 100644 index 27869f0e24..0000000000 --- a/docset/winserver2012-ps/bestpractices/BestPractices.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.2.0.0 -Locale: en-US -Module Guid: 5551ea86-919d-499b-948f-87305e4f2344 -Module Name: BestPractices ---- - -# BestPractices Module -## Description -This reference provides cmdlet descriptions and syntax for all -specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## BestPractices Cmdlets -### [Get-BpaModel](./Get-BpaModel.md) -Retrieves and displays the list of BPA models installed on the system. - -### [Get-BpaResult](./Get-BpaResult.md) -Retrieves and displays the results of the most recent Best Practices Analyzer (BPA) scan for a specific model. - -### [Invoke-BpaModel](./Invoke-BpaModel.md) -Starts a Best Practices Analyzer (BPA) scan for a specific model that is installed on a computer. - -### [Set-BpaResult](./Set-BpaResult.md) -Excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan results. - diff --git a/docset/winserver2012-ps/bestpractices/Get-BpaModel.md b/docset/winserver2012-ps/bestpractices/Get-BpaModel.md deleted file mode 100644 index 45f761a072..0000000000 --- a/docset/winserver2012-ps/bestpractices/Get-BpaModel.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.BestPractices.Cmdlets.dll-Help.xml -Module Name: BestPractices -online version: https://learn.microsoft.com/powershell/module/bestpractices/get-bpamodel?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BpaModel - -## SYNOPSIS -Retrieves and displays the list of BPA models installed on the system. - -## SYNTAX - -### BPANoFilterParameterSet (Default) -``` -Get-BpaModel [-RepositoryPath ] [] -``` - -### BPAFilterParameterSet -``` -Get-BpaModel [-ModelId] [[-SubModelId] ] [-RepositoryPath ] [] -``` - -## DESCRIPTION -The **Get-BpaModel** cmdlet retrieves and displays the list of models that are supported by Best Practices Analyzer (BPA) and installed on the computer. - -If no parameter is specified, then this cmdlet returns all models that are installed on the computer. -If a model is specified by using the **ModelId** parameter, then the specified model is returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BPAModel -Id : Microsoft/Windows/ADRMS -Company : Microsoft Corporation -Name : RightsManagementServices -Version : 1.0 -LastScanTime : Never -LastScanTimeUtcOffset : -SubModels : -Parameters : -ModelType : SingleMachine -SupportedConfiguration : -``` - -This example can be used to return details about the BPA model that is specified in the **ModelId** parameter, represented by ModelID1. -The short form of the **ModelId** parameter can also be used, **Id**. - -### EXAMPLE 2 -``` -PS C:\>Get-BPAModel -Id Last Scan Time ---- -------------- -ModelID1 01/05/2012 10:12 -ModelID2 Never -ModelID3 05/20/2010 12:46 -``` - -This example can be used to return details about BPA scans for all models that are installed on the computer. - -## PARAMETERS - -### -ModelId -Specifies the model ID of the Best Practices Analyzer model for displaying details. -The short form of this parameter can also be used, **Id**. - -This is the identity of the model whose details need to be obtained. - -```yaml -Type: String[] -Parameter Sets: BPAFilterParameterSet -Aliases: Id, BestPracticesModelId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RepositoryPath -Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. - -The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by the ReportsRoot registry key or in the custom location supplied as input to the Invoke-BpaModel cmdlet through this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubModelId -Identifies the submodel to get for the model specified by the **ModelId** parameter. -Example: The Update Services model (`Microsoft/Windows/UpdateServices`) has two submodels (UpdateServices-DB, UpdateServices-Services). - -```yaml -Type: String -Parameter Sets: BPAFilterParameterSet -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.BestPractices.CoreInterface.Model - -## NOTES - -## RELATED LINKS - -[Get-BpaResult](./Get-BpaResult.md) - -[Invoke-BpaModel](./Invoke-BpaModel.md) - -[Set-BpaResult](./Set-BpaResult.md) - diff --git a/docset/winserver2012-ps/bestpractices/Get-BpaResult.md b/docset/winserver2012-ps/bestpractices/Get-BpaResult.md deleted file mode 100644 index 972bfea582..0000000000 --- a/docset/winserver2012-ps/bestpractices/Get-BpaResult.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: Microsoft.BestPractices.Cmdlets.dll-Help.xml -Module Name: BestPractices -online version: https://learn.microsoft.com/powershell/module/bestpractices/get-bparesult?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BpaResult - -## SYNOPSIS -Retrieves and displays the results of the most recent Best Practices Analyzer (BPA) scan for a specific model. - -## SYNTAX - -### ModelParameterSet (Default) -``` -Get-BpaResult [-ModelId] [-CollectedConfiguration] [-All] [-Filter ] - [-RepositoryPath ] [] -``` - -### SubModelParameterSet -``` -Get-BpaResult [-ModelId] [-CollectedConfiguration] [-All] [-Filter ] - [-RepositoryPath ] [-SubModelId ] [-ComputerName ] [-Context ] - [] -``` - -## DESCRIPTION -The **Get-BpaResult** cmdlet retrieves and displays the results of the latest Best Practices Analyzer (BPA) scan for a specific model that is installed on a computer. -To use this cmdlet, add the **ModelId** parameter, and specify the model identifier (ID) for which to view the most recent BPA scan results. -The **All** parameter can be used to retrieve all of the scanned results for a particular model. -If the **All** parameter is not specified, then the most recent results of the particular model are returned. - -This cmdlet can be used to view the results of a BPA scan for a specific model. -An administrator specifies a model ID as a parameter and the latest results for that model are displayed. - -Note: This cmdlet does not start a new BPA scan. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-BPAResult -ModelId ModelId1 -``` - -This example returns the most recent Best Practices Analyzer scan results for the model that is represented by ModelId1. -The short form of the **ModelId** parameter can also be used, **Id**. - -### EXAMPLE 2 -``` -PS C:\> Get-BPAModel | Get-BPAResult -``` - -This example, the Get-BpaModel cmdlet is used to return a list of all BPA models that are installed on the computer. -The results of the Get-BpaModel cmdlet are piped to this cmdlet to retrieve the most recent Best Practices Analyzer scan results for all models that are supported by BPA. - -## PARAMETERS - -### -All -Returns the output type Reports. -This parameter can be used to retrieve all of the scanned results for a particular model. -If this parameter is not specified, then the most recent results of the particular model are returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CollectedConfiguration -Returns only discovery information that was collected during a BPA scan, not the results of evaluating rules in the model. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the target computer from which to retrieve BPA results. - -```yaml -Type: String[] -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Scans a submodel in the context of a specific model (one that is different from the parent model of the submodel). -Example: an administrator wants to run a scan on the Backend submodel of the SQL model, but only those in the context of a third model, a technology that relies upon SQL Server. - -```yaml -Type: String -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Filters the type of result to return. -The acceptable values for this parameter are: All, Compliant, or Noncompliant. - -```yaml -Type: FilterOptions -Parameter Sets: (All) -Aliases: -Accepted values: All, Compliant, Noncompliant - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModelId -Identifies the model from which results need to be obtained. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Id, BestPracticesModelId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RepositoryPath -Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. - -The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location contained in the ReportsRoot registry key or in the custom location supplied as the value of this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubModelId -Identifies the submodel for the model specified by the **ModelId** parameter. -Example: The Update Services model (`Microsoft/Windows/UpdateServices`) has two submodels (UpdateServices-DB, UpdateServices-Services). - -```yaml -Type: String -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String - -## OUTPUTS - -### Microsoft.BestPractices.CoreInterface.Report - -### Microsoft.BestPractices.CoreInterface.Result - -## NOTES - -## RELATED LINKS - -[Get-BpaModel](./Get-BpaModel.md) - -[Invoke-BpaModel](./Invoke-BpaModel.md) - -[Set-BpaResult](./Set-BpaResult.md) - diff --git a/docset/winserver2012-ps/bestpractices/Invoke-BpaModel.md b/docset/winserver2012-ps/bestpractices/Invoke-BpaModel.md deleted file mode 100644 index e90cdfad11..0000000000 --- a/docset/winserver2012-ps/bestpractices/Invoke-BpaModel.md +++ /dev/null @@ -1,345 +0,0 @@ ---- -external help file: Microsoft.BestPractices.Cmdlets.dll-Help.xml -Module Name: BestPractices -online version: https://learn.microsoft.com/powershell/module/bestpractices/invoke-bpamodel?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-BpaModel - -## SYNOPSIS -Starts a Best Practices Analyzer (BPA) scan for a specific model that is installed on a computer. - -## SYNTAX - -### ModelParameterSet (Default) -``` -Invoke-BpaModel [-ModelId] [-RepositoryPath ] [-Mode ] [] -``` - -### SubModelParameterSet -``` -Invoke-BpaModel [-ModelId] [-RepositoryPath ] [-Mode ] [-SubModelId ] - [-Context ] [-ComputerName ] [-CertificateThumbprint ] [-ConfigurationName ] - [-Credential ] [-Authentication ] [-Port ] - [-ThrottleLimit ] [-UseSsl] [] -``` - -## DESCRIPTION -The **Invoke-BpaModel** cmdlet starts a Best Practices Analyzer (BPA) scan for a specific model that is installed on a Windows-based computer. -The model is specified either by using the **ModelId** parameter, or by piping the results of the Get-BpaModel cmdlet into this cmdlet. -If a model is specified in the cmdlet after the BPA scan has been performed, then the results of the scan are available as an XML file. - -This cmdlet cannot be canceled after it has been started. - -Single-node XML is not supported by the BPA model schema. -For more information about what is supported by the BPA model schema, see the Microsoft Baseline Configuration Analyzer Model Authoring Guide on the Microsoft Download Centerhttp://www.microsoft.com/download/details.aspx?id=16475. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Invoke-BPAModel -ModelId ModelId1 -``` - -This example starts a BPA scan on the model that is represented by ModelId1. - -The same task can be completed by running any of the following cmdlets. -`Invoke-BPAModel -ModelId ModelId1` - -- OR - -`Invoke-BPAModel -Id ModelId1` - -- OR - -`Invoke-BPAModel ModelId1` - -### EXAMPLE 2 -``` -PS C:\>Invoke-BPAModel -ModelId ModelId1 -ArgumentTable @{context=domain; name=contoso.com;} -``` - -This example starts a BPA scan on the specified model ID. -The **ArgumentTable** parameter helps the administrator start a BPA scan with additional model-specific instructions. -In this example, the values of additional and required model parameters are specified by using the **ArgumentTable** parameter. -The scan is focused only on those parts of the model that occur in the contoso.com domain. - -### EXAMPLE 3 -``` -PS C:\>Get-BPAModel | Invoke-BPAModel -``` - -This example gets all BPA models that are installed on the computer, and then pipes the results of the Get-BPAModel cmdlet to this cmdlet to start a BPA scan on all models. - -### EXAMPLE 4 -``` -PS C:\>$BPAObj = Invoke-BPAModel ModelId1 - - -This cmdlet displays the results of any specific object in the previous cmdlet by calling the variable into which the results of the previous cmdlet were saved, and then specifying the object in the results that the administrator wants. The object is identified by its numerical order in the collection of results (the [CODE_Snippit]0[CODE_Snippit], or first, object). The cmdlet then identifies which field of the results in that object (for this example, the Detail field) the administrator wants to view. The cmdlet shown returns the properties of the Detail field from the first object in the results of the preceding line. -PS C:\>$BPAObj[0].Detail -ModelId : ModelId1 -Success : True -ScanTime : 10/21/2008 3:08:47 PM -InformationMessages : 5 -WarningMessages : 4 -ErrorMessages : 0 -Description : -``` - -This example starts a BPA scan on the model specified by ModelId1, and saves the results of the cmdlet as a variable, BPAObj. - -## PARAMETERS - -### -Authentication -Specifies the authentication mode to use when creating a remote connection for running a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: AuthenticationMechanism -Parameter Sets: SubModelParameterSet -Aliases: -Accepted values: Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Specifies the certificate thumbprint to use when creating a remote connection via SSL for running a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: String -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the target computer against which to run the BPA scan. - -```yaml -Type: String[] -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the session configuration, such as the name of the endpoint, to use when creating a session for a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: String -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Scans a submodel in the context of a specific model (one that is different from the parent model of the submodel). -Example: an administrator wants to run a scan on the Backend submodel of the SQL model, but only those in the context of a third model, a technology that relies upon SQL Server. - -```yaml -Type: String -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials to use when creating a remote connection for running a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: PSCredential -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the mode to use when running the BPA scan. -The acceptable values for this parameter are: All, Analysis, or Discovery. - -```yaml -Type: ScanMode -Parameter Sets: (All) -Aliases: -Accepted values: All, Discovery, Analysis - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ModelId -Identities the model to be used for the BPA scan. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Id, BestPracticesModelId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Port -Specifies the port to use when creating a remote connection for running a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: Int32 -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryPath -Specifies that the default location for reports specified by the ReportsRoot registry key should be overridden. -This parameter specifies the path where the results should be stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubModelId -Identifies the submodel to run for the model specified by the **ModelId** parameter. -Example: The Update Services model (`Microsoft/Windows/UpdateServices`) has two submodels (UpdateServices-DB, UpdateServices-Services). - -```yaml -Type: String -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the throttle limit to use when creating a remote connection for running a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: Int32 -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSsl -Specifies whether or not to use SSL when creating a remote connection for running a remote BPA scan. - -For more information, run the following cmdlet. - - - `Get-Help Invoke-Command` - -```yaml -Type: SwitchParameter -Parameter Sets: SubModelParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String -The input string specified by the **ModelId** parameter. - -## OUTPUTS - -### System.Collections.Generic.List -The output object encapsulates the results of the cmdlet that is entered. -The output object contains information such as the BPA model ID, the success or failure of the cmdlet, and other details. - -## NOTES - -## RELATED LINKS - -[Get-BpaModel](./Get-BpaModel.md) - -[Get-BpaResult](./Get-BpaResult.md) - -[Set-BpaResult](./Set-BpaResult.md) - diff --git a/docset/winserver2012-ps/bestpractices/Set-BpaResult.md b/docset/winserver2012-ps/bestpractices/Set-BpaResult.md deleted file mode 100644 index beb826c76f..0000000000 --- a/docset/winserver2012-ps/bestpractices/Set-BpaResult.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.BestPractices.Cmdlets.dll-Help.xml -Module Name: BestPractices -online version: https://learn.microsoft.com/powershell/module/bestpractices/set-bparesult?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-BpaResult - -## SYNOPSIS -Excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan results. - -## SYNTAX - -``` -Set-BpaResult [[-Exclude] ] - [-Results] - [[-RepositoryPath] ] [] -``` - -## DESCRIPTION -The **Set-BPAResult** cmdlet excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan results. -The action specified in this cmdlet (such as **Exclude**) determines how the existing results of a BPA scan are updated. -This cmdlet is typically applied after using the Get-BpaResult cmdlet to return a collection of scan results. -Filters can be applied to results returned by the Get-BpaResult cmdlet, and then pipe the filtered collection of results to this cmdlet, specifying either to include or exclude filtered scan results. - -This will update the results in the result file with the specified result collection with the action specified. -The administrator would generally need to call the Get-BpaResult cmdlet prior to this to get the result collection, apply some filters and pipe the collection to this cmdlet specifying the action (exclusion or inclusion). - -If this cmdlet is canceled before the results are written to a file, then the operation is canceled and the results file is not modified. -If cancellation occurs after the results file has been modified, then the actions of the cmdlet are carried out, and the cmdlet cannot be canceled. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BPAResult -ModelId ModelId1 | Where-Object -FilterScript { $_.Category -Eq "Performance" } | Set-BPAResult -ModelId ModelId1 -Exclude $true -``` - -This example, to the left of the first pipe character (`|`), uses the Get-BpaResult cmdlet to retrieve Best Practices Analyzer scan results for the model ID represented by ModelId1. -The second section of the cmdlet filters the results of the Get-BpaResult cmdlet to get only those scan results for which the category name is equal to Performance. -The final section of the example, following the second pipe character, excludes the Performance results filtered by the previous section of the example. - -### EXAMPLE 2 -``` -The variable $rcPolicy is created to store the filtered results of the Get-BpaResult cmdlet; this variable can be used in subsequent cmdlets to represent those results. -PS C:\>$rcPolicy = Get-BPAResult -ModelId ModelId1 | Where-Object -FilterScript { $_.Category -Eq "Policy" } - -The second line of the example uses this cmdlet to exclude the set of results stored in the $rcPolicy variable, for the specified model ID. In this cmdlet, the **Results** parameter is added because the administrator wants to exclude a specific subset of scan results for that model, and has created the variable $rcPolicy to represent that subset of results. -PS C:\>Set-BPAResult -ModelId ModelId1 -Exclude $true -Results $rcPolicy -``` - -This example, to the left of the pipe character (`|`), instructs the Get-BpaResult cmdlet to retrieve Best Practices Analyzer scan results for the model represented by ModelId1 The second section of the example, after the pipe character, filters the results of the Get-BpaResult cmdlet to return only those scan results for which the category name is equal to (note the Eq option) Policy. - -## PARAMETERS - -### -Exclude -Removes any BPA scan results that are specified by a filter added to this cmdlet. -The Exclude action applies to all results returned by this cmdlet. -To exclude results by using this parameter, add the value `$true` following the parameter, as shown: - - - `-Exclude $true` - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RepositoryPath -Specifies the location where the report should be stored. - -The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by ReportsRoot registry key or in a custom location supplied as input to this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Results -Specifies the result collection to be updated in the result file returned by this cmdlet. -This parameter is typically used to specify a filtered subset of scan results that has already been stored in a variable; the variable name is provided as the valid value for this parameter. - -This is the result collection which needs to be updated in the result file. -Example: if a variable named `$allPerformance` is created to store all the Performance category results for a BPA scan of all roles on a computer, and to exclude those Performance results from the complete collection of scan results, add the following parameter to this cmdlet. - - - `-Results $allPerformance` - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.BestPractices.CoreInterface.Result] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List -The input object specified by the **Results** parameter. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Get-BpaModel](./Get-BpaModel.md) - -[Get-BpaResult](./Get-BpaResult.md) - -[Invoke-BpaModel](./Invoke-BpaModel.md) - diff --git a/docset/winserver2012-ps/bitlocker/Add-BitLockerKeyProtector.md b/docset/winserver2012-ps/bitlocker/Add-BitLockerKeyProtector.md deleted file mode 100644 index ccfc0f6223..0000000000 --- a/docset/winserver2012-ps/bitlocker/Add-BitLockerKeyProtector.md +++ /dev/null @@ -1,466 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/add-bitlockerkeyprotector?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-BitLockerKeyProtector - -## SYNOPSIS -Adds a key protector for a BitLocker volume. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-BitLockerKeyProtector [-ADAccountOrGroup] [-Service] [-ADAccountOrGroupProtector] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-BitLockerKeyProtector [-MountPoint] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-BitLockerKeyProtector [[-Password] ] [-PasswordProtector] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-BitLockerKeyProtector [-StartupKeyPath] [[-Pin] ] [-TpmAndPinAndStartupKeyProtector] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Add-BitLockerKeyProtector [[-Pin] ] [-TpmAndPinProtector] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Add-BitLockerKeyProtector [-RecoveryKeyPath] [-RecoveryKeyProtector] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_7 -``` -Add-BitLockerKeyProtector [[-RecoveryPassword] ] [-RecoveryPasswordProtector] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_8 -``` -Add-BitLockerKeyProtector [-StartupKeyPath] [-StartupKeyProtector] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_9 -``` -Add-BitLockerKeyProtector [-StartupKeyPath] [-TpmAndStartupKeyProtector] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_10 -``` -Add-BitLockerKeyProtector [-TpmProtector] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-BitLockerKeyProtector** cmdlet adds a protector for the volume key of the volume protected with BitLocker Drive Encryption. - -When a user accesses a drive protected by BitLocker, such as when starting a computer, BitLocker requests the relevant key protector. -For example, the user can enter a PIN or provide a USB drive that contains a key. -BitLocker retrieves the encryption key and uses it to read data from the drive. - -You can use one of the following methods or combinations of methods for a key protector: - -- Trusted Platform Module (TPM). -BitLocker uses the computer's TPM to protect the encryption key. -If you specify this protector, users can access the encrypted drive as long as it is connected to the system board that hosts the TPM and the system boot integrity is intact. -In general, TPM-based protectors can only be associated to an operating system volume. -- TPM and Personal Identification Number (PIN). -BitLocker uses a combination of the TPM and a user-supplied PIN. -A PIN is four to twenty digits or, if you allow enhanced PINs, four to twenty letters, symbols, spaces, or numbers. -- TPM, PIN, and startup key. -BitLocker uses a combination of the TPM, a user-supplied PIN, and input from of a USB memory device that contains an external key. -- TPM and startup key. -BitLocker uses a combination of the TPM and input from of a USB memory device. -- Startup key. -BitLocker uses input from of a USB memory device that contains the external key. -- Password. -BitLocker uses a password. -- Recovery key. -BitLocker uses a recovery key stored as a specified file in a USB memory device. -- Recovery password. -BitLocker uses a recovery password. -- Active Directory Domain Services (AD DS) account. -BitLocker uses domain authentication to unlock data volumes. -Operating system volumes cannot use this type of key protector. - -You can add only one of these methods or combinations at a time, but you can run this cmdlet more than once on a volume. - -Adding a key protector is a single operation; for example, adding a startup key protector to a volume that uses the TPM and PIN combination as a key protector results in two key protectors, not a single key protector that uses TPM, PIN, and startup key. -Instead, add a protector that uses TPM, PIN, and startup key and then remove the TPM and PIN protector by using the Remove-BitLockerKeyProtector cmdlet. - -For a password or PIN key protector, specify a secure string. -You can use the **ConvertTo-SecureString** cmdlet to create a secure string. -You can use secure strings in a script and still maintain confidentiality of passwords. - -This cmdlet returns a BitLocker volume object. -If you choose recovery password as your key protector but do not specify a 48-digit recovery password, this cmdlet creates a random 48-bit recovery password. -The cmdlet stores the password as the **RecoveryPassword** field of the **KeyProtector** attribute of the BitLocker volume object. - -If you use startup key or recovery key as part of your key protector, provide a path to store the key. -This cmdlet stores the name of the file that contains the key in the **KeyFileName** field of the **KeyProtector** field in the BitLocker volume object. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Add key protector -``` -PS C:\>$SecureString = ConvertTo-SecureString "1234" -AsPlainText -Force PS C:\>Add-BitLockerProtector -MountPoint "C:" -Pin $SecureString -TPMandPinProtector -``` - -This example adds a combination of the TPM and a PIN as key protector for the BitLocker volume identified with the drive letter C:. - -The first command uses the **ConvertTo-SecureString** cmdlet to create a secure string that contains a PIN and saves that string in the $SecureString variable. -For more information about the **ConvertTo-SecureString** cmdlet, type `Get-Help ConvertTo-SecureString`. - -The second command adds a protector to the BitLocker volume that has the drive letter C:. -The command specifies that this volume uses a combination of the TPM and the PIN as key protector and provides the PIN saved in the $SecureString variable. - -### Example 2: Add a recovery key for all BitLocker volumes -``` -PS C:\>Get-BitLockerVolume | Add-BitLockerKeyProtector -RecoveryKeyPath "E:\Recovery\" -RecoveryKeyProtector -``` - -This command gets all the BitLocker volumes for the current computer and passes them to the Add-BitLockerKeyProtector**** cmdlet by using the pipe operator. -This cmdlet specifies a path to a folder where the randomly generated recovery key will be stored and indicates that these volumes use a recovery key as a key protector. - -### Example 3: Add credentials as a key protector -``` -PS C:\>Add-BitLockerKeyProtector -MountPoint "C:" -AdAccountOrGroup "Western\SarahJones" -AdAccountOrGroupProtector -``` - -This command adds an AD DS account key protector to the BitLocker volume specified by the **MountPoint** parameter. -The command specifies an account and specifies that BitLocker uses user credentials as a key protector. -When a user accesses this volume, BitLocker prompts for credentials for the user account Western\SarahJones. - -## PARAMETERS - -### -ADAccountOrGroup -Specifies an account using the format **Domain\User**. -This cmdlet adds the account you specify as a key protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: sid - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADAccountOrGroupProtector -Indicates that BitLocker uses an AD DS account as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: sidp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -This cmdlet adds a key protector to the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies a secure string object that contains a password. -The cmdlet adds the password specified as a protector for the volume encryption key. - -```yaml -Type: SecureString -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: pw - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordProtector -Indicates that BitLocker uses a password as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: pwp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pin -Specifies a secure string object that contains a PIN. -The cmdlet adds the PIN specified, with other data, as a protector for the volume encryption key. - -```yaml -Type: SecureString -Parameter Sets: UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: p - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryKeyPath -Specifies a path to a folder. -This cmdlet adds a randomly generated recovery key as a protector for the volume encryption key and stores it in the specified path. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: rk - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryKeyProtector -Indicates that BitLocker uses a recovery key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: rkp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPassword -Specifies a recovery password. -If you do not specify this parameter, the cmdlet creates a random password. -You can enter a 48 digit password. -The cmdlet adds the password specified or created as a protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: rp - -Required: False -Position: 2 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPasswordProtector -Indicates that BitLocker uses a recovery password as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: rpp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Indicates that the system account for this computer unlocks the encrypted volume. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartupKeyPath -Specifies a path to a startup key. -The cmdlet adds the key stored in the specified path as a protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9 -Aliases: sk - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartupKeyProtector -Indicates that BitLocker uses a startup key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: skp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmAndPinAndStartupKeyProtector -Indicates that BitLocker uses a combination of TPM, a PIN, and a startup key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: tpskp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmAndPinProtector -Indicates that BitLocker uses a combination of TPM and a PIN as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: tpp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmAndStartupKeyProtector -Indicates that BitLocker uses a combination of TPM and a startup key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_9 -Aliases: tskp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmProtector -Indicates that BitLocker uses TPM as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_10 -Aliases: tpmp - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], string[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Backup-BitLockerKeyProtector](./Backup-BitLockerKeyProtector.md) - -[Remove-BitLockerKeyProtector](./Remove-BitLockerKeyProtector.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - -[Enable-BitLocker](./Enable-BitLocker.md) - diff --git a/docset/winserver2012-ps/bitlocker/Backup-BitLockerKeyProtector.md b/docset/winserver2012-ps/bitlocker/Backup-BitLockerKeyProtector.md deleted file mode 100644 index 9dd396cc3e..0000000000 --- a/docset/winserver2012-ps/bitlocker/Backup-BitLockerKeyProtector.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/backup-bitlockerkeyprotector?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Backup-BitLockerKeyProtector - -## SYNOPSIS -Saves a key protector for a BitLocker volume in AD DS. - -## SYNTAX - -``` -Backup-BitLockerKeyProtector [-MountPoint] [-KeyProtectorId] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Backup-BitLockerKeyProtector** cmdlet saves a recovery password key protector for a volume protected by BitLocker Drive Encryption to Active Directory Domain Services (AD DS). -Specify a key to be saved by ID. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Save a key protector for a volume -``` -PS C:\> $BLV = Get-BitLockerVolume -MountPoint "C:" PS C:\>Backup-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId $BLV.KeyProtector[1] -``` - -This example saves a key protector for a specified BitLocker volume. - -The first command uses Get-BitLockerVolume to obtain a BitLocker volume and store it in the $BLV variable. - -The second command backs up the key protector for the BitLocker volume specified by the **MountPoint** parameter. -The command specifies the key protector by using its ID, contained in the BitLocker object stored in $BLV. -The **KeyProtector** attribute contains an array of key protectors associated to the volume. -This command uses standard array syntax to index the **KeyProtector** object. -The key protector that corresponds to the recovery password key protector can be identified by using the **KeyProtectorType** attribute in the **KeyProtector** object. - -### Example 2: Save a key protector using an ID -``` -PS C:\> Backup-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId "{E2611001E-6AD0-4A08-BAAA-C9c031DB2AA6}" -``` - -This command saves a key protector for a specified BitLocker volume to AD DS. -The command specifies the key protector by using its ID. - -## PARAMETERS - -### -KeyProtectorId -Specifies the ID for a key protector or a **KeyProtector** object. -A BitLocker volume object includes a **KeyProtector** object. -You can specify the key protector object itself, or you can specify the ID. -See the Examples section. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet saves key protectors for the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume, String - -## OUTPUTS - -### BitLockerVolume - -## NOTES - -## RELATED LINKS - -[Add-BitLockerKeyProtector](./Add-BitLockerKeyProtector.md) - -[Remove-BitLockerKeyProtector](./Remove-BitLockerKeyProtector.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/BitLocker.md b/docset/winserver2012-ps/bitlocker/BitLocker.md deleted file mode 100644 index 0ab138d0fd..0000000000 --- a/docset/winserver2012-ps/bitlocker/BitLocker.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 0ff02bb8-300a-4262-ac08-e06dd810f1b6 -Module Name: BitLocker ---- - -# BitLocker Module -## Description -This reference provides cmdlet descriptions and syntax for all BitLocker cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## BitLocker Cmdlets -### [Add-BitLockerKeyProtector](./Add-BitLockerKeyProtector.md) -Adds a key protector for a BitLocker volume. - -### [Backup-BitLockerKeyProtector](./Backup-BitLockerKeyProtector.md) -Saves a key protector for a BitLocker volume in AD DS. - -### [Clear-BitLockerAutoUnlock](./Clear-BitLockerAutoUnlock.md) -Removes BitLocker automatic unlocking keys. - -### [Disable-BitLocker](./Disable-BitLocker.md) -Disables BitLocker encryption for a volume. - -### [Disable-BitLockerAutoUnlock](./Disable-BitLockerAutoUnlock.md) -Disables automatic unlocking for a BitLocker volume. - -### [Enable-BitLocker](./Enable-BitLocker.md) -Enables encryption for a BitLocker volume. - -### [Enable-BitLockerAutoUnlock](./Enable-BitLockerAutoUnlock.md) -Enables automatic unlocking for a BitLocker volume. - -### [Get-BitLockerVolume](./Get-BitLockerVolume.md) -Gets information about volumes that BitLocker can protect. - -### [Lock-BitLocker](./Lock-BitLocker.md) -Prevents access to encrypted data on a BitLocker volume. - -### [Remove-BitLockerKeyProtector](./Remove-BitLockerKeyProtector.md) -Removes a key protector for a BitLocker volume. - -### [Resume-BitLocker](./Resume-BitLocker.md) -Restores Bitlocker encryption for the specified volume. - -### [Suspend-BitLocker](./Suspend-BitLocker.md) -Suspends Bitlocker encryption for the specified volume. - -### [Unlock-BitLocker](./Unlock-BitLocker.md) -Restores access to data on a BitLocker volume. - diff --git a/docset/winserver2012-ps/bitlocker/Clear-BitLockerAutoUnlock.md b/docset/winserver2012-ps/bitlocker/Clear-BitLockerAutoUnlock.md deleted file mode 100644 index fe1ed8ca59..0000000000 --- a/docset/winserver2012-ps/bitlocker/Clear-BitLockerAutoUnlock.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/clear-bitlockerautounlock?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-BitLockerAutoUnlock - -## SYNOPSIS -Removes BitLocker automatic unlocking keys. - -## SYNTAX - -``` -Clear-BitLockerAutoUnlock -``` - -## DESCRIPTION -The **Clear-BitLockerAutoUnlock** cmdlet removes all automatic unlocking keys used by BitLocker Drive Encryption. -BitLocker stores these keys for the fixed data drives of a system on a volume that hosts a BitLocker-enabled operating system volume so that it can automatically unlock the fixed and removable data volumes in a system. -This makes it easier for users to access data volumes. - -You can configure BitLocker to automatically unlock volumes that do not host an operating system. -After a user unlocks the operating system volume, BitLocker uses encrypted information stored in the registry and volume metadata to unlock any data volumes that use automatic unlocking. - -You must remove automatic unlocking keys before you can disable BitLocker by using the Disable-BitLocker cmdlet. -You can use the Disable-BitLockerAutoUnlock cmdlet to remove keys for specific volumes that use automatic unlocking instead of all volumes. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Clear automatic unlocking keys -``` -PS C:\>Clear-BitLockerAutoUnlock -``` - -This command clears all automatic unlocking keys stored on the current computer. - -## PARAMETERS - -## INPUTS - -### String - -## OUTPUTS - -### BitLockerVolume - -## NOTES - -## RELATED LINKS - -[Disable-BitLockerAutoUnlock](./Disable-BitLockerAutoUnlock.md) - -[Enable-BitLockerAutoUnlock](./Enable-BitLockerAutoUnlock.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Disable-BitLocker.md b/docset/winserver2012-ps/bitlocker/Disable-BitLocker.md deleted file mode 100644 index fe4bc28734..0000000000 --- a/docset/winserver2012-ps/bitlocker/Disable-BitLocker.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/disable-bitlocker?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-BitLocker - -## SYNOPSIS -Disables BitLocker encryption for a volume. - -## SYNTAX - -``` -Disable-BitLocker [-MountPoint] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-BitLocker** cmdlet disables BitLocker Drive Encryption for a BitLocker volume. -When you run this cmdlet, it removes all key protectors and begins decrypting the content of the volume. - -If the volume that hosts the operating system contains any automatic unlocking keys, the cmdlet does not proceed. -You can use the Clear-BitLockerAutoUnlock cmdlet to remove all automatic unlocking keys. -Then you can disable BitLocker for the volume. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Disable BitLocker for a volume -``` -PS C:\> Disable-BitLocker -MountPoint "C:" -``` - -This command disables BitLocker for the specified BitLocker volume. -BitLocker begins decrypting data on C: immediately. - -### Example 2: Disable BitLocker for all volumes -``` -PS C:\>$BLV = Get-BitLockerVolume PS C:\>Disable-BitLocker -MountPoint $BLV -``` - -This example disables BitLocker encryption for all volumes. - -The first command uses Get-BitLockerVolume to get all the BitLocker volumes for the current computer and stores them in the $BLV variable. - -The second command disables BitLocker encryption for all the BitLocker volumes stored in the $BLV variable. -BitLocker begins decrypting data on the volumes. - -## PARAMETERS - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet disables protection for the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Enable-BitLocker](./Enable-BitLocker.md) - -[Lock-BitLocker](./Lock-BitLocker.md) - -[Resume-BitLocker](./Resume-BitLocker.md) - -[Suspend-BitLocker](./Suspend-BitLocker.md) - -[Unlock-BitLocker](./Unlock-BitLocker.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Disable-BitLockerAutoUnlock.md b/docset/winserver2012-ps/bitlocker/Disable-BitLockerAutoUnlock.md deleted file mode 100644 index df17dafefc..0000000000 --- a/docset/winserver2012-ps/bitlocker/Disable-BitLockerAutoUnlock.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/disable-bitlockerautounlock?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-BitLockerAutoUnlock - -## SYNOPSIS -Disables automatic unlocking for a BitLocker volume. - -## SYNTAX - -``` -Disable-BitLockerAutoUnlock [-MountPoint] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-BitLockerAutoUnlock** cmdlet disables automatic unlocking for a volume protected by BitLocker Disk Encryption. -The cmdlet removes automatic unlocking keys for specified volumes stored on a volume that hosts an operating system. - -You can configure BitLocker to automatically unlock volumes that do not host an operating system. -After a user unlocks the operating system volume, BitLocker uses encrypted information stored in the registry and volume metadata to access data volumes that use automatic unlocking. - -You can specify a volume by drive letter, or you can specify a BitLocker volume object. -You must remove automatic unlocking keys before you can disable BitLocker by using the Disable-BitLocker cmdlet. -You can use the Clear-BitLockerAutoUnlock cmdlet to remove keys for all the volumes configured to use automatic unlocking instead of just specified volumes. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Disable automatic unlocking for a volume -``` -PS C:\> Disable-AutoUnlock -MountPoint "E:" -``` - -This command disables automatic unlocking for the specified BitLocker volume. - -## PARAMETERS - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet disables automatic unlocking for the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Clear-BitLockerAutoUnlock](./Clear-BitLockerAutoUnlock.md) - -[Enable-BitLockerAutoUnlock](./Enable-BitLockerAutoUnlock.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Enable-BitLocker.md b/docset/winserver2012-ps/bitlocker/Enable-BitLocker.md deleted file mode 100644 index 7962836012..0000000000 --- a/docset/winserver2012-ps/bitlocker/Enable-BitLocker.md +++ /dev/null @@ -1,622 +0,0 @@ ---- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. -external help file: BitLocker-help.xml -Module Name: BitLocker -ms.date: 12/14/2021 -online version: https://learn.microsoft.com/powershell/module/bitlocker/enable-bitlocker?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 -title: Enable-BitLocker ---- - -# Enable-BitLocker - -## SYNOPSIS - -Enables BitLocker Drive Encryption for a volume. - -## SYNTAX - -### PasswordProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -PasswordProtector [-Password] -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly][-WhatIf] [-Confirm] [] -``` - -### RecoveryPasswordProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -RecoveryPasswordProtector [[-RecoveryPassword] ] -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -### StartupKeyProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -StartupKeyProtector [-StartupKeyPath] -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -### TpmAndStartupKeyProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -TpmAndStartupKeyProtector [-StartupKeyPath] -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -### TpmAndPinAndStartupKeyProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -TpmAndPinAndStartupKeyProtector -StartupKeyPath -[-Pin] [-EncryptionMethod ] -[-HardwareEncryption] [-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] -[] -``` - -### AdAccountOrGroupProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -AdAccountOrGroupProtector [-AdAccountOrGroup] -[-Service] [-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -### TpmAndPinProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -TpmAndPinProtector [-Pin] -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -### TpmProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -TpmProtector -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -### RecoveryKeyProtector - -```PowerShell -Enable-BitLocker [-MountPoint] -RecoveryKeyProtector [-RecoveryKeyPath] -[-EncryptionMethod ] [-HardwareEncryption] -[-SkipHardwareTest] [-UsedSpaceOnly] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION - -The **Enable-BitLocker** cmdlet enables BitLocker Drive Encryption for a volume. - -When you enable encryption, you must specify a volume, either by its drive letter or by its -BitLocker volume object. - -You must also establish a key protector. BitLocker uses a key protector to encrypt the volume -encryption key. When a user accesses a BitLocker encrypted drive, such as when starting a computer, -BitLocker requests the relevant key protector. For example, the user can enter a PIN or provide a -USB drive that contains a key. BitLocker decrypts the encryption key and uses it to read data from -the drive. You can use one of the following methods or combinations of methods for a key protector: - -- **Trusted Platform Module (TPM):** BitLocker uses the computer's TPM to protect the encryption - key. If you select this key protector, users can access the encrypted drive as long as it is - connected to the system board that hosts the TPM and system boot integrity is intact. In general, - TPM-based protectors can only be associated to an operating system volume. - -- **TPM and Personal Identification Number (PIN):** BitLocker uses a combination of the TPM and a - user-supplied PIN. A PIN is four to twenty digits or, if you allow enhanced PINs, is four to - twenty letters, symbols, spaces, or numbers. - -- **TPM, PIN, and startup key:** BitLocker uses a combination of the TPM, a user-supplied PIN, and - input from of a USB memory device that contains an external key. - -- **TPM and startup key:** BitLocker uses a combination of the TPM and a USB flash drive that - contains the external key. - -- **Startup key:** BitLocker uses a USB flash drive that contains the external key. - -- **Password:** BitLocker uses a password. - -- **Recovery key:** BitLocker uses a recovery key stored as a specified file. - -- **Recovery password:** BitLocker uses a recovery password. - -- **Active Directory Domain Services (AD DS) account:** BitLocker uses domain authentication. - -You can specify only one of these methods or combinations when you enable encryption, but you can -use the **Add-BitLockerKeyProtector** cmdlet to add other protectors. - -For a password or PIN key protector, specify a secure string. You can use the -**ConvertTo-SecureString** cmdlet to create a secure string. You can use secure strings in a script -and still maintain confidentiality of passwords. - -You may optionally select an encryption method. By default, BitLocker uses AES-128 but you can opt -AES-256 for stronger security. (Diffuser is not supported.) You may request hardware encryption but -we strongly advise against it. For further guidance, see the -[ADV180028 Security Advisory](https://msrc.microsoft.com/update-guide/vulnerability/ADV180028). - -This cmdlet returns a BitLocker volume object. If you choose recovery password as your key protector -but do not specify a 48-digit recovery password, this cmdlet generates a random one for you, and -stores it in the **RecoveryPassword** field of the **KeyProtector** attribute of the BitLocker -volume object. - -If you use startup key or recovery key as part of your key protector, provide a path to store the -key. This cmdlet stores the name of the file that contains the key in the **KeyFileName** field of -the **KeyProtector** field in the BitLocker volume object. - -If you use the **Enable-BitLocker** cmdlet on an encrypted volume or on a volume with -encryption in process, it takes no action. If you use the cmdlet on a drive that has encryption -paused, it resumes encryption on the volume. - -By default, this cmdlet encrypts the entire drive. If you use the *UsedSpaceOnly* parameter, it only -encrypts the used space on the disk. This option can significantly reduce encryption time. - -It is common practice to add a recovery password for an operating system volume using the -**Add-BitLockerKeyProtector** cmdlet, save the recovery password using the -**Backup-BitLockerKeyProtector** cmdlet, and then enable BitLocker on that volume. This procedure -ensures that you have a recovery option. - -For an overview of BitLocker, see the -[BitLocker Drive Encryption Overview](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc732774(v=ws.11)). - -## EXAMPLES - -### Example 1: Enable BitLocker - -```PowerShell -$SecureString = ConvertTo-SecureString "1234" -AsPlainText -Force -Enable-BitLocker -MountPoint "C:" -EncryptionMethod Aes256 -UsedSpaceOnly -Pin $SecureString -TPMandPinProtector -``` - -This example enables BitLocker for a specified drive using the TPM and a PIN for key protector. - -The first command uses the **ConvertTo-SecureString** cmdlet to create a secure string that contains a PIN and saves that string in the $SecureString variable. -For more information about the **ConvertTo-SecureString** cmdlet, type `Get-Help ConvertTo-SecureString`. - -The second command enables BitLocker encryption for the BitLocker volume that has the drive letter C:. -The cmdlet specifies an encryption algorithm and the PIN saved in the $SecureString variable. -The command also specifies that this volume uses a combination of the TPM and the PIN as key protector. -The command also specifies to encrypt the used space data on the disk, instead of the entire volume. -When the system writes data to the volume in the future, that data is encrypted. - -### Example 2: Enable BitLocker with a recovery key - -```PowerShell -Get-BitLockerVolume | Enable-BitLocker -EncryptionMethod Aes128 -RecoveryKeyPath "E:\Recovery\" -RecoveryKeyProtector -``` - -This command gets all the BitLocker volumes for the current computer and passes pipes them to the **Enable-BitLocker** cmdlet by using the pipe operator. -This cmdlet specifies an encryption algorithm for the volume or volumes. -This cmdlet specifies a path to a folder where the randomly generated recovery key will be stored and indicates that these volumes use a recovery key as a key protector. - -### Example 3: Enable BitLocker with a specified user account - -```PowerShell -Enable-BitLocker -MountPoint "C:" -EncryptionMethod Aes128 -AdAccountOrGroup "Western\SarahJones" -AdAccountOrGroupProtector -``` - -This command encrypts the BitLocker volume specified by the *MountPoint* parameter, and uses the AES 128 encryption method. -The command also specifies an account and specifies that BitLocker uses user credentials as a key protector. -When a user accesses this volume, BitLocker prompts for credentials for the user account Western\SarahJones. - -## PARAMETERS - -### -AdAccountOrGroup - -Specifies an account using the format Domain\User. -This cmdlet adds the account you specify as a key protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: AdAccountOrGroupProtector -Aliases: sid - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdAccountOrGroupProtector - -Indicates that BitLocker uses an AD DS account as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: AdAccountOrGroupProtector -Aliases: sidp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncryptionMethod - -Specifies an encryption method for the encrypted drive. The accepted values are "Aes128", "Aes256", -and "Hardware". The latter has been deprecated and doesn't appear in the next versions of Windows. -We strongly advise not enabling hardware encryption. For further guidance, see the -[ADV180028 Security Advisory](https://msrc.microsoft.com/update-guide/vulnerability/ADV180028). - -```yaml -Type: BitLockerVolumeEncryptionMethodOnEnable -Parameter Sets: (All) -Aliases: -Accepted values: Aes128, Aes256, Hardware - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HardwareEncryption - -Indicates that the volume uses hardware encryption. We strongly advise against hardware encryption. -For further guidance, see the -[ADV180028 Security Advisory](https://msrc.microsoft.com/update-guide/vulnerability/ADV180028). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MountPoint - -Specifies an array of drive letters or BitLocker volume objects. -This cmdlet enables protection for the volumes specified. -To obtain a BitLocker volume object, use the **Get-BitLockerVolume** cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Password - -Specifies a secure string object that contains a password. -The password specified acts as a protector for the volume encryption key. - -```yaml -Type: SecureString -Parameter Sets: PasswordProtector -Aliases: pw - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PasswordProtector - -Indicates that BitLocker uses a password as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: PasswordProtector -Aliases: pwp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pin - -Specifies a secure string object that contains a PIN. -BitLocker uses the PIN specified, with other data, as a protector for the volume encryption key. - -```yaml -Type: SecureString -Parameter Sets: TpmAndPinAndStartupKeyProtector, TpmAndPinProtector -Aliases: p - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryKeyPath - -Specifies a path to a folder. -This cmdlet adds a randomly generated recovery key as a protector for the volume encryption key and stores it in the specified path. - -```yaml -Type: String -Parameter Sets: RecoveryKeyProtector -Aliases: rk - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryKeyProtector - -Indicates that BitLocker uses a recovery key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: RecoveryKeyProtector -Aliases: rkp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPassword - -Specifies a recovery password. -If you do not specify this parameter but include the *RecoveryPasswordProtector* parameter, the cmdlet creates a random password. - -You can enter a 48-digit password. - -The password specified or created acts as a protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: RecoveryPasswordProtector -Aliases: rp - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPasswordProtector - -Indicates that BitLocker uses a recovery password as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: RecoveryPasswordProtector -Aliases: rpp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service - -Indicates that the system account for this computer unlocks the encrypted volume. - -```yaml -Type: SwitchParameter -Parameter Sets: AdAccountOrGroupProtector -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SkipHardwareTest - -Indicates that BitLocker does not perform a hardware test before it begins encryption. -BitLocker uses a hardware test as a dry run to make sure that all the key protectors are correctly set up and that the computer can start without issues. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: s - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartupKeyPath - -Specifies a path to a startup key. -The key stored in the specified path acts as a protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: StartupKeyProtector, TpmAndStartupKeyProtector, TpmAndPinAndStartupKeyProtector -Aliases: sk - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartupKeyProtector - -Indicates that BitLocker uses a startup key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: StartupKeyProtector -Aliases: skp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmAndPinAndStartupKeyProtector - -Indicates that BitLocker uses a combination of the TPM, a PIN, and a startup key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: TpmAndPinAndStartupKeyProtector -Aliases: tpskp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmAndPinProtector - -Indicates that BitLocker uses a combination of the TPM and a PIN as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: TpmAndPinProtector -Aliases: tpp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmAndStartupKeyProtector - -Indicates that BitLocker uses a combination of the TPM and a startup key as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: TpmAndStartupKeyProtector -Aliases: tskp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TpmProtector - -Indicates that BitLocker uses the TPM as a protector for the volume encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: TpmProtector -Aliases: tpmp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UsedSpaceOnly - -Indicates that BitLocker does not encrypt unallocated disk space. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: qe - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Disable-BitLocker](./Disable-BitLocker.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - -[Lock-BitLocker](./Lock-BitLocker.md) - -[Resume-BitLocker](./Resume-BitLocker.md) - -[Suspend-BitLocker](./Suspend-BitLocker.md) - -[Unlock-BitLocker](./Unlock-BitLocker.md) diff --git a/docset/winserver2012-ps/bitlocker/Enable-BitLockerAutoUnlock.md b/docset/winserver2012-ps/bitlocker/Enable-BitLockerAutoUnlock.md deleted file mode 100644 index 40f88a9a8f..0000000000 --- a/docset/winserver2012-ps/bitlocker/Enable-BitLockerAutoUnlock.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/enable-bitlockerautounlock?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BitLockerAutoUnlock - -## SYNOPSIS -Enables automatic unlocking for a BitLocker volume. - -## SYNTAX - -``` -Enable-BitLockerAutoUnlock [-MountPoint] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-BitLockerAutoUnlock** cmdlet enables automatic unlocking for a volume protected by BitLocker Disk Encryption. - -You can configure BitLocker to automatically unlock volumes that do not host an operating system. -After a user unlocks the operating system volume, BitLocker uses encrypted information stored in the registry and volume metadata to unlock any data volumes that use automatic unlocking. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Enable automatic unlocking -``` -PS C:\>Enable-BitLockerAutoUnlock -MountPoint "E:" -``` - -This command enables automatic unlocking for the specified BitLocker volume. - -## PARAMETERS - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet enables automatic unlocking for the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Clear-BitLockerAutoUnlock](./Clear-BitLockerAutoUnlock.md) - -[Disable-BitLockerAutoUnlock](./Disable-BitLockerAutoUnlock.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Get-BitLockerVolume.md b/docset/winserver2012-ps/bitlocker/Get-BitLockerVolume.md deleted file mode 100644 index 12a6434e7b..0000000000 --- a/docset/winserver2012-ps/bitlocker/Get-BitLockerVolume.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/get-bitlockervolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BitLockerVolume - -## SYNOPSIS -Gets information about volumes that BitLocker can protect. - -## SYNTAX - -``` -Get-BitLockerVolume [[-MountPoint] ] [] -``` - -## DESCRIPTION -The **Get-BitLockerVolume** cmdlet gets information about volumes that BitLocker Drive Encryption can protect. -You can specify a BitLocker volume by drive letter, followed by a colon (C:, E:). -If you do not specify a drive letter, this cmdlet gets all volumes for the current computer. - -You can use this cmdlet to get BitLocker volumes to use with other cmdlets, such as the **Enable-BitLocker** cmdlet or the **Add-BitLockerKeyProtector** cmdlet. -You can also use this cmdlet to view the following information about a BitLocker volume: - -- VolumeType - Data or Operating System. -- Mount Point - Drive letter. -- CapacityGB - Size of drive. -- VolumeStatus - Whether BitLocker currently protects some, all, or none of the data on the volume. -- Encryption Percentage - Percent of the volume protected by BitLocker. -- KeyProtector - Type of key protector or protectors. -- AutoUnlock Enabled - Whether BitLocker uses automatic unlocking for the volume. -- Protection Status - Whether BitLocker currently uses a key protector to encrypt the volume encryption key. -- EncryptionMethod - Indicates the encryption algorithm and key size used on the volume. - -See [BitLocker Overview](/windows/security/information-protection/bitlocker/bitlocker-overview) for more information. - -For an overview of encryption methods, see [GetEncryptionMethod method](/windows/win32/secprov/getencryptionmethod-win32-encryptablevolume). - -## EXAMPLES - -### Example 1: Get all BitLocker volumes -``` -PS C:\> Get-BitLockerVolume - -VolumeType Mount CapacityGB VolumeStatus Encryption KeyProtector AutoUnlock Protection - Point Percentage Enabled Status ----------- ----- ---------- ------------ ---------- ------------ ---------- ---------- -Data D: 931.51 EncryptionInProgress 1 {RecoveryPassword, Pas... Off -Data E: 928.83 FullyDecrypted 0 {} Off -OperatingSystem C: 232.54 FullyDecrypted 0 {Tpm} Off -Data F: 0.98 FullyDecrypted 0 {} Off -Data G: 1.70 FullyDecrypted 0 {} Off -``` - -This command gets all the BitLocker volumes for the current computer. - -### Example 2: Get a specific BitLocker volume -``` -PS C:\> Get-BitLockerVolume -MountPoint "E:" - -VolumeType Mount CapacityGB VolumeStatus Encryption KeyProtector AutoUnlock Protection - Point Percentage Enabled Status ----------- ----- ---------- ------------ ---------- ------------ ---------- ---------- -Data E: 928.83 FullyDecrypted 0 {} Off -``` - -This command gets the specified BitLocker volume. - -### Example 3: Get all attributes for a specific BitLocker volume -``` -PS C:\> Get-BitLockerVolume -MountPoint C | Format-List -ComputerName : DESKTOP-XXXXXXX -MountPoint : C: -EncryptionMethod : XtsAes128 -AutoUnlockEnabled : -AutoUnlockKeyStored : False -MetadataVersion : 2 -VolumeStatus : FullyEncrypted -ProtectionStatus : On -LockStatus : Unlocked -EncryptionPercentage : 100 -WipePercentage : 0 -VolumeType : OperatingSystem -CapacityGB : 218,2344 -KeyProtector : {RecoveryPassword, Tpm} -``` - -This command lists all BitLocker related attributes for C drive. - -## PARAMETERS - -### -MountPoint -Specifies an array of drive letters. -This cmdlet gets these BitLocker volumes. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Add-BitLockerKeyProtector](./Add-BitLockerKeyProtector.md) - -[Enable-BitLocker](./Enable-BitLocker.md) - -[Enable-BitLockerAutoUnlock](./Enable-BitLockerAutoUnlock.md) diff --git a/docset/winserver2012-ps/bitlocker/Lock-BitLocker.md b/docset/winserver2012-ps/bitlocker/Lock-BitLocker.md deleted file mode 100644 index 271706c415..0000000000 --- a/docset/winserver2012-ps/bitlocker/Lock-BitLocker.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/lock-bitlocker?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Lock-BitLocker - -## SYNOPSIS -Prevents access to encrypted data on a BitLocker volume. - -## SYNTAX - -``` -Lock-BitLocker [-MountPoint] [-ForceDismount] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Lock-BitLocker** cmdlet prevents access to all encrypted data on a volume that uses BitLocker Drive Encryption. -You can use the Unlock-BitLocker cmdlet to restore access. - -You can specify a volume to lock by drive letter, or you can specify a BitLocker volume object. -This cmdlet cannot lock a volume that hosts the operating system. -If you attempt to lock an already locked volume, this cmdlet does nothing. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Lock a volume -``` -PS C:\> Lock-Volume -MountPoint "E:" -ForceDismount -``` - -This command locks the BitLocker volume specified with the **Mount** parameter. -The command uses the **ForceDismount** parameter, so the cmdlet attempts to lock the volume even if it is in use. - -## PARAMETERS - -### -ForceDismount -Indicates that the cmdlet attempts to lock a drive even if the drive is in use. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: fd - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet attempts to lock the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Disable-BitLocker](./Disable-BitLocker.md) - -[Enable-BitLocker](./Enable-BitLocker.md) - -[Resume-BitLocker](./Resume-BitLocker.md) - -[Suspend-BitLocker](./Suspend-BitLocker.md) - -[Unlock-BitLocker](./Unlock-BitLocker.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Remove-BitLockerKeyProtector.md b/docset/winserver2012-ps/bitlocker/Remove-BitLockerKeyProtector.md deleted file mode 100644 index a561a3d878..0000000000 --- a/docset/winserver2012-ps/bitlocker/Remove-BitLockerKeyProtector.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/remove-bitlockerkeyprotector?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-BitLockerKeyProtector - -## SYNOPSIS -Removes a key protector for a BitLocker volume. - -## SYNTAX - -``` -Remove-BitLockerKeyProtector [-MountPoint] [-KeyProtectorId] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-BitLockerKeyProtector** cmdlet removes a key protector for a volume protected by BitLocker Drive Encryption. - -You can specify a key protector to remove by using an ID. -To add a protector, use the **Add-BitLockerKeyProtector** cmdlet. - -If you remove all the key protectors for a BitLocker volume, BitLocker stores the data encryption key for the volume without using encryption. -This means that any user that can access the volume can read the encrypted data on the volume unless you add a key protector. -Any encrypted data on the drive remains encrypted. - -We recommend you have at least one recovery password as key protector to a volume in case you need to recover a system. - -For an overview of BitLocker, see [BitLocker Overview](/previous-versions/windows/it-pro/windows-8.1-and-8/dn641993(v=ws.11)). - -## EXAMPLES - -### Example 1: Remove the second key protector for a volume -```powershell -PS C:\> $BLV = Get-BitLockerVolume -MountPoint "C:" -PS C:\> Remove-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId $BLV.KeyProtector[1].KeyProtectorId -``` - -This example removes a key protector for a specified BitLocker volume. - -The first command uses **Get-BitLockerVolume** to obtain a BitLocker volume and store it in the `$BLV` variable. - -The second command removes the key protector for the BitLocker volume specified by the **MountPoint** parameter. -The command specifies the key protector by using its ID, contained in the BitLocker object stored in `$BLV`. - -### Example 2: Remove TpmPin key protector for a volume -```powershell -PS C:\> $BLV = Get-BitlockerVolume -MountPoint "C:" -PS C:\> $TpmPinKeyProtector = $BLV.KeyProtector | Where-Object {$PSItem.KeyProtectorType -eq "TpmPin"} -PS C:\> Remove-BitLockerKeyProtector -MountPoint "C:" -KeyProtectorId $TpmPinKeyProtector.KeyProtectorId -``` - -This example removes a key protector of type TpmPin for a specified BitLocker Volume. - -The first command uses **Get-BitLockerVolume** to obtain a BitLocker volume and store it in the `$BLV` variable. - -The second command filters the key protectors to get only the one with TpmPin type and stores it in the `$TpmPinKeyProtector` variable. - -The third command removes they key protector by its ID. - -## PARAMETERS - -### -KeyProtectorId -Specifies the ID for a key protector. -A BitLocker volume object includes a **KeyProtector** object. -You have to specify the key protector ID. -See the Examples section. -To obtain a BitLocker volume object, use the **Get-BitLockerVolume** cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: id - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet removes key protectors for the volumes specified. -To obtain a BitLocker volume object, use the **Get-BitLockerVolume** cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Add-BitLockerKeyProtector](./Add-BitLockerKeyProtector.md) - -[Backup-BitLockerKeyProtector](./Backup-BitLockerKeyProtector.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) diff --git a/docset/winserver2012-ps/bitlocker/Resume-BitLocker.md b/docset/winserver2012-ps/bitlocker/Resume-BitLocker.md deleted file mode 100644 index 3064981516..0000000000 --- a/docset/winserver2012-ps/bitlocker/Resume-BitLocker.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/resume-bitlocker?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-BitLocker - -## SYNOPSIS -Restores Bitlocker encryption for the specified volume. - -## SYNTAX - -``` -Resume-BitLocker [-MountPoint] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Resume-BitLocker** cmdlet restores encryption on a volume that uses BitLocker Drive Encryption. -You can use the Suspend-BitLocker cmdlet to allow users to access encrypted data temporarily. -Data written to the volume continues to be encrypted, but the key to unlock the operating system volume is in the open. - -You can specify a volume by drive letter, or you can specify a BitLocker volume object. -If you specify a BitLocker volume that is not suspended, this cmdlet has no effect on that volume. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Resume protection for a volume -``` -PS C:\> Resume-BitLocker -MountPoint "C:" -``` - -This command resumes BitLocker protection for the C: drive. - -### Example 2: Resume protection for all volumes on a computer -``` -PS C:\>Get-BitLockerVolume | Resume-BitLocker -``` - -This command gets all the BitLocker volumes for the current computer by using the Get-BitLockerVolume cmdlet and passes them to Resume-BitLocker by using the pipe operator. -The command restores protection for all BitLocker volumes. - -## PARAMETERS - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -This cmdlet resumes protection for the volumes specified. -To obtain a BitLocker volume object, use theGet-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Disable-BitLocker](./Disable-BitLocker.md) - -[Enable-BitLocker](./Enable-BitLocker.md) - -[Lock-BitLocker](./Lock-BitLocker.md) - -[Suspend-BitLocker](./Suspend-BitLocker.md) - -[Unlock-BitLocker](./Unlock-BitLocker.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Suspend-BitLocker.md b/docset/winserver2012-ps/bitlocker/Suspend-BitLocker.md deleted file mode 100644 index eb856bee34..0000000000 --- a/docset/winserver2012-ps/bitlocker/Suspend-BitLocker.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/suspend-bitlocker?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-BitLocker - -## SYNOPSIS -Suspends Bitlocker encryption for the specified volume. - -## SYNTAX - -``` -Suspend-BitLocker [-MountPoint] [[-RebootCount] ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Suspend-BitLocker** cmdlet suspends Bitlocker encryption, allowing users to access encrypted data on a volume that uses BitLocker Drive Encryption. -This cmdlet makes the encryption key available in the clear. - -Suspension of BitLocker does not mean that BitLocker decrypts data on the volume. -Instead, suspension makes key used to decrypt the data available to everyone in the clear. -New data written to the disk is still encrypted. - -While suspended, BitLocker does not validate system integrity at start up. -You might suspend BitLocker protection for firmware upgrades or system updates. - -You can specify the number of times that a computer restarts before the BitLocker suspension ends by using the **RebootCount** parameter, or you can use the Resume-BitLocker cmdlet to manually resume protection. -If you do not specify the **RebootCount** parameter, the cmdlet uses a value of one (1), so BitLocker protection resumes after the next restart. - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Suspend BitLocker protection -``` -PS C:\> Suspend-BitLocker -MountPoint "C:" -RebootCount 0 -``` - -This command suspends Bitlocker encryption on the BitLocker volume specified by the **MountPoint** parameter. -Because the **RebootCount** parameter value is 0, BitLocker encryption remains suspended until you run the Resume-BitLocker cmdlet. - -## PARAMETERS - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -This cmdlet suspends protection for the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -RebootCount -Specifies the number of computer restarts before BitLocker restores protection. -The acceptable values for this parameter are:integers from 0 to 15. -Specify zero to suspend protection indefinitely until you resume it by using the Resume-BitLocker cmdlet. - -If you do not include this parameter, the cmdlet uses a value of one. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Disable-BitLocker](./Disable-BitLocker.md) - -[Enable-BitLocker](./Enable-BitLocker.md) - -[Lock-BitLocker](./Lock-BitLocker.md) - -[Resume-BitLocker](./Resume-BitLocker.md) - -[Unlock-BitLocker](./Unlock-BitLocker.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/bitlocker/Unlock-BitLocker.md b/docset/winserver2012-ps/bitlocker/Unlock-BitLocker.md deleted file mode 100644 index 72a03d3d2d..0000000000 --- a/docset/winserver2012-ps/bitlocker/Unlock-BitLocker.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Bitlocker_Cmdlets.xml -Module Name: BitLocker -online version: https://learn.microsoft.com/powershell/module/bitlocker/unlock-bitlocker?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Unlock-BitLocker - -## SYNOPSIS -Restores access to data on a BitLocker volume. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Unlock-BitLocker [-AdAccountOrGroup] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Unlock-BitLocker [-MountPoint] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Unlock-BitLocker -Password [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Unlock-BitLocker -RecoveryKeyPath [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Unlock-BitLocker -RecoveryPassword [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Unlock-BitLocker** cmdlet restores access to encrypted data on a volume that uses BitLocker Drive Encryption. -You can use the Lock-BitLocker cmdlet to prevent access. - -In order to restore access, provide one of the following key protectors for the volume: - -- Active Directory Domain Services (AD DS) account -- Password -- Recovery key -- Recovery password - -For an overview of BitLocker, see BitLocker Drive Encryption Overviewhttp://technet.microsoft.com/en-us/library/cc732774.aspx (http://technet.microsoft.com/en-us/library/cc732774.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Unlock a volume -``` -PS C:\> $SecureString = ConvertTo-SecureString "fjuksAS1337" -AsPlainText -Force PS C:\>Unlock-BitLocker -MountPoint "E:" -Password $SecureString -``` - -This example unlocks a specified BitLocker volume by using a password. - -The first command uses the **ConvertTo-SecureString** cmdlet to create a secure string that contains a password and saves it in the $SecureString variable. -For more information about the **ConvertTo-SecureString** cmdlet, type `Get-Help ConvertTo-SecureString`. - -The second command unlocks the specified BitLocker volume by using the password saved in the $SecureString variable. - -## PARAMETERS - -### -AdAccountOrGroup -Indicates that BitLocker requires account credentials to unlock the volume. -In order to use this parameter, the account for the current user must be a key protector for the volume. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MountPoint -Specifies an array of drive letters or BitLocker volume objects. -The cmdlet unlocks the volumes specified. -To obtain a BitLocker volume object, use the Get-BitLockerVolume cmdlet. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Password -Specifies a secure string that contains a password. -The password specified acts as a protector for the volume encryption key. - -```yaml -Type: SecureString -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: pw - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryKeyPath -Specifies the path to a folder where recovery keys are stored. -The key stored in the specified path, if found, acts as a protector for the volume encryption. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: rk - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryPassword -Specifies a recovery password. -The password specified acts as a protector for the volume encryption key. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: rp - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### BitLockerVolume[], String[] - -## OUTPUTS - -### BitLockerVolume[] - -## NOTES - -## RELATED LINKS - -[Disable-BitLocker](./Disable-BitLocker.md) - -[Enable-BitLocker](./Enable-BitLocker.md) - -[Lock-BitLocker](./Lock-BitLocker.md) - -[Resume-BitLocker](./Resume-BitLocker.md) - -[Suspend-BitLocker](./Suspend-BitLocker.md) - -[Get-BitLockerVolume](./Get-BitLockerVolume.md) - diff --git a/docset/winserver2012-ps/branchcache/Add-BCDataCacheExtension.md b/docset/winserver2012-ps/branchcache/Add-BCDataCacheExtension.md deleted file mode 100644 index f3f552d446..0000000000 --- a/docset/winserver2012-ps/branchcache/Add-BCDataCacheExtension.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/add-bcdatacacheextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-BCDataCacheExtension - -## SYNOPSIS -Increases the amount of cache storage space that is available on a hosted cache server by adding a new cache file. - -## SYNTAX - -### Percentage (Default) -``` -Add-BCDataCacheExtension [[-Path] ] [-Force] [-PassThru] [[-Percentage] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### SizeBytes -``` -Add-BCDataCacheExtension [[-Path] ] [-Force] [-PassThru] -SizeBytes - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-BCDataCacheExtension** cmdlet adds a new data cache file to increase the amount of cache storage space that is available on a hosted cache server. -Data cache files can be spread across multiple disks to maximize performance. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-BCDataCacheExtension -``` - -This example creates a data cache extension in the default location reserving 5% of the drive. - -### EXAMPLE 2 -``` -PS C:\>Add-BCDataCacheExtension -Path C:\datacache -Percentage 10 -``` - -This example adds a data cache extension in the C:\datacache directory reserving 10% of the drive C. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the location where the data cache file is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Percentage -Specifies the size of the cache file as a percentage of the disk space. - -For example, if the value of `15` is provided, then the data cache file has a maximum size of fifteen percent of the disk space on the hard drive where the file is created. - -```yaml -Type: UInt32 -Parameter Sets: Percentage -Aliases: - -Required: False -Position: 1 -Default value: 5 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SizeBytes -Specifies the size of the cache file in bytes. - -```yaml -Type: UInt64 -Parameter Sets: SizeBytes -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimV2\MSFT_NetBranchCacheDataCacheExtension -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-BCDataCacheExtension](./Get-BCDataCacheExtension.md) - -[Remove-BCDataCacheExtension](./Remove-BCDataCacheExtension.md) - diff --git a/docset/winserver2012-ps/branchcache/BranchCache.md b/docset/winserver2012-ps/branchcache/BranchCache.md deleted file mode 100644 index 91d40f5ec5..0000000000 --- a/docset/winserver2012-ps/branchcache/BranchCache.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: d57aee1e-6fe7-4bbc-8c57-8675a3a83e0d -Module Name: BranchCache ---- - -# BranchCache Module -## Description -This reference provides cmdlet descriptions and syntax for all BranchCache **Manageability-specific** cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## BranchCache Cmdlets -### [Add-BCDataCacheExtension](./Add-BCDataCacheExtension.md) -Increases the amount of cache storage space that is available on a hosted cache server by adding a new cache file. - -### [Clear-BCCache](./Clear-BCCache.md) -Deletes all data in all data cache files and all hash cache files. - -### [Disable-BC](./Disable-BC.md) -Disables the BranchCache service. - -### [Disable-BCDowngrading](./Disable-BCDowngrading.md) -Disables downgrading, so that client computers that are running operating systems later than Windows 7® do not request Windows 7-specific versions of content information from content servers. - -### [Disable-BCServeOnBattery](./Disable-BCServeOnBattery.md) -Configures a client to ignore content discovery requests in distributed cache mode when operating on battery power. - -### [Enable-BCDistributed](./Enable-BCDistributed.md) -Enables BranchCache and configures a computer to operate in distributed cache mode. - -### [Enable-BCDowngrading](./Enable-BCDowngrading.md) -Instructs a client computer that is running an operating system later than Windows 7® to operate in a downgraded Windows 7 mode. - -### [Enable-BCHostedClient](./Enable-BCHostedClient.md) -Configures BranchCache to operate in hosted cache client mode. - -### [Enable-BCHostedServer](./Enable-BCHostedServer.md) -Configures BranchCache to operate in hosted cache server mode. - -### [Enable-BCLocal](./Enable-BCLocal.md) -Enables the BranchCache service in local caching mode. - -### [Enable-BCServeOnBattery](./Enable-BCServeOnBattery.md) -Configures a client to listen for content discovery requests in distributed cache mode when operating on battery power. - -### [Export-BCCachePackage](./Export-BCCachePackage.md) -Exports a cache package. - -### [Export-BCSecretKey](./Export-BCSecretKey.md) -Exports a secret key to a file. - -### [Get-BCClientConfiguration](./Get-BCClientConfiguration.md) -Retrieves the current BranchCache client computer settings. - -### [Get-BCContentServerConfiguration](./Get-BCContentServerConfiguration.md) -Retrieves the current BranchCache content server settings. - -### [Get-BCDataCache](./Get-BCDataCache.md) -Retrieves an object that represents the BranchCache data cache. - -### [Get-BCDataCacheExtension](./Get-BCDataCacheExtension.md) -Retrieves objects that represent the BranchCache data cache extensions from a hosted cache server. - -### [Get-BCHashCache](./Get-BCHashCache.md) -Retrieves the BranchCache hash cache. - -### [Get-BCHostedCacheServerConfiguration](./Get-BCHostedCacheServerConfiguration.md) -Retrieves the current BranchCache hosted cache server settings. - -### [Get-BCNetworkConfiguration](./Get-BCNetworkConfiguration.md) -Retrieves the current BranchCache network settings. - -### [Get-BCStatus](./Get-BCStatus.md) -Retrieves a set of objects that provide BranchCache status and configuration information. - -### [Import-BCCachePackage](./Import-BCCachePackage.md) -Imports a cache package. - -### [Import-BCSecretKey](./Import-BCSecretKey.md) -Imports the cryptographic key that BranchCache uses for the generation of segment secrets. - -### [Publish-BCFileContent](./Publish-BCFileContent.md) -Generates hashes, also called content information, for files in shared folders on a file server that have BranchCache enabled and the BranchCache for Network Files role service installed. - -### [Publish-BCWebContent](./Publish-BCWebContent.md) -Creates hashes for web content when deploying content servers that are running Windows Server® 8 Beta with the Web Services (IIS) server role installed. - -### [Remove-BCDataCacheExtension](./Remove-BCDataCacheExtension.md) -Deletes a data cache file. - -### [Reset-BC](./Reset-BC.md) -Resets BranchCache to the default configuration. - -### [Set-BCAuthentication](./Set-BCAuthentication.md) -Specifies the BranchCache computer authentication mode. - -### [Set-BCCache](./Set-BCCache.md) -Modifies the cache file configuration. - -### [Set-BCDataCacheEntryMaxAge](./Set-BCDataCacheEntryMaxAge.md) -Modifies the maximum amount of time that data can remain in the cache. - -### [Set-BCMinSMBLatency](./Set-BCMinSMBLatency.md) -Sets the minimum latency that must exist between client and server before transparent caching functions are utilized. - -### [Set-BCSecretKey](./Set-BCSecretKey.md) -Sets the cryptographic key used in the generation of segment secrets. - diff --git a/docset/winserver2012-ps/branchcache/Clear-BCCache.md b/docset/winserver2012-ps/branchcache/Clear-BCCache.md deleted file mode 100644 index 7ecd85a4be..0000000000 --- a/docset/winserver2012-ps/branchcache/Clear-BCCache.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/clear-bccache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-BCCache - -## SYNOPSIS -Deletes all data in all data cache files and all hash cache files. - -## SYNTAX - -``` -Clear-BCCache [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Clear-BCCache** cmdlet deletes all data in all cache files. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Clear-BCCache -``` - -This example deletes all content and content information from all cache files. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Set-BCCache](./Set-BCCache.md) - diff --git a/docset/winserver2012-ps/branchcache/Disable-BC.md b/docset/winserver2012-ps/branchcache/Disable-BC.md deleted file mode 100644 index fa9d912b29..0000000000 --- a/docset/winserver2012-ps/branchcache/Disable-BC.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/disable-bc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-BC - -## SYNOPSIS -Disables the BranchCache service. - -## SYNTAX - -``` -Disable-BC [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Disable-BC** cmdlet disables the BranchCache service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-BC -``` - -This example disables the BranchCache service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Disable-BCDowngrading.md b/docset/winserver2012-ps/branchcache/Disable-BCDowngrading.md deleted file mode 100644 index 6e8c810c97..0000000000 --- a/docset/winserver2012-ps/branchcache/Disable-BCDowngrading.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/disable-bcdowngrading?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-BCDowngrading - -## SYNOPSIS -Disables downgrading, so that client computers that are running operating systems later than Windows 7® do not request Windows 7-specific versions of content information from content servers. - -## SYNTAX - -``` -Disable-BCDowngrading [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-BCDowngrading** cmdlet stops client computers that are running operating systems later than firstref_client_7 from requesting content information in the Windows® 7 format. -Instead, client computers request content information in the new format, which provides greater bandwidth savings and application performance gains. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-BCDowngrading -``` - -This example disables downgraded BranchCache operational mode. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Enable-BCDowngrading](./Enable-BCDowngrading.md) - diff --git a/docset/winserver2012-ps/branchcache/Disable-BCServeOnBattery.md b/docset/winserver2012-ps/branchcache/Disable-BCServeOnBattery.md deleted file mode 100644 index 1cb335a61f..0000000000 --- a/docset/winserver2012-ps/branchcache/Disable-BCServeOnBattery.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/disable-bcserveonbattery?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-BCServeOnBattery - -## SYNOPSIS -Configures a client to ignore content discovery requests in distributed cache mode when operating on battery power. - -## SYNTAX - -``` -Disable-BCServeOnBattery [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Disable-BCServeOnBattery** cmdlet configures a client to ignore content discovery requests in distributed cache mode when operating on battery power. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-BCServeOnBattery -``` - -This example configures the computer to ignore content discovery requests from peers. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Enable-BCServeOnBattery](./Enable-BCServeOnBattery.md) - diff --git a/docset/winserver2012-ps/branchcache/Enable-BCDistributed.md b/docset/winserver2012-ps/branchcache/Enable-BCDistributed.md deleted file mode 100644 index 7e7b0cf9d7..0000000000 --- a/docset/winserver2012-ps/branchcache/Enable-BCDistributed.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/enable-bcdistributed?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BCDistributed - -## SYNOPSIS -Enables BranchCache and configures a computer to operate in distributed cache mode. - -## SYNTAX - -``` -Enable-BCDistributed [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-BCDistributed** cmdlet enables BranchCache and configures a computer to operate in distributed cache mode. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-BCDistributed -``` - -This example enables distributed cache mode on the computer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Enable-BCDowngrading.md b/docset/winserver2012-ps/branchcache/Enable-BCDowngrading.md deleted file mode 100644 index f0f2d3cd7e..0000000000 --- a/docset/winserver2012-ps/branchcache/Enable-BCDowngrading.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/enable-bcdowngrading?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BCDowngrading - -## SYNOPSIS -Instructs a client computer that is running an operating system later than Windows 7® to operate in a downgraded Windows 7 mode. - -## SYNTAX - -``` -Enable-BCDowngrading [[-Version] ] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-BCDowngrading** cmdlet instructs a client computer that is running Windows® 8 to operate in a downgraded Windows® 7 mode. -In this mode, the client sends Windows® 7-specific version requests to content servers, and content servers respond by sending Windows® 7 versions of content information to the client. - -Note: Windows® 7-based BranchCache client computers are not affected by this setting. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-BCDowngrading -``` - -This example instructs the local computer to operate in Windows® 7 mode. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Version -Specifies the downgrade mode version that should be used. - -```yaml -Type: PreferredContentInformationVersion -Parameter Sets: (All) -Aliases: -Accepted values: Windows7, Windows8 - -Required: False -Position: 1 -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BCDowngrading](./Disable-BCDowngrading.md) - diff --git a/docset/winserver2012-ps/branchcache/Enable-BCHostedClient.md b/docset/winserver2012-ps/branchcache/Enable-BCHostedClient.md deleted file mode 100644 index 4685dccc62..0000000000 --- a/docset/winserver2012-ps/branchcache/Enable-BCHostedClient.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/enable-bchostedclient?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BCHostedClient - -## SYNOPSIS -Configures BranchCache to operate in hosted cache client mode. - -## SYNTAX - -### ServerNames (Default) -``` -Enable-BCHostedClient [-Force] [-ServerNames] [-UseVersion ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### UseSCP -``` -Enable-BCHostedClient [-Force] [-UseSCP] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-BCHostedClient** cmdlet configures BranchCache to operate in hosted cache client mode. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-BCHostedClient -ServerNames HC.contoso.com -UseVersion Windows7 -``` - -This example enables hosted cache client mode using the HC.contos.com computer as a hosted cache server. -For HTTPS, use Windows® 7 mode (`Windows7`). - -### EXAMPLE 2 -``` -PS C:\>Enable-BCHostedClient -ServerNames HC1.contoso.com,HC2.contoso.com -UseVersion Windows8 -``` - -This example enables hosted cache client mode with two hosted cache servers: HC1.contoso.com and HC2.contoso.com. -For HTTP, use Windows 8 mode (`Windows8`). - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerNames -Specifies the names of the hosted cache servers that the client computer can use to store content and obtain content. - -```yaml -Type: String[] -Parameter Sets: ServerNames -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSCP -Specifies that the client should locate hosted cache servers by using service connection points (SCP). -A service connection point is an Active Directory object used to publish service specific data. -A hosted cache server may register a service connection point object associated with the active directory site in which it resides. -This is achieved with the **RegisterSCP** parameter on the Enable-BCHostedServer cmdlet. - -If this parameter is specified, then this computer will attempt to automatically discover a hosted cache server associated with the assigned active directory site by searching for an SCP. - -```yaml -Type: SwitchParameter -Parameter Sets: UseSCP -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseVersion -Specifies the version of the offer protocol to use when contacting this hosted cache server. - -This parameter controls which protocol the client should use when communicating with the hosted cache server. -The value `Windows8` specifies that the client uses HTTP. -The value `Windows7` specifies that the client uses HTTPS. - -If this parameter is not specified, and a hosted cache server name is provided, then a value of `Windows8` is used. - -If the **UseSCP** parameter is used, then a value of `Windows7` is used. - -Hosted cache servers that are running Windows Server® 2012 do not need to enroll a certificate, and client computers can contact these servers to store or obtain content by using the HTTP protocol on the TCP port `80`. -However, nextref_server_7-based hosted cache servers must have a certificate enrolled, and can only be contacted when client computers use the HTTPS protocol on the TCP port `443`. - -Note: firstref_client_7-based computers can only contact hosted cache servers by using the HTTPS protocol; because of this, a hosted cache server that is running Windows Server 2012 can be configured to accept requests over both HTTP and HTTPS so that the hosted cache server can operate with Windows® 7-based computers and with client computers that are running Windows® 8. - -```yaml -Type: HostedCacheVersion -Parameter Sets: ServerNames -Aliases: -Accepted values: Windows7, Windows8 - -Required: False -Position: Named -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Enable-BCHostedServer](./Enable-BCHostedServer.md) - diff --git a/docset/winserver2012-ps/branchcache/Enable-BCHostedServer.md b/docset/winserver2012-ps/branchcache/Enable-BCHostedServer.md deleted file mode 100644 index c3cfdac9f7..0000000000 --- a/docset/winserver2012-ps/branchcache/Enable-BCHostedServer.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/enable-bchostedserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BCHostedServer - -## SYNOPSIS -Configures BranchCache to operate in hosted cache server mode. - -## SYNTAX - -``` -Enable-BCHostedServer [-Force] [-RegisterSCP] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-BCHostedServer** cmdlet configures BranchCache to operate in hosted cache server mode. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-BCHostedServer -RegisterSCP -``` - -This example enables hosted cache mode and register a service connection point for automatic discovery. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegisterSCP -Specifies that the hosted cache server registers a service connection point in Active Directory Domain Services (AD DS). -After a hosted cache server registers a service connection point in AD DS, BranchCache-enabled client computers can locate the hosted cache server by using the service connection point. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Enable-BCLocal.md b/docset/winserver2012-ps/branchcache/Enable-BCLocal.md deleted file mode 100644 index cecd6c6fdc..0000000000 --- a/docset/winserver2012-ps/branchcache/Enable-BCLocal.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/enable-bclocal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BCLocal - -## SYNOPSIS -Enables the BranchCache service in local caching mode. - -## SYNTAX - -``` -Enable-BCLocal [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Enable-BCLocal** cmdlet enables the BranchCache service in local caching mode. -In local caching mode, a client stores data in the BranchCache cache, and attempts to read data from the local BranchCache cache, but does not contact peers and does not attempt to contact a hosted cache server - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-BCLocal -``` - -This example enables BranchCache and configures BranchCache to use local caching mode. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Enable-BCServeOnBattery.md b/docset/winserver2012-ps/branchcache/Enable-BCServeOnBattery.md deleted file mode 100644 index 7a0c7fc041..0000000000 --- a/docset/winserver2012-ps/branchcache/Enable-BCServeOnBattery.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/enable-bcserveonbattery?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-BCServeOnBattery - -## SYNOPSIS -Configures a client to listen for content discovery requests in distributed cache mode when operating on battery power. - -## SYNTAX - -``` -Enable-BCServeOnBattery [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Enable-BCServeOnBattery** cmdlet configures a client to listen for content discovery requests in distributed cache mode when operating on battery power. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-BCServeOnBattery -``` - -This example configures the distributed cache mode BranchCache client computer to listen for content discovery requests at all times, even when the client computer is operating on battery power. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BCServeOnBattery](./Disable-BCServeOnBattery.md) - diff --git a/docset/winserver2012-ps/branchcache/Export-BCCachePackage.md b/docset/winserver2012-ps/branchcache/Export-BCCachePackage.md deleted file mode 100644 index df40a6c6dc..0000000000 --- a/docset/winserver2012-ps/branchcache/Export-BCCachePackage.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/export-bccachepackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-BCCachePackage - -## SYNOPSIS -Exports a cache package. - -## SYNTAX - -### StagingPath (Default) -``` -Export-BCCachePackage -Destination [-Force] [[-StagingPath] ] [-OutputReferenceFile ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### ExportDataCache -``` -Export-BCCachePackage -Destination [-Force] [-ExportDataCache] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-BCCachePackage** cmdlet exports a cache package. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Export-BCDataPackage -Destination D:\temp -``` - -This example exports all content that has been hashed with calls to Publish-BCFileContent and Publish-BCWebContent. -The package containing this data will be exported to D:\temp. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the folder location where the data package is stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExportDataCache -Specifies that the contents of the local data cache are included in the package. - -```yaml -Type: SwitchParameter -Parameter Sets: ExportDataCache -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutputReferenceFile -Specifies the folder location where the output reference file is generated. - -```yaml -Type: String -Parameter Sets: StagingPath -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StagingPath -Specifies the folder location of the cache files that are to be packaged. -These files are generated from the Publish-BCFileContent cmdlet. - -```yaml -Type: String -Parameter Sets: StagingPath -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Import-BCCachePackage](./Import-BCCachePackage.md) - -[Publish-BCFileContent](./Publish-BCFileContent.md) - -[Publish-BCWebContent](./Publish-BCWebContent.md) - diff --git a/docset/winserver2012-ps/branchcache/Export-BCSecretKey.md b/docset/winserver2012-ps/branchcache/Export-BCSecretKey.md deleted file mode 100644 index 4b47f64e27..0000000000 --- a/docset/winserver2012-ps/branchcache/Export-BCSecretKey.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/export-bcsecretkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-BCSecretKey - -## SYNOPSIS -Exports a secret key to a file. - -## SYNTAX - -``` -Export-BCSecretKey [-Filename] [-FilePassphrase] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Export-BCSecretKey** cmdlet exports a secret key to a file. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Export-BCSecretKey -Filename C:\share1\secretkey.key -FilePassphrase mySecretPhrase -``` - -This example exports the secret key to the file C:\share1\secretkey.key with the passphrase mySecretPhrase. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePassphrase -Specifies the passphrase for the file containing the key information to be affected by this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filename -Specifies the path of the file to be affected by this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Import-BCSecretKey](./Import-BCSecretKey.md) - -[Set-BCSecretKey](./Set-BCSecretKey.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCClientConfiguration.md b/docset/winserver2012-ps/branchcache/Get-BCClientConfiguration.md deleted file mode 100644 index e326e4171c..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCClientConfiguration.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: BranchCacheClientSettingData.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bcclientconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCClientConfiguration - -## SYNOPSIS -Retrieves the current BranchCache client computer settings. - -## SYNTAX - -``` -Get-BCClientConfiguration [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-BCClientConfiguration** cmdlet retrieves the current BranchCache client computer settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCClientConfiguration -``` - -This example retrieves the current BranchCache client computer settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCacheClientSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCContentServerConfiguration.md b/docset/winserver2012-ps/branchcache/Get-BCContentServerConfiguration.md deleted file mode 100644 index 3ad2e0d1f1..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCContentServerConfiguration.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: BranchCacheContentServerSettingData.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bccontentserverconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCContentServerConfiguration - -## SYNOPSIS -Retrieves the current BranchCache content server settings. - -## SYNTAX - -``` -Get-BCContentServerConfiguration [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-BCContentServerConfiguration** cmdlet retrieves the current BranchCache content server settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCContentServerConfiguration -``` - -This example retrieves the current BranchCache content server settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCacheContentServerSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCDataCache.md b/docset/winserver2012-ps/branchcache/Get-BCDataCache.md deleted file mode 100644 index 455c537c38..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCDataCache.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: BranchCachePrimaryRepublicationCacheFile.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bcdatacache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCDataCache - -## SYNOPSIS -Retrieves an object that represents the BranchCache data cache. - -## SYNTAX - -``` -Get-BCDataCache [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-BCDataCache** cmdlet retrieves the BranchCache data cache. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-BCDataCache -``` - -This example retrieves an object that represents the BranchCache data cache. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCacheDataCache -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCDataCacheExtension.md b/docset/winserver2012-ps/branchcache/Get-BCDataCacheExtension.md deleted file mode 100644 index 1c2fd301c7..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCDataCacheExtension.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: BranchCacheSecondaryRepublicationCacheFile.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bcdatacacheextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCDataCacheExtension - -## SYNOPSIS -Retrieves objects that represent the BranchCache data cache extensions from a hosted cache server. - -## SYNTAX - -``` -Get-BCDataCacheExtension [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-BCDataCacheExtension** cmdlet retrieves the BranchCache data cache extensions from a hosted cache server. -Hosted cache servers that are running Windows Server® 2012 can have multiple data caches, which are Extensible Storage Engine (ESE) databases, and which are specified by using data cache extensions. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCDataCacheExtension -``` - -This example retrieves objects that represent the BranchCache data cache extensions from a hosted cache server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCacheDataCacheExtension -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-BCDataCacheExtension](./Add-BCDataCacheExtension.md) - -[Remove-BCDataCacheExtension](./Remove-BCDataCacheExtension.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCHashCache.md b/docset/winserver2012-ps/branchcache/Get-BCHashCache.md deleted file mode 100644 index 5a6a7fb7bf..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCHashCache.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: BranchCachePrimaryPublicationCacheFile.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bchashcache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCHashCache - -## SYNOPSIS -Retrieves the BranchCache hash cache. - -## SYNTAX - -``` -Get-BCHashCache [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-BCHashCache** cmdlet retrieves an object that represents the BranchCache hash cache. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-BCHashCache -``` - -This example retrieves the BranchCache hash cache. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCacheHashCache -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCHostedCacheServerConfiguration.md b/docset/winserver2012-ps/branchcache/Get-BCHostedCacheServerConfiguration.md deleted file mode 100644 index 5ac5f27095..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCHostedCacheServerConfiguration.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: BranchCacheHostedCacheServerSettingData.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bchostedcacheserverconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCHostedCacheServerConfiguration - -## SYNOPSIS -Retrieves the current BranchCache hosted cache server settings. - -## SYNTAX - -``` -Get-BCHostedCacheServerConfiguration [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-BCHostedCacheServerConfiguration** cmdlet retrieves the current BranchCache hosted cache server settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCHostedCacheServerConfiguration -``` - -This example retrieves the current BranchCache hosted cache server settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCacheContentServerSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCNetworkConfiguration.md b/docset/winserver2012-ps/branchcache/Get-BCNetworkConfiguration.md deleted file mode 100644 index ddacd66179..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCNetworkConfiguration.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: BranchCacheNetworkSettingData.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bcnetworkconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCNetworkConfiguration - -## SYNOPSIS -Retrieves the current BranchCache network settings. - -## SYNTAX - -``` -Get-BCNetworkConfiguration [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-BCNetworkConfiguration** cmdlet retrieves the current BranchCache network settings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCNetworkConfiguration -``` - -This example retrieves the current BranchCache network settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Get-BCStatus.md b/docset/winserver2012-ps/branchcache/Get-BCStatus.md deleted file mode 100644 index 9237ace282..0000000000 --- a/docset/winserver2012-ps/branchcache/Get-BCStatus.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: BranchCacheStatus.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/get-bcstatus?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-BCStatus - -## SYNOPSIS -Retrieves a set of objects that provide BranchCache status and configuration information. - -## SYNTAX - -``` -Get-BCStatus [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-BCStatus** cmdlet retrieves a set of objects that provide BranchCache status and configuration information. -This cmdlet retrieves all of the objects returned by Get-BCClientSettings, Get-BCContentServerSettings, Get-BCHostedCacheServerSettings and Get-BCNetworkSettings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCStatus -``` - -This example retrieves a set of objects that provide BranchCache status and configuration information. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetBranchCache -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-BCClientConfiguration](./Get-BCClientConfiguration.md) - -[Get-BCContentServerConfiguration](./Get-BCContentServerConfiguration.md) - -[Get-BCHostedCacheServerConfiguration](./Get-BCHostedCacheServerConfiguration.md) - -[Get-BCNetworkConfiguration](./Get-BCNetworkConfiguration.md) - diff --git a/docset/winserver2012-ps/branchcache/Import-BCCachePackage.md b/docset/winserver2012-ps/branchcache/Import-BCCachePackage.md deleted file mode 100644 index 237ae97392..0000000000 --- a/docset/winserver2012-ps/branchcache/Import-BCCachePackage.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/import-bccachepackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-BCCachePackage - -## SYNOPSIS -Imports a cache package. - -## SYNTAX - -``` -Import-BCCachePackage [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-BCCachePackage** cmdlet imports a cache package. -A cache package contains file and web data that can be imported on remote hosted cache computers, so that it is available for the first client request. -Use the Publish-BCFileContent and Publish-BCWebContent cmdlets to collect data on file and web servers into a cache package, then use the Export-BCCachePackage cmdlet to generate a cache package file. -Import this file on hosted cache computers using this cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Import-BCCachePackage -Path D:\temp\PeerDistPackage.zip -``` - -This example imports all content that exported into the cache package located at D:\temp\PeerDistPackage.zip. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the fully qualified filename location of the cache package that is to be imported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Export-BCCachePackage](./Export-BCCachePackage.md) - -[Publish-BCFileContent](./Publish-BCFileContent.md) - -[Publish-BCWebContent](./Publish-BCWebContent.md) - diff --git a/docset/winserver2012-ps/branchcache/Import-BCSecretKey.md b/docset/winserver2012-ps/branchcache/Import-BCSecretKey.md deleted file mode 100644 index 847f0b4f89..0000000000 --- a/docset/winserver2012-ps/branchcache/Import-BCSecretKey.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/import-bcsecretkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-BCSecretKey - -## SYNOPSIS -Imports the cryptographic key that BranchCache uses for the generation of segment secrets. - -## SYNTAX - -``` -Import-BCSecretKey [-Filename] -FilePassphrase [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Import-BCSecretKey** cmdlet imports the cryptographic key that BranchCache uses for the generation of segment secrets. -Use this cmdlet when deploying BranchCache enabled content servers in a cluster or behind a network load balancer. -If a file or webpage exists on multiple content servers, then each server must use the same secret key; otherwise, each copy of the file will be cached separately within the branch office. - -Use the Export-BCSecretKey cmdlet to export the secret key from one server to a file. -Import the contents of this file using this cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Import-BCSecretKey -Filename C:\share1\secretkey.key -FilePassphrase mySecretPhrase -``` - -This example imports the key material in the file C:\share1\secretkey.key encrypted with the passphrase mySecretPhrase. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FilePassphrase -Specifies the passphrase for the file containing the key information to be affected by this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filename -Specifies the path of the file to be affected by this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Export-BCSecretKey](./Export-BCSecretKey.md) - -[Set-BCSecretKey](./Set-BCSecretKey.md) - diff --git a/docset/winserver2012-ps/branchcache/Publish-BCFileContent.md b/docset/winserver2012-ps/branchcache/Publish-BCFileContent.md deleted file mode 100644 index 91c4bcb6b6..0000000000 --- a/docset/winserver2012-ps/branchcache/Publish-BCFileContent.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/publish-bcfilecontent?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Publish-BCFileContent - -## SYNOPSIS -Generates hashes, also called content information, for files in shared folders on a file server that have BranchCache enabled and the BranchCache for Network Files role service installed. - -## SYNTAX - -``` -Publish-BCFileContent [-Path] [-UseVersion ] [-StageData] [-StagingPath ] - [-ReferenceFile ] [-Force] [-Recurse] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Publish-BCFileContent** cmdlet generates hashes, also called content information, for files in shared folders on file servers that have BranchCache enabled and the BranchCache for Network Files role service installed. - -This cmdlet is also used to stage data for the creation of a data preloading package. -Run this cmdlet with the **StageData** parameter on one or more collections of files, then call the Export-BCCachePackage cmdlet to produce a data package containing all the staged data. -This data package can be imported on remote hosted cache computers. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Publish-BCFileContent -Path D:\share -StageData -``` - -This example hashes the contents of D:\share and adds the data to a cache package, that can later be exported and sent to a remote hosted cache server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the file path, or the path to a directory containing files, that will be hashed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Recurse -Specifies that hashes are created for content in subfolders. -If you do not use this parameter, then hashes are created only for content in the top folder and no hashes are created for content in subfolders. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReferenceFile -Specifies a reference file from a previous run. -A reference file contains a list of identifiers that describe the data in a data package. -If a reference file is supplied, all data described in that file will be excluded from the output of this cmdlet. -Reference files can be used to create data packages that only contain the changes from the previous time a data package was created including the target data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StageData -Specifies that the data should be saved to a staging area for future export using the Export-BCCachePackage cmdlet. -Use this parameter if a data package for export is being created. -If this parameter in not specified, then hashes are generated for data, but the data is not prepared for export. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StagingPath -Specifies a temporary folder to which to output the staging data. -If a location is not specified, then a default location on the local hard drive is used. -Use this parameter if a large data package is being created that must be housed on a separate hard drive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseVersion -Specifies the version of the BranchCache hashing scheme to use. -If version specified is `1`, then content information is generated according to the scheme used by firstref_client_7 clients. -If version specified is `2`, then content information is generated according to the more efficient hashing scheme used by client computers that are running operating systems later than Windows® 7. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Export-BCCachePackage](./Export-BCCachePackage.md) - diff --git a/docset/winserver2012-ps/branchcache/Publish-BCWebContent.md b/docset/winserver2012-ps/branchcache/Publish-BCWebContent.md deleted file mode 100644 index 9cf3882fbf..0000000000 --- a/docset/winserver2012-ps/branchcache/Publish-BCWebContent.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/publish-bcwebcontent?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Publish-BCWebContent - -## SYNOPSIS -Creates hashes for web content when deploying content servers that are running Windows Server® 8 Beta with the Web Services (IIS) server role installed. - -## SYNTAX - -``` -Publish-BCWebContent [-Path] [-UseVersion ] [-StageData] [-StagingPath ] - [-ReferenceFile ] [-Force] [-Recurse] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Publish-BCWebContent** cmdlet creates hashes for web content when content servers are deployed running Windows Server® 2012 with the Web Services (IIS) server role installed. -In addition, the web server must be configured as a BranchCache content server by installing the BranchCache feature. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Publish-BCWebContent -Path D:\inetpub\wwwroot -Recurse -``` - -This example pre-hashes the contents of wwwroot, so that hashes are available as soon as requests are made. - -### EXAMPLE 2 -``` -PS C:\>Publish-BCWebContent -Path D:\inetpub\wwwroot -StageData -``` - -This example adds data to a data package, that can later be exported and preloaded on a remote hosted cache server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet asks for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the file path, or the path to a directory containing files, that will be hashed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Recurse -Specifies that hashes are created for content in subfolders. -If this parameter is not used, then hashes are created only for content in the top folder; no hashes are created for content in subfolders.. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReferenceFile -Specifies a reference file from a previous run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StageData -Specifies that the hashes should be saved to a staging area for future export. -Use this parameter if a data package is created for export. -If this parameter is not specified, then hashes are generated for data, but data is not prepared for export. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StagingPath -Specifies the folder location where staging data is stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseVersion -Specifies the version of the BranchCache hashing scheme to use. -If the specified version is `1`, then the content information is generated according to the scheme used by firstref_client_7clients. -If the specified version is `2`, then the content information is generated according to the more efficient hashing scheme used by client computers that are running operating systems later than Windows® 7. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Remove-BCDataCacheExtension.md b/docset/winserver2012-ps/branchcache/Remove-BCDataCacheExtension.md deleted file mode 100644 index 8fb5df6e90..0000000000 --- a/docset/winserver2012-ps/branchcache/Remove-BCDataCacheExtension.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/remove-bcdatacacheextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-BCDataCacheExtension - -## SYNOPSIS -Deletes a data cache file. - -## SYNTAX - -### Path (Default) -``` -Remove-BCDataCacheExtension [-Force] [-Path] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### DataCacheExtension -``` -Remove-BCDataCacheExtension [-Force] [-DataCacheExtension] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-BCDataCacheExtension** cmdlet deletes the cache file that is specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-BCDataCacheExtension | Where-Object -FilterScript {$_.MaxCacheSizeAsPercentageOfDiskVolume -Eq 10} | Remove-BCDataCacheExtension -``` - -This example removes data cache extensions configured to occupy 10% of disk volume. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataCacheExtension -Specifies the data cache extension that should be removed. -A BranchCache CimInstance#root\StandardCimv2\MSFT_NetBranchCacheDataCacheExtension CIM object can be obtained using the Get-BCDataCacheExtension cmdlet. - -If a value for this parameter is specified, then do not specify a value for the **Path** parameter, or an error will occur. -Use either this parameter or the **Path** parameter, but not both. - -```yaml -Type: CimInstance[] -Parameter Sets: DataCacheExtension -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet asks for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Removes the data cache extension at the location that you specify. -If a value for this parameter is specified, then do not specify a value for the **DataCacheExtension** parameter, or an error will occur. -Use either this parameter or the **DataCacheExtension** parameter, but not both - -```yaml -Type: String -Parameter Sets: Path -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/?LinkID=113423) - -[Add-BCDataCacheExtension](./Add-BCDataCacheExtension.md) - -[Get-BCDataCacheExtension](./Get-BCDataCacheExtension.md) - diff --git a/docset/winserver2012-ps/branchcache/Reset-BC.md b/docset/winserver2012-ps/branchcache/Reset-BC.md deleted file mode 100644 index 01ac81a31d..0000000000 --- a/docset/winserver2012-ps/branchcache/Reset-BC.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/reset-bc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-BC - -## SYNOPSIS -Resets BranchCache to the default configuration. - -## SYNTAX - -``` -Reset-BC [-ResetFWRulesOnly] [-ResetPerfCountersOnly] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Reset-BC** cmdlet resets BranchCache to a default configuration. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Reset-BC -``` - -This example resets BranchCache to the default configuration. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet asks for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetFWRulesOnly -Specifies that only the Windows firewall rules are reset. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetPerfCountersOnly -Resets the BranchCache performance counters without altering other BranchCache settings. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Set-BCAuthentication.md b/docset/winserver2012-ps/branchcache/Set-BCAuthentication.md deleted file mode 100644 index 4a3bd2b922..0000000000 --- a/docset/winserver2012-ps/branchcache/Set-BCAuthentication.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/set-bcauthentication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-BCAuthentication - -## SYNOPSIS -Specifies the BranchCache computer authentication mode. - -## SYNTAX - -``` -Set-BCAuthentication [-Mode] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-BCAuthentication** cmdlet specifies the authentication mode for client computers. -This can be set on a hosted cache server to enable clients to prove domain membership before uploading data. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-BCAuthentication -ClientAuthenticationMode Domain -``` - -This example configures client computers to use domain authentication mode when requesting content from a hosted cache server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet asks for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the authentication mode. -The acceptable values for this parameter are: Domain or None. - -```yaml -Type: ClientAuthenticationMode -Parameter Sets: (All) -Aliases: -Accepted values: None, Domain - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Set-BCCache.md b/docset/winserver2012-ps/branchcache/Set-BCCache.md deleted file mode 100644 index abde8b6d48..0000000000 --- a/docset/winserver2012-ps/branchcache/Set-BCCache.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/set-bccache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-BCCache - -## SYNOPSIS -Modifies the cache file configuration. - -## SYNTAX - -### Path (Default) -``` -Set-BCCache [-MoveTo ] [-Percentage ] [-SizeBytes ] [-Defragment] [-Force] [-PassThru] - [[-Path] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -### Cache -``` -Set-BCCache [-MoveTo ] [-Percentage ] [-SizeBytes ] [-Defragment] [-Force] [-PassThru] - [-Cache] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-BCCache** cmdlet modifies the cache file configuration. -Use the **Cache** parameter to specify which cache should be configured. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-BCCache -Path C:\datacache -MoveTo D:\datacache -``` - -This example moves the cache file from C:\datacache to D:\datacache. - -### Example 2 -``` -PS C:\>Get-BCDataCacheExtension | Where-Object -FilterScript {$_.MaxCacheSizeAsPercentageOfDiskVolume -Eq 10} | Set-BCCache -Percentage 20 -``` - -This example increases data cache files from 10% to 20%. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cache -Specifies the cache which should be modified. - -```yaml -Type: CimInstance[] -Parameter Sets: Cache -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defragment -Specifies that the cache should be defragmented. -Fragmented cache files store data less effectively. -The BranchCache service detects cache fragmentation and raises an event in the Windows Event Log when it is time to defragment the cache. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet asks for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MoveTo -Specifies the new location on disk for this cache file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Runs the cmdlet on the specified cache file. - -```yaml -Type: String -Parameter Sets: Path -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Percentage -Specifies the new size of this cache file. -The size is a percentage of the disk. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SizeBytes -Specifies the new size of the cache file. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimV2\MSFT_NetBranchCacheCache[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/?LinkID=113423) - -[Clear-BCCache](./Clear-BCCache.md) - -[Get-BCDataCacheExtension](./Get-BCDataCacheExtension.md) - diff --git a/docset/winserver2012-ps/branchcache/Set-BCDataCacheEntryMaxAge.md b/docset/winserver2012-ps/branchcache/Set-BCDataCacheEntryMaxAge.md deleted file mode 100644 index 90d466845b..0000000000 --- a/docset/winserver2012-ps/branchcache/Set-BCDataCacheEntryMaxAge.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/set-bcdatacacheentrymaxage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-BCDataCacheEntryMaxAge - -## SYNOPSIS -Modifies the maximum amount of time that data can remain in the cache. - -## SYNTAX - -``` -Set-BCDataCacheEntryMaxAge [-TimeDays] [-Force] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-BCDataCacheEntryMaxAge** cmdlet specifies the maximum amount of time that data can remain in the cache. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-BCDataCacheEntryMaxAge -TimeDays 100 -``` - -This example specifies that content information and content remain in the cache for 100 days. -After 100 days in the cache, the content is deleted. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeDays -Specifies the number of days, as an integer, that content information and content remain in the cache before being deleted. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Set-BCMinSMBLatency.md b/docset/winserver2012-ps/branchcache/Set-BCMinSMBLatency.md deleted file mode 100644 index edd3d890b9..0000000000 --- a/docset/winserver2012-ps/branchcache/Set-BCMinSMBLatency.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/set-bcminsmblatency?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-BCMinSMBLatency - -## SYNOPSIS -Sets the minimum latency that must exist between client and server before transparent caching functions are utilized. - -## SYNTAX - -``` -Set-BCMinSMBLatency [-LatencyMilliseconds] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-BCMinSMBLatency** cmdlet sets the minimum latency that must exist between client and server before transparent caching functions are utilized. -Use this cmdlet to specify when client computers in branch offices start caching content from content servers based on the network latency, or delay, that occurs when the clients download content over a Wide Area Network (WAN) link. -When a value for this cmdlet is specified, which is the maximum round trip network latency allowed before caching begins, clients do not cache content until the network latency reaches the specified value; when network latency is greater than the value, clients begin caching content after they receive it from the content servers. - -For example, if the round trip network latency value is set to zero (`0`), the client computers always cache content that they receive from the content servers, no matter how high or low the network latency is between their request for a file and their receipt of the file from the content server. -In another example, if the round trip network latency value is set to `100` milliseconds, then the clients do not cache content that they receive before `100` milliseconds pass, but they do begin to cache content that they receive after `100` milliseconds pass. - -By default, the value of this setting is `80` milliseconds. -To ensure that client computers always cache content, set the network latency value to `0`. - -To prevent caching except in circumstances where network latency is extremely long, set the latency value to a very high value. -If a high value is used, however, then it is possible that network latency will not reach this long a delay, in which case BranchCache is disabled on your network. - -Whether this setting is disabled or not configured, the client computer will cache network files if the round trip network latency of the wide area network (WAN) link is above `80` milliseconds. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-BCMinSMBLatency -LatencyMilliseconds 20 -``` - -This example sets the minimum latency that must exist between client and server before transparent caching functions are utilized to 20 milliseconds. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LatencyMilliseconds -Specifies the minimum latency that must exist between client and server before BranchCache begins caching content. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-BC](./Disable-BC.md) - -[Reset-BC](./Reset-BC.md) - diff --git a/docset/winserver2012-ps/branchcache/Set-BCSecretKey.md b/docset/winserver2012-ps/branchcache/Set-BCSecretKey.md deleted file mode 100644 index aa4d075fc4..0000000000 --- a/docset/winserver2012-ps/branchcache/Set-BCSecretKey.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: BranchCacheOrchestrator.cdxml-help.xml -Module Name: BranchCache -online version: https://learn.microsoft.com/powershell/module/branchcache/set-bcsecretkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-BCSecretKey - -## SYNOPSIS -Sets the cryptographic key used in the generation of segment secrets. - -## SYNTAX - -``` -Set-BCSecretKey [[-Passphrase] ] [-Force] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-BCSecretKey** cmdlet sets the cryptographic key used in the generation of segment secrets. -Use this cmdlet when deploying BranchCache-enabled content servers in a cluster or behind a network load balancer. -If a file or webpage exists on multiple content servers, then each server must use the same secret key; otherwise, each copy of the file will be cached separately within the branch office. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-BCSecretKey -Passphrase mySecretPhrase -``` - -This example sets the cryptographic key that is used in the generation of segment secrets, using the pass phrase mySecretPhrase. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passphrase -Specifies the pass phrase to use in the computation of the server secret key. -Run this cmdlet on each server in a cluster using the same passphrase to ensure a common segment secret is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Export-BCSecretKey](./Export-BCSecretKey.md) - -[Import-BCSecretKey](./Import-BCSecretKey.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Add-CauClusterRole.md b/docset/winserver2012-ps/clusterawareupdating/Add-CauClusterRole.md deleted file mode 100644 index fe652e949d..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Add-CauClusterRole.md +++ /dev/null @@ -1,630 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/add-cauclusterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-CauClusterRole - -## SYNOPSIS -Adds the Cluster-Aware Updating (CAU) clustered role that provides the self-updating functionality to the specified cluster. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-CauPluginArguments ] - [-CauPluginName ] [-ConfigurationName ] [-DaysOfWeek ] [-EnableFirewallRules] - [-Force] [-GroupName ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ] - [-PostUpdateScript ] [-PreUpdateScript ] [-RebootTimeoutMinutes ] - [-RequireAllNodesOnline] [-RunPluginsSerially] [-SeparateReboots] [-StartDate ] - [-StopAfter ] [-StopOnPluginFailure] [-VirtualComputerObjectName ] [-WarnAfter ] - [-WeeksOfMonth ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-CauPluginArguments ] - [-CauPluginName ] [-ConfigurationName ] [-DaysOfWeek ] [-EnableFirewallRules] - [-Force] [-GroupName ] [-IntervalWeeks ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] - [-NodeOrder ] [-PostUpdateScript ] [-PreUpdateScript ] - [-RebootTimeoutMinutes ] [-RequireAllNodesOnline] [-RunPluginsSerially] [-SeparateReboots] - [-StartDate ] [-StopAfter ] [-StopOnPluginFailure] [-VirtualComputerObjectName ] - [-WarnAfter ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-CauClusterRole** cmdlet adds the Cluster-Aware Updating (CAU) clustered role that provides the self-updating functionality to the specified cluster. -When the CAU clustered role has been added to a cluster, the failover cluster can update itself on the schedule that is specified by the user, without requiring an external computer to coordinate the cluster updating process. - -Note: To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. -To do this, run the Enable-PSRemotinghttp://go.microsoft.com/fwlink/p/?LinkID=144300 cmdlet. -In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday,Saturday -WeeksOfMonth 2,4 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -PostUpdateScript \\CONTOSOFileShare\scripts\verifyupdatesinstalled.ps1 -RequireAllNodesOnline -EnableFirewallRules -Force -``` - -This example adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. -The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays on the second and fourth weeks of each month. -In an Updating Run, the maximum number of failed nodes is two and the maximum number of retries per node is two. -A script called verifyupdatesinstalled.ps1 runs on each node after it has been fully updated. -Before an Updating Run can begin, all the nodes of that cluster must be running. -If it is not already enabled, the **Remote Shutdown** Windows Firewall rule group will be enabled on each cluster node. -The cmdlet runs without displaying confirmation prompts. - -### EXAMPLE 2 -``` -PS C:\> Add-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday,Saturday -WeeksInterval 3 -MaxFailedNodes 2 -MaxRetriesPerNode 2 -EnableFirewallRules -Force -``` - -This example adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. -The CAU clustered role is configured to perform Updating Runs on Tuesdays and Saturdays at an interval of every three weeks. -In an Updating Run, the maximum number of failed nodes is two and the maximum number of retries per node is two. -Updating Runs can begin even when the nodes of the cluster are not all running (as long as the cluster itself has quorum and is running). -If it is not already enabled, the **Remote Shutdown** Windows Firewall rule group will be enabled on each cluster node. -The cmdlet runs without displaying confirmation prompts. - -### EXAMPLE 3 -``` -PS C:\> Add-CauClusterRole -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ 'IncludeRecommendedUpdates' = 'True' }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName' } -StopOnPluginFailure -EnableFirewallRules -Force -``` - -This example adds the CAU clustered role, using a default name, on the cluster called CONTOSO-FC1. -The CAU clustered role is configured to perform updates using the **Microsoft.WindowsUpdatePlugin** plug-in with the optional **'IncludeRecommendedUpdates'** parameter set to **'True'**, and using the **Microsoft.HotfixPlugin plug-in** using the hotfix root folder \\\\CauHotfixSrv\shareName and the default hotfix configuration file. -If a failure occurs during the installation of updates on a node by **Microsoft.WindowsUpdatePlugin**, updates will not be applied by **Microsoft.HotfixPlugin plug-in**. -If it is not already enabled, the **Remote Shutdown** Windows Firewall rule group will be enabled on each cluster node. -The cmdlet runs without displaying confirmation prompts. - -## PARAMETERS - -### -CauPluginArguments -Passes a set of name=value pairs (arguments) for each updating plug-in to use. -For example, to specify a Domain argument for one plug-in: - - - `@{Domain=Domain.local}` - -You can specify multiple pairs in a set separated with semicolons. -For example: - - - `@{name1=value1;name2=value2;name3=value3}` - -These name=value pairs must be meaningful to the **CauPluginName** that you specify. - -If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by commas. -For example: - - - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` - - -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: - - - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. -If not specified, the default value is **'False'**. - - - A standard Windows Update Agent query string that specifies criteria used by the Windows Update Agent to filter the updates that will be applied to each node. -For a name, use **QueryString** and for a value, enclose the full query in quotation marks. - -If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1" and IsAssigned=1` - - For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see the topic about search criteria in the Windows Update Agent (WUA) API Referencehttp://go.microsoft.com/fwlink/p/?LinkId=223304. - - -For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: - - - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file - - -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - - - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. -If not specified, the default value is **'False'**. -To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. - - - **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for sufficient permissions on the hotfix root folder and the hotfix configuration file. -If not specified, the default value is **'False'**. - - - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. -If not specified, the default value is 30 minutes. - - - **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name DefaultHotfixConfigFile.xml is used. - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CauPluginName -Specifies one or more plug-ins to use when performing scans or updates. -You can specify multiple values separated with commas. -The default is the Microsoft.WindowsUpdatePlugin plug-in. -This plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. -For more information about how plug-ins work with CAU, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster on which to create the CAU clustered role. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by **PreUpdateScript** and **PostUpdateScript**) and cmdlets are run, and can limit the cmdlets that are available to be run. -If either a pre-update or post-update script is specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell® ("Microsoft.PowerShell") is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfWeek -Specifies the days of the week on which the updating task will be triggered. -Multiple values can be specified either separated with commas or as a hexadecimal sum. - - - **Sunday:** (0x01) - - - **Monday:** (0x02) - - - **Tuesday:** (0x04) - - - **Wednesday:** (0x08) - - - **Thursday:** (0x10) - - - **Friday:** (0x20) - - - **Saturday:** (0x40) -**Examples:** - - - **-DaysOfWeek: **Monday, Wednesday, Friday - - - **-DaysOfWeek:** 0x02, 0x08, 0x20 - - - **-DaysOfWeek:** 0x2A - -```yaml -Type: Weekdays -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFirewallRules -Enables the **Remote Shutdown** Windows Firewall rule group on each cluster node, if it is not already enabled. -If the **EnableFirewallRules** parameter is specified, CAU will also automatically re-enable the **Remote Shutdown** rule group each time the CAU clustered role performs an Updating Run, in case the rules are disabled manually in the intervening time. -Enabling this rule group permits inbound communication to each cluster node during each Updating Run that allows CAU to shut down and restart the node remotely (if the installation of an update requires a restart). -If Windows Firewall is in use on the cluster nodes and the rule group is not enabled, the Updating Run will fail. -The **Remote Shutdown** Windows Firewall rule group is not enabled when it will conflict with Group Policy settings that are configured for Windows Firewall. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupName -The NetBIOS name of the resource group for the CAU clustered role. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalWeeks -Specifies the interval between weeks when the task will be triggered. -An interval of `1` produces a weekly schedule. -An interval of `2` produces an every-other week schedule. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxFailedNodes -Specifies the maximum number of nodes on which updating can fail. -If one more than this number of nodes fails, then the Updating Run is stopped. -The range is from zero (`0`) through 1 less than the number of cluster nodes. -The default for most clusters is approximately one-third of the number of nodes. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRetriesPerNode -Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. -The maximum is `64` and the default is `3`. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeOrder -Specifies the names of the cluster nodes in the order that they should be updated. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostUpdateScript -Specifies the path and file name for a Windows PowerShell script to run on each node after updating finishes, and just after the node is brought out of **Maintenance** mode. -The file name extension must be .ps1 and the total length of the path plus the file name must be no longer than 260 characters. -As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all of the cluster nodes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreUpdateScript -Specifies the path and file name for a Windows PowerShell script to run on each node before updating begins, and before the node is put into **Maintenance** mode. -The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. -As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all of the cluster nodes. -If a pre-update script fails, the node is not updated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RebootTimeoutMinutes -Specifies the time in minutes that CAU will allow for the restarting of a node (if a restart is necessary). -If the restart does not complete within this time, then the Updating Run on that node will be marked as failed. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 15 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAllNodesOnline -Specifies that all cluster nodes must be online and reachable before updating begins. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunPluginsSerially -When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in **CauPluginName**. -By default, CAU scans and stages the applicable updates for all plug-ins in parallel. -Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SeparateReboots -When multiple plug-ins are used during an Updating Run, specifies that CAU will shut down and restart a cluster node after each plug-in installs updates on the node, if the installation of an update by a plug-in requires a restart. -By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Specifies the earliest date on which the Updating Run can be triggered. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopAfter -Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. -The time span can be expressed in the standard ways available in Windows PowerShell, for example, `01:30:00` represents one hour and thirty minutes. -By default, the Updating Run is allowed an unlimited amount of time to complete. -**Note:** If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopOnPluginFailure -When multiple plug-ins are used during an Updating Run, specifies that if a failure occurs during the application of updates on a node by any plug-in, subsequent updates on the node that are coordinated by the remaining plug-ins are stopped. -By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualComputerObjectName -Specifies the name of a prestaged virtual computer object that is used by the CAU clustered role. -For more information, see the Steps to create computer objects in Active Directoryhttp://go.microsoft.com/fwlink/p/?LinkId=237624. -If not specified, then a virtual computer object is created using a generated name. -Generating a name automatically requires the cluster name object to have permissions to create the virtual computer object in Active Directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnAfter -Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. -By default, no warning will be logged, regardless of the time taken by the Updating Run. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeeksOfMonth -Specifies the weeks of the month when the Updating Run should be run. -The value `5` represents the last week of the month. - -```yaml -Type: Int32[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) - -[Get-CauClusterRole](./Get-CauClusterRole.md) - -[Remove-CauClusterRole](./Remove-CauClusterRole.md) - -[Set-CauClusterRole](./Set-CauClusterRole.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/ClusterAwareUpdating.md b/docset/winserver2012-ps/clusterawareupdating/ClusterAwareUpdating.md deleted file mode 100644 index f67be612d6..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/ClusterAwareUpdating.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 4e804861-1dce-46c1-868d-c8f2ab9d220a -Module Name: ClusterAwareUpdating ---- - -# ClusterAwareUpdating Module -## Description -This reference provides cmdlet descriptions and syntax for all Cluster-Aware Updating-specific cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## ClusterAwareUpdating Cmdlets -### [Add-CauClusterRole](./Add-CauClusterRole.md) -Adds the Cluster-Aware Updating (CAU) clustered role that provides the self-updating functionality to the specified cluster. - -### [Disable-CauClusterRole](./Disable-CauClusterRole.md) -Suspends the self-updating functionality on the specified cluster. - -### [Enable-CauClusterRole](./Enable-CauClusterRole.md) -Re-enables the self-updating functionality on the specified cluster. - -### [Export-CauReport](./Export-CauReport.md) -Exports one or more Updating Run reports into an HTML or CSV-formatted document. - -### [Get-CauClusterRole](./Get-CauClusterRole.md) -Retrieves configuration properties of the Cluster-Aware Updating (CAU) clustered role on the specified cluster. - -### [Get-CauPlugin](./Get-CauPlugin.md) -Retrieves information about one or more software updating plug-ins that are registered on the local computer. - -### [Get-CauReport](./Get-CauReport.md) -Retrieves the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters. - -### [Get-CauRun](./Get-CauRun.md) -Retrieves status information about an Updating Run currently in progress. - -### [Invoke-CauRun](./Invoke-CauRun.md) -Performs a scan of cluster nodes for applicable updates and installs those updates via an Updating Run on the specified cluster. - -### [Invoke-CauScan](./Invoke-CauScan.md) -Performs a scan of cluster nodes for applicable updates and returns a list of the initial set of updates that would be applied to each node in a specified cluster. - -### [Register-CauPlugin](./Register-CauPlugin.md) -Registers a Cluster-Aware Updating (CAU) software updating plug-in on the local computer. - -### [Remove-CauClusterRole](./Remove-CauClusterRole.md) -Removes the Cluster-Aware Updating (CAU) clustered role from the specified failover cluster. - -### [Save-CauDebugTrace](./Save-CauDebugTrace.md) -Saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file. - -### [Set-CauClusterRole](./Set-CauClusterRole.md) -Sets configuration properties for the Cluster-Aware Updating (CAU) clustered role on the specified cluster. - -### [Stop-CauRun](./Stop-CauRun.md) -Stops an Updating Run that is in progress on a cluster. - -### [Test-CauSetup](./Test-CauSetup.md) -Tests whether a cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU). - -### [Unregister-CauPlugin](./Unregister-CauPlugin.md) -Removes a software updating plug-in from the list of plug-ins that are used by Cluster-Aware Updating (CAU). - diff --git a/docset/winserver2012-ps/clusterawareupdating/Disable-CauClusterRole.md b/docset/winserver2012-ps/clusterawareupdating/Disable-CauClusterRole.md deleted file mode 100644 index 406e3219d6..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Disable-CauClusterRole.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/disable-cauclusterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-CauClusterRole - -## SYNOPSIS -Suspends the self-updating functionality on the specified cluster. - -## SYNTAX - -``` -Disable-CauClusterRole [[-ClusterName] ] [-Credential ] [-Force] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-CauClusterRole** suspends the self-updating functionality on the specified cluster. -The self-updating functionality of the cluster can be re-enabled with the Enable-CauClusterRole cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Disable-CauClusterRole -ClusterName CONTOSO-FC1 -Force -``` - -This example prevents the CAU clustered role on the CONTOSO-FC1 cluster from performing Updating Runs. -The cmdlet changes the status of the CAU clustered role to Offline. -The cmdlet runs without displaying confirmation prompts. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster on which to disable the self-updating functionality. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) - -[Get-CauClusterRole](./Get-CauClusterRole.md) - -[Remove-CauClusterRole](./Remove-CauClusterRole.md) - -[Set-CauClusterRole](./Set-CauClusterRole.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Enable-CauClusterRole.md b/docset/winserver2012-ps/clusterawareupdating/Enable-CauClusterRole.md deleted file mode 100644 index 4500bd7e34..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Enable-CauClusterRole.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/enable-cauclusterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-CauClusterRole - -## SYNOPSIS -Re-enables the self-updating functionality on the specified cluster. - -## SYNTAX - -``` -Enable-CauClusterRole [[-ClusterName] ] [-Credential ] [-Force] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-CauClusterRole** re-enables the self-updating functionality on the specified cluster. -The self-updating functionality of the cluster can be disabled with the Disable-CauClusterRole cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Enable-CauClusterRole -ClusterName CONTOSO-FC1 -Force -``` - -This example enables the CAU clustered role on the CONTOSO-FC1 cluster to begin performing Updating Runs. -The cmdlet changes the status of the CAU clustered role to Running. -The cmdlet runs without displaying confirmation prompts. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster on which to enable the self-updating functionality. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Get-CauClusterRole](./Get-CauClusterRole.md) - -[Remove-CauClusterRole](./Remove-CauClusterRole.md) - -[Set-CauClusterRole](./Set-CauClusterRole.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Export-CauReport.md b/docset/winserver2012-ps/clusterawareupdating/Export-CauReport.md deleted file mode 100644 index 1f66ca508c..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Export-CauReport.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/export-caureport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-CauReport - -## SYNOPSIS -Exports one or more Updating Run reports into an HTML or CSV-formatted document. - -## SYNTAX - -``` -Export-CauReport [-InputReport] [-Format] [-Path] [-Force] [-PassThru] - [-TimeZone ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Export-CauReport** cmdlet exports one or more Updating Run reports into an HTML or CSV-formatted document. -Each Run report summarizes both the node-level and cluster-level summary status for the Updating Run. - -Pipe one or more reports from the Get-CauReport cmdlet with the **Detailed** parameter, and control the content in the report by specifying appropriate parameters for the Get-CauReport cmdlet. -For example, the **Last** parameter specifies the most recent Updating Run. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-CauReport -ClusterName Contoso-FC1 -Last -Detailed | Export-CauReport -Format HTML -Path C:\temp\contoso-fc1_last.html -TimeZone ([system.timezoneinfo]::Utc) -``` - -This example gets a detailed version of the last CAU report for the cluster named Contoso-FC1, then exports that report in HTML format to the path C:\temp\contoso-fc1_last.html. -The timestamps in the report are formatted in the Coordinated Universal Time (UTC) zone. - -## PARAMETERS - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Format -Specifies the format of the output report. -The acceptable values for this parameter are: CSV or HTML. - -```yaml -Type: OutputType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputReport -Specifies one or more CAU report objects, such as generated from a call to Get-CauReport with the **Detailed** parameter. - -```yaml -Type: CauReport[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Passes the CAU report object back through the pipeline for further processing. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the local or complete path of the file to save the exported report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeZone -Allows formatting of the report timestamps to match the specified time zone. - -```yaml -Type: TimeZoneInfo -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.ClusterAwareUpdating.CauReport - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauReport - -## NOTES - -## RELATED LINKS - -[Get-CauReport](./Get-CauReport.md) - -[Invoke-CauRun](./Invoke-CauRun.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Get-CauClusterRole.md b/docset/winserver2012-ps/clusterawareupdating/Get-CauClusterRole.md deleted file mode 100644 index f3dd0fef12..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Get-CauClusterRole.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-cauclusterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CauClusterRole - -## SYNOPSIS -Retrieves configuration properties of the Cluster-Aware Updating (CAU) clustered role on the specified cluster. - -## SYNTAX - -``` -Get-CauClusterRole [[-ClusterName] ] [-Credential ] -``` - -## DESCRIPTION -The **Get-CauClusterRole** cmdlet retrieves configuration properties of the Cluster-Aware Updating (CAU) clustered role on the specified cluster. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-CauClusterRole -ClusterName CONTOSO-FC1 -Name Value ----- ----- -ResourceGroupName CAUCAUCldy8 -Status Online -StartDate 10/14/2011 3:00:00 AM -MaxFailedNodes 2 -MaxRetriesPerNode 2 -PostUpdateScript G:\verifyupdatesinstalled.ps1 -RequireAllNodesOnline On -DaysOfWeek Tuesday, Saturday -WeeksOfMonth {2, 4} -``` - -This example gets information about the CAU clustered role on the cluster called CONTOSO-FC1. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster for which the CAU clustered role information should be retrieved. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauParameter - -## NOTES - -## RELATED LINKS - -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) - -[Remove-CauClusterRole](./Remove-CauClusterRole.md) - -[Set-CauClusterRole](./Set-CauClusterRole.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Get-CauPlugin.md b/docset/winserver2012-ps/clusterawareupdating/Get-CauPlugin.md deleted file mode 100644 index 4e2f0b0606..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Get-CauPlugin.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-cauplugin?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CauPlugin - -## SYNOPSIS -Retrieves information about one or more software updating plug-ins that are registered on the local computer. - -## SYNTAX - -``` -Get-CauPlugin [[-Name] ] -``` - -## DESCRIPTION -The **Get-CauPlugin** cmdlet retrieves information about one or more software updating plug-ins that are registered on the local computer. -A plug-in can be specified or information can be retrieved about all registered plug-ins. - -CAU always uses a plug-in when performing updates. -The default is the Microsoft.WindowsUpdatePlugin plug-in. -This plug-in communicates with the Windows Update agent, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. -For more information about how plug-ins work in CAU, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-CauPlugin | Format-List -Property * -Name : Microsoft.WindowsUpdatePlugin -BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll -ClassName : MS.Internal.ClusterAwareUpdating.WuaPlugin -Name : Microsoft.HotfixPlugin -BinaryPath : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\ClusterAwareUpdating\ClusterAwareUpdating.dll -ClassName : MS.Internal.ClusterAwareUpdating.HotfixPlugin -``` - -This example gets information about the software updating plug-ins that are registered in the local CAU tool. - -## PARAMETERS - -### -Name -Specifies the name of the plug-in whose information should be retrieved. -If not specified, then information for all of the registered plug-ins is returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauPlugin - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/?LinkID=113302) - -[Register-CauPlugin](./Register-CauPlugin.md) - -[Unregister-CauPlugin](./Unregister-CauPlugin.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Get-CauReport.md b/docset/winserver2012-ps/clusterawareupdating/Get-CauReport.md deleted file mode 100644 index 278781b68d..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Get-CauReport.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caureport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CauReport - -## SYNOPSIS -Retrieves the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-CauReport [[-ClusterName] ] [-Credential ] [-Detailed] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-CauReport [[-ClusterName] ] [-Credential ] [-Detailed] [-Last] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-CauReport [[-ClusterName] ] [[-StartDate] ] [[-EndDate] ] - [-Credential ] [-Detailed] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-CauReport [[-ClusterName] ] [-Credential ] [-Report ] -``` - -## DESCRIPTION -The **Get-CauReport** cmdlet retrieves the Updating Run reports for all known Updating Runs, or all Updating Runs that match the specified dates or other specified parameters. -This cmdlet can return a list of all Updating Run reports between the specified **StartDate** and **EndDate** parameters, or if the **Last** parameter is specified instead of dates, then the cmdlet returns the most recent Updating Run report. -By default, the report contains summaries only, but more detail can be obtained with the **Detailed** parameter or by using the **Report** parameter and specifying a Cluster-Aware Updating (CAU) report summary object for which to return the detailed results. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -Detailed -``` - -This example returns a detailed list of the Updating Runs performed on the cluster called Contoso-FC1 on 01/01/2012 or later. - -### EXAMPLE 2 -``` -PS C:\> Get-CauReport -ClusterName Contoso-FC1 -StartDate 01/01/2012 -EndDate 04/01/2012 -Detailed -``` - -This example returns a detailed list of the Updating Runs performed on the cluster called Contoso-FC1 starting with Updating Runs on 01/01/2012 and ending with Updating Runs on 04/01/2012. - -### EXAMPLE 3 -``` -PS C:\> $CauReportSummary=Get-CauReport Contoso-FC1 -Last -Get-CauReport Contoso-FC1 -Report $CauReportSummary -``` - -This example uses a CAU report summary object called $CauReportSummary to return a detailed report of the last Updating Run performed on the cluster called Contoso-FC1. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster for which to retrieve reports. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Detailed -Specifies that the full results for one or more runs will be returned, instead of just summary information. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -Retrieves only the reports for Runs before this time. - -```yaml -Type: DateTime -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Last -Retrieves only the most recent Run report. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Report -Retrieves detailed results for the Run represented by the specified report summary. - -```yaml -Type: CauReportSummary -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -StartDate -Retrieves only the reports from Runs on or after this time. - -```yaml -Type: DateTime -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.ClusterAwareUpdating.CauReportSummary - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauReport - -### Microsoft.ClusterAwareUpdating.CauReportSummary - -## NOTES - -## RELATED LINKS - -[Export-CauReport](./Export-CauReport.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Get-CauRun.md b/docset/winserver2012-ps/clusterawareupdating/Get-CauRun.md deleted file mode 100644 index 9ad071531a..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Get-CauRun.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/get-caurun?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-CauRun - -## SYNOPSIS -Retrieves status information about an Updating Run currently in progress. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-CauRun [[-ClusterName] ] [-Credential ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-CauRun [[-ClusterName] ] [-Credential ] [-WaitForCompletion] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-CauRun [[-ClusterName] ] [-Credential ] [-ShowClusterNodeState] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-CauRun [[-ClusterName] ] [-Credential ] [-WaitForStart] -``` - -## DESCRIPTION -The **Get-CauRun** cmdlet retrieves status information about an Updating Run currently in progress. -Use this cmdlet to monitor current Updating Runs. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-CauRun -ClusterName CONTOSO-FC1 -RunId : 834dd11e-584b-41f2-8d22-4c9c0471dbad -RunStartTime : 10/13/2011 1:35:39 PM -CurrentOrchestrator : NODE1 -NodeStatusNotifications : { -Node : NODE1 -Status : Waiting -Timestamp : 10/13/2011 1:35:49 PM -} -NodeResults : { -Node : NODE2 -Status : Succeeded -ErrorRecordData : -NumberOfSucceededUpdates : 0 -NumberOfFailedUpdates : 0 -InstallResults : Microsoft.ClusterAwareUpdating.UpdateInstallResult[] -} -``` - -This example gets status information about the Updating Run currently in progress on the cluster called CONTOSO-FC1. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster for which to get the Updating Run status. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ShowClusterNodeState -If this parameter is specified, the cmdlet retrieves the status of the WMI object that is created on each cluster node. -This can be used to debug the status of leftover objects. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForCompletion -Returns after the Updating Run has finished, and writes the updated CAU run objects to the output stream as progress is recorded by the current CAU Update Coordinator. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WaitForStart -Returns only if there is an Updating Run in progress on the specified cluster, otherwise waits for an Updating Run to begin. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauRun - -### Microsoft.ClusterAwareUpdating.RunState - -## NOTES - -## RELATED LINKS - -[Invoke-CauRun](./Invoke-CauRun.md) - -[Stop-CauRun](./Stop-CauRun.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Invoke-CauRun.md b/docset/winserver2012-ps/clusterawareupdating/Invoke-CauRun.md deleted file mode 100644 index c0c9670940..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Invoke-CauRun.md +++ /dev/null @@ -1,534 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-caurun?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-CauRun - -## SYNOPSIS -Performs a scan of cluster nodes for applicable updates and installs those updates via an Updating Run on the specified cluster. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Invoke-CauRun [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-ConfigurationName ] [-EnableFirewallRules] [-Force] - [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ] [-PostUpdateScript ] - [-PreUpdateScript ] [-RebootTimeoutMinutes ] [-RequireAllNodesOnline] [-RunPluginsSerially] - [-SeparateReboots] [-StopAfter ] [-StopOnPluginFailure] [-WarnAfter ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Invoke-CauRun [[-ClusterName] ] [[-Credential] ] [-Force] [-ForceRecovery] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Invoke-CauRun** cmdlet performs a scan of cluster nodes for applicable updates and installs those updates via an Updating Run on the specified cluster. -The Updating Run process includes the following: - - - Scanning for and downloading applicable updates on each cluster node. - - - Moving currently running clustered roles off each cluster node. - - - Installing the updates on each cluster node. - - - Restarting cluster nodes if required by the installed updates. - - - Moving the clustered roles back to the original nodes. - -The Updating Run process also includes ensuring that quorum is maintained, checking for additional updates that can only be installed after the initial set of updates are installed, and saving a report of the actions taken. - -Note: To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameter, Windows PowerShell® remoting must be enabled on each node. -To do this, run the Enable-PSRemotinghttp://go.microsoft.com/fwlink/p/?LinkID=144300 cmdlet. -In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin -MaxFailedNodes -1 -MaxRetriesPerNode 3 -RequireAllNodesOnline -Force -``` - -This example performs a scan and a full Updating Run on the cluster named CONTOSO-FC1. -This cmdlet uses the Microsoft.WindowsUpdatePlugin plug-in and requires that all cluster nodes be online before the running this cmdlet. -In addition, this cmdlet allows no more than three retries per node before marking the node as failed, and allows no more than one node to fail before marking the entire Updating Run as failed. -This cmdlet is performed without confirmation prompts. - -### EXAMPLE 2 -``` -PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{ }, @{ 'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName' } -EnableFirewallRules -StopOnPluginFailure -SeparateReboots -Force -``` - -This example performs a scan and a full Updating Run on the cluster named CONTOSO-FC1. -This cmdlet uses the Microsoft.WindowsUpdatePlugin plug-in with the default configuration, and the Microsoft.HotfixPlugin plug-in using the hotfix root folder \\\\CauHotfixSrv\shareName and the default hotfix configuration file. -If it is not already enabled, the **Remote Shutdown** Windows Firewall rule group is enabled on each cluster node before the Updating Run. -If a failure occurs during the installation of updates on a node by **Microsoft.WindowsUpdatePlugin**, updates will not be applied by **Microsoft.HotfixPlugin plug-in**. -If the installation of updates by **Microsoft.WindowsUpdatePlugin** requires a node to restart, the node will restart before **Microsoft.HotfixPlugin plug-in** installs updates. -The cmdlet runs without displaying confirmation prompts. - -### EXAMPLE 3 -``` -PS C:\> Invoke-CauRun -ClusterName CONTOSO-FC1 -ForceRecovery -Force -``` - -This example recovers from a previous Updating Run that failed and left the cluster in a Locked state for the cluster named CONTOSO-FC1. -The recovery is performed without confirmation prompts. - -## PARAMETERS - -### -CauPluginArguments -Passes a set of name=value pairs (arguments) for each updating plug-in to use. -For example, to specify a Domain argument for one plug-in: - - - `@{Domain=Domain.local}` - -You can specify multiple pairs in a set separated with semicolons. -For example: - - - `@{name1=value1;name2=value2;name3=value3}` - -These name=value pairs must be meaningful to the **CauPluginName** that you specify. - -If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by commas. -For example: - - - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` - - -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: - - - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. -If not specified, the default value is **'False'**. - - - A standard Windows Update Agent query string that specifies criteria used by the Windows Update Agent to filter the updates that will be applied to each node. -For a name, use **QueryString** and for a value, enclose the full query in quotation marks. - -If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` - -For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see the topic about search criteria in the Windows Update Agent (WUA) API Referencehttp://go.microsoft.com/fwlink/p/?LinkId=223304. - - -For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - - - **HotfixRootFolderPath**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file - - -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - - - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. -If not specified, the default value is **'False'**. -To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. - - - **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for sufficient permissions on the hotfix root folder and the hotfix configuration file. -If not specified, the default value is **'False'**. - - - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. -If not specified, the default value is 30 minutes. - - - **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name DefaultHotfixConfig.xml is used. - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: Hashtable[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CauPluginName -Specifies one or more plug-ins to use when performing updates. -You can specify multiple values separated with commas. -The default is the Microsoft.WindowsUpdatePlugin plug-in. -This plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. -For more information about how plug-ins work with CAU, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster on which to install updates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by **PreUpdateScript** and **PostUpdateScript**) and cmdlets are run, and can limit the cmdlets that are available to be run. -If either a pre-update or post-update script is specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell ("Microsoft.PowerShell") is used. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFirewallRules -Enables the **Remote Shutdown** Windows Firewall rule group on each cluster node, if it is not already enabled. -If the **EnableFirewallRules** parameter is specified, CAU will also automatically re-enable the **Remote Shutdown** rule group each time the CAU clustered role performs an Updating Run, in case the rules are disabled manually in the intervening time. -Enabling this rule group permits inbound communication to each cluster node during each Updating Run that allows CAU to shut down and restart the node remotely (if the installation of an update requires a restart). -If Windows Firewall is in use on the cluster nodes and the rule group is not enabled, the Updating Run will fail. -The **Remote Shutdown** Windows Firewall rule group is not enabled when it will conflict with Group Policy settings that are configured for Windows Firewall. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceRecovery -Recovers from a previous failed run that left the cluster in a Locked state. -Note: This switch defeats the synchronization mechanism used to prevent two update coordinators from accidentally trying to update the same cluster at the same time. -Use with care. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxFailedNodes -Specifies the maximum number of nodes on which updating can fail. -If one more than this number of nodes fails, then the Updating Run is stopped. -The range is from zero (`0`) through 1 less than the number of cluster nodes. -The default for most clusters is approximately one-third of the number of nodes. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRetriesPerNode -Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. -The maximum is `64` and the default is `3`. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeOrder -Specifies the names of the cluster nodes in the order that they should be updated. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostUpdateScript -Specifies the path and file name for a Windows PowerShell script to run on each node after updating finishes, and just after the node is brought out of **Maintenance** mode. -The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. -As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that it is always accessible to all of the cluster nodes. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreUpdateScript -Specifies the path and file name for a Windows PowerShell script to run on each node before updating begins, and before the node is put into **Maintenance** mode. -The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. -As a best practice, the script should be located on a disk in cluster storage, or at a highly available network share, to ensure that the script is always accessible to all of the cluster nodes. -If a pre-update script fails, the node is not updated. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RebootTimeoutMinutes -Specifies the time in minutes that CAU will allow for the restarting of a node (if a restart is necessary). -If the restart does not complete within this time, then the Updating Run on that node will be marked as failed. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: 15 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAllNodesOnline -Specifies that all cluster nodes must be online and reachable before updating begins. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunPluginsSerially -When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in **CauPluginName**. -By default, CAU scans and stages the applicable updates for all plug-ins in parallel. -Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SeparateReboots -When multiple plug-ins are used during an Updating Run, specifies that CAU will shut down and restart a cluster node after each plug-in installs updates on the node, if the installation of an update by a plug-in requires a restart. -By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopAfter -Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. -The time span can be expressed in the standard ways available in Windows PowerShell, for example, `01:30:00` represents one hour and thirty minutes. -By default, the Updating Run is allowed an unlimited amount of time to complete. -**Note:** If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopOnPluginFailure -When multiple plug-ins are used during an Updating Run, specifies that if a failure occurs during the application of updates on a node by any plug-in, subsequent updates on the node that are coordinated by the remaining plug-ins are stopped. -By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnAfter -Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. -By default, no warning will be logged, regardless of the time taken by the Updating Run. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.ActivityIdMap - -### Microsoft.ClusterAwareUpdating.ClusterResult - -### Microsoft.ClusterAwareUpdating.NodeResult - -### Microsoft.ClusterAwareUpdating.NodeStatusNotification - -### Microsoft.ClusterAwareUpdating.UpdateInfo - -### Microsoft.ClusterAwareUpdating.UpdateInstallResult - -### Microsoft.ClusterAwareUpdating.UpdateStagingResult - -## NOTES - -## RELATED LINKS - -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Get-CauRun](./Get-CauRun.md) - -[Stop-CauRun](./Stop-CauRun.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Invoke-CauScan.md b/docset/winserver2012-ps/clusterawareupdating/Invoke-CauScan.md deleted file mode 100644 index a980039c5d..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Invoke-CauScan.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/invoke-causcan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-CauScan - -## SYNOPSIS -Performs a scan of cluster nodes for applicable updates and returns a list of the initial set of updates that would be applied to each node in a specified cluster. - -## SYNTAX - -``` -Invoke-CauScan [[-ClusterName] ] [[-CauPluginName] ] [[-Credential] ] - [-CauPluginArguments ] [-RunPluginsSerially] [-StopOnPluginFailure] -``` - -## DESCRIPTION -The **Invoke-CauScan** cmdlet performs a scan of cluster nodes for applicable updates and returns a list of the initial set of updates that would be applied to each node in a specified cluster. -Generating the list might take a few minutes. - -Note: The preview list includes only an initial set of updates. -The list does not include updates that might become applicable only after the initial updates are installed. - -Note: If the **Microsoft.HotfixPlugin** plug-in is specified, the scan returns only the list of hotfix files that are discovered on the hotfix file share. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Invoke-CauScan -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin -Verbose -``` - -This example provides a detailed list of the initial set of updates that would currently be applied to each node in the cluster named CONTOSO-FC1. -The list is based on the updates that would be applied by the Microsoft.WindowsUpdatePlugin plug-in, which is the default plug-in. -Note that the preview list includes only an initial set of updates, and does not include updates that might become applicable only after the initial updates are installed. - -### EXAMPLE 2 -``` -PS C:\> $secpasswd = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force -$cred = New-Object System.Management.Automation.PSCredential ("username", $secpasswd) -Invoke-CauScan -ClusterName CONTOSO-FC1 -CauPluginName Microsoft.WindowsUpdatePlugin, Microsoft.HotfixPlugin -CauPluginArguments @{'QueryString'="IsInstalled=0 and Type='Software' and IsHidden=0"},@{'HotfixRootFolderPath' = '\\CauHotfixSrv\shareName'} -Credential $cred -``` - -This example provides a detailed list of the initial set of updates that would currently be applied to each node in the cluster named CONTOSO-FC1. -The list is based on the updates that would be applied by the Microsoft.WindowsUpdatePlugin plug-in, using a specified query string, and the Microsoft.HotfixPlugin, after the necessary hotfixes and the hotfix configuration file have been downloaded to \\\\CauHotfixSrv\shareName. -This example also shows how to pass the administrative credentials for cluster CONTOSO-FC1 to the cmdlet. - -## PARAMETERS - -### -CauPluginArguments -Passes a set of name=value pairs (arguments) for each updating plug-in to use. -For example, to specify a Domain argument for one plug-in: - - - `@{Domain=Domain.local}` - -You can specify multiple pairs in a set separated with semicolons. -For example: - - - `@{name1=value1;name2=value2;name3=value3}` - -These name=value pairs must be meaningful to the **CauPluginName** that you specify. - -If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by commas. -For example: - - - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` - - -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: - - - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. -If not specified, the default value is **'False'**. - - - A standard Windows Update Agent query string that specifies criteria used by the Windows Update Agent to filter the updates that will be applied to each node. -For a name, use **QueryString** and for a value, enclose the full query in quotation marks. - -If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1"` - -For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see the topic about search criteria in the Windows Update Agent (WUA) API Referencehttp://go.microsoft.com/fwlink/p/?LinkId=223304. - - -For the **Microsoft.HotfixPlugin** plug-in. -the following argument is required: - - - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file - - -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - - - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. -If not specified, the default value is **'False'**. -To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. - - - **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for sufficient permissions on the hotfix root folder and the hotfix configuration file. -If not specified, the default value is **'False'**. - - - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. -If not specified, the default value is 30 minutes. - - - **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name DefaultHotfixConfig.xml is used. - - -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: Hashtable[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CauPluginName -Specifies one or more plug-ins to use when performing scans. -You can specify multiple values separated with commas. -The default is the Microsoft.WindowsUpdatePlugin plug-in. -This plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. -For more information about how plug-ins work with CAU, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster which should be scanned for applicable updates. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunPluginsSerially -When multiple plug-ins are used during a scan for updates, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in **CauPluginName**. -By default, CAU scans and stages the applicable updates for all plug-ins in parallel. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopOnPluginFailure -When multiple plug-ins are used during a scan for updates, specifies that if a failure occurs during a scan on a node by any plug-in, subsequent scans on the node that are coordinated by the remaining plug-ins are stopped. -By default, a failure by one plug-in does not affect the scans for updates on a node by other plug-ins. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauUpdateInfo - -## NOTES - -## RELATED LINKS - -[Invoke-CauRun](./Invoke-CauRun.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Register-CauPlugin.md b/docset/winserver2012-ps/clusterawareupdating/Register-CauPlugin.md deleted file mode 100644 index 255feddf44..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Register-CauPlugin.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/register-cauplugin?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Register-CauPlugin - -## SYNOPSIS -Registers a Cluster-Aware Updating (CAU) software updating plug-in on the local computer. - -## SYNTAX - -``` -Register-CauPlugin [-Path] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Register-CauPlugin** cmdlet registers a Cluster-Aware Updating (CAU) software updating plug-in on the local computer. - -CAU always uses a plug-in when performing updates, although you do not need to register a plug-in because CAU uses the Microsoft.WindowsUpdatePlugin plug-in by default. -This plug-in communicates with the Windows Update Agent software resident on each node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. -For more information about how plug-ins work in CAU, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Register-CauPlugin -Path c:\PluginDevelopment\Plugin01.dll -Force -``` - -The example registers a plug-in called Plugin01.dll located in the C:\PluginDevelopment folder. -The cmdlet runs without displaying confirmation prompts. - -## PARAMETERS - -### -Path -Specifies the path to the binary that implements the plug-in. -Classes that implement the plug-in interface and are decorated with the plug-in attribute, are discovered through reflection and registered. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauPlugin - -## NOTES - -## RELATED LINKS - -[Get-CauPlugin](./Get-CauPlugin.md) - -[Unregister-CauPlugin](./Unregister-CauPlugin.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Remove-CauClusterRole.md b/docset/winserver2012-ps/clusterawareupdating/Remove-CauClusterRole.md deleted file mode 100644 index efb99fd1f8..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Remove-CauClusterRole.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/remove-cauclusterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-CauClusterRole - -## SYNOPSIS -Removes the Cluster-Aware Updating (CAU) clustered role from the specified failover cluster. - -## SYNTAX - -``` -Remove-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-Force] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-CauClusterRole** cmdlet removes the Cluster-Aware Updating (CAU) clustered role from the specified failover cluster. -To run CAU from a cluster, ensure that the CAU clustered role is configured in that cluster. - -Note: The **Remove-CauClusterRole** cmdlet removes the virtual computer object (VCO) in Active Directory for the CAU clustered role, unless you previously prestaged or specified the VCO by running the **Add-CauClusterRole** cmdlet with the **VirtualComputerObjectName** parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-CauClusterRole -ClusterName CONTOSO-FC1 -Force -``` - -This example removes the instance of the CAU clustered role that is configured on the cluster named CONTOSO-FC1. -The example runs without displaying confirmation prompts. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster from which to remove the CAU clustered role. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) - -[Get-CauClusterRole](./Get-CauClusterRole.md) - -[Set-CauClusterRole](./Set-CauClusterRole.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Save-CauDebugTrace.md b/docset/winserver2012-ps/clusterawareupdating/Save-CauDebugTrace.md deleted file mode 100644 index 7b6d3c0c96..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Save-CauDebugTrace.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/save-caudebugtrace?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Save-CauDebugTrace - -## SYNOPSIS -Saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file. - -## SYNTAX - -``` -Save-CauDebugTrace [[-ClusterName] ] [[-FilePath] ] [-Credential ] [-Force] - [-RunId ] -``` - -## DESCRIPTION -The **Save-CauDebugTrace** cmdlet saves Cluster-Aware Updating (CAU) debug tracing information to a local zip file. -The tracing information is mainly intended for use by developers and support engineers. -Specify the file name with the **FilePath** parameter. - -Note: To run this cmdlet, Windows PowerShell® remoting must be enabled on each node. -To do this, run the Enable-PSRemotinghttp://go.microsoft.com/fwlink/p/?LinkID=144300 cmdlet. -In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Save-CauDebugTrace -ClusterName CONTOSO-FC1 -FilePath C:\temp\testrun.zip -``` - -This example saves the debug tracing information, for the cluster called CONTOSO-FC1, to a trace file called testrun.zip in the C:\temp folder. - -## PARAMETERS - -### -FilePath -Specifies the name of the file to which to save the tracing information, such as `MyTrace.zip`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that when the file specified by the **FilePath** parameter exists, it is overwritten without prompting for confirmation. -If **Force** is not specified, then when the file specified by the **FilePath** parameter exists, the cmdlet returns an error. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster for which to gather CAU debug tracing information. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunId -Indicates that the cmdlet should only include debug trace files related to an Updating Run with the specified Run ID. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Invoke-CauRun](./Invoke-CauRun.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Set-CauClusterRole.md b/docset/winserver2012-ps/clusterawareupdating/Set-CauClusterRole.md deleted file mode 100644 index 7366f01b27..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Set-CauClusterRole.md +++ /dev/null @@ -1,654 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/set-cauclusterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-CauClusterRole - -## SYNOPSIS -Sets configuration properties for the Cluster-Aware Updating (CAU) clustered role on the specified cluster. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-CauPluginArguments ] - [-CauPluginName ] [-ConfigurationName ] [-DaysOfWeek ] [-EnableFirewallRules] - [-Force] [-MaxFailedNodes ] [-MaxRetriesPerNode ] [-NodeOrder ] - [-PostUpdateScript ] [-PreUpdateScript ] [-RebootTimeoutMinutes ] - [-RequireAllNodesOnline] [-RunPluginsSerially] [-SeparateReboots] [-StartDate ] - [-StopAfter ] [-StopOnPluginFailure] [-UseDefault] [-WarnAfter ] [-WeeksOfMonth ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-CauPluginArguments ] - [-CauPluginName ] [-ConfigurationName ] [-DaysOfWeek ] [-EnableFirewallRules] - [-Force] [-IntervalWeeks ] [-MaxFailedNodes ] [-MaxRetriesPerNode ] - [-NodeOrder ] [-PostUpdateScript ] [-PreUpdateScript ] - [-RebootTimeoutMinutes ] [-RequireAllNodesOnline] [-RunPluginsSerially] [-SeparateReboots] - [-StartDate ] [-StopAfter ] [-StopOnPluginFailure] [-UseDefault] [-WarnAfter ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-Force] [-UpdateNow] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-CauClusterRole [[-ClusterName] ] [[-Credential] ] [-Force] [-UseDefault] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-CauClusterRole** cmdlet sets configuration properties for the Cluster-Aware Updating (CAU) clustered role on the specified cluster. -This cmdlet can specify properties such as the updating schedule and Updating Run parameters. - -Note: To run this cmdlet with the **PostUpdateScript** or **PreUpdateScript** parameter, Windows PowerShell® remoting must be enabled on each node. -To do this, run the Enable-PSRemotinghttp://go.microsoft.com/fwlink/p/?LinkId=144300 cmdlet. -In addition, ensure that the Windows Remote Management - Compatibility Mode (HTTP-In) firewall exception is enabled on each node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday -WeeksOfMonth 1,2 -RebootTimeoutMinutes 10 -Force -``` - -This example configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. -The CAU clustered role is configured to perform Updating Runs on Tuesdays on the first and second weeks of each month. -The CAU clustered role will allow 10 minutes for the restarting of each node, if a restart is necessary. -If the restart does not complete within this time, then the Updating Run on that node will be marked as failed. -The cmdlet runs without displaying confirmation prompts. - -### EXAMPLE 2 -``` -PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -DaysOfWeek Tuesday -WeeksInterval 2 -RebootTimeoutMinutes 10 -PostUpdateScript c:\verifyupdatesinstalled.ps1 -Force -Name Value ----- ----- -ResourceGroupName CAUCAUCldy8 -Status Online -StartDate 10/14/2011 3:00:00 AM -PostUpdateScript G:\verifyupdatesinstalled.ps1 -RebootTimeoutMinutes 10 -DaysOfWeek Tuesday -WeeksInterval 2 -``` - -This example configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. -The CAU clustered role is configured to perform Updating Runs on Tuesdays on the second week of each month. -The CAU clustered role will allow 10 minutes for the restarting of each node, if a restart is necessary. -If the restart does not complete within this time, then the Updating Run on that node will be marked as failed. -The CAU clustered role runs a script after updating completes, just after the node leaves Maintenance mode. -The script is located at the root of drive G: in clustered storage and is called verifyupdatesinstalled.ps1. -The cmdlet runs without displaying confirmation prompts. - -### EXAMPLE 3 -``` -PS C:\> Set-CauClusterRole -ClusterName CONTOSO-FC1 -UpdateNow -Force -``` - -This example causes the CAU clustered role to initiate an Updating Run immediately on the cluster named CONTOSO-FC1. -The cmdlet runs without displaying confirmation prompts. - -### EXAMPLE 4 -``` -PS C:\> $warnafter = New-TimeSpan -hour 1 -minute 90 -seconds 10 -$stopafter = New-TimeSpan -hour 2 -minute 90 -seconds 10 -Set-CauClusterRole -ClusterName CONTOSO-FC1 -WarnAfter $warnafter -StopAfter $stopafter -StartDate 1/1/2012 -Force -``` - -This example configures settings for the CAU clustered role on the cluster named CONTOSO-FC1. -Time spans are specified for logging a warning or canceling the Updating Run if it is not completed. -The earliest date that an updating run can be triggered is 1/1/2012. -The cmdlet runs without displaying confirmation prompts. - -## PARAMETERS - -### -CauPluginArguments -Passes a set of name=value pairs (arguments) for each updating plug-in to use. -For example, to specify a Domain argument for one plug-in: - - - `@{Domain=Domain.local}` - -You can specify multiple pairs in a set separated with semicolons. -For example: - - - `@{name1=value1;name2=value2;name3=value3}` - -These name=value pairs must be meaningful to the **CauPluginName** that you specify. - -If you specify arguments for more than one plug-in, provide the sets of name=value pairs in the order that you pass values in **CauPluginName**, separated by commas. -For example: - - - `@{name1=value1;name2=value2;name3=value3},@{name4=value4;name5=value5}` - - -For the default **Microsoft.WindowsUpdatePlugin** plug-in, no arguments are needed. -The following arguments are optional: - - - **'IncludeRecommendedUpdates'='\'**: Boolean value to indicate that recommended updates will be applied in addition to important updates on each node. -If not specified, the default value is **'False'**. - - - A standard Windows Update Agent query string that specifies criteria used by the Windows Update Agent to filter the updates that will be applied to each node. -For a name, use **QueryString** and for a value, enclose the full query in quotation marks. - -If not specified, then the **Microsoft.WindowsUpdatePlugin** plug-in by default uses the following argument: - - - `QueryString="IsInstalled=0 and Type='Software' and IsHidden=0 and IsAssigned=1" and IsAssigned=1` - -For more information about query strings for the default **Microsoft.WindowsUpdatePlugin** plug-in and the criteria such as IsInstalled that can be included in the query strings, see the topic about search criteria in the Windows Update Agent (WUA) API Referencehttp://go.microsoft.com/fwlink/p/?LinkId=223304. - - -For the **Microsoft.HotfixPlugin** plug-in, the following argument is required: - - - **HotfixRootFolderPath=\**: The UNC path to a hotfix root folder in an SMB share with a structure that contains the updates to apply and that contains the hotfix configuration file - - -The following arguments are optional for the **Microsoft.HotfixPlugin** plug-in: - - - **RequireSmbEncryption=\**: Boolean value to indicate that SMB Encryption will be enforced for accessing data from the SMB share. -If not specified, the default value is **'False'**. -To ensure the integrity of the data accessed from the SMB share, the plug-in requires that the share is enabled for either SMB signing or SMB Encryption. - - - **DisableAclChecks=\**: Boolean value to indicate that the plug-in will check for sufficient permissions on the hotfix root folder and the hotfix configuration file. -If not specified, the default value is **'False'**. - - - **HotfixInstallerTimeoutMinutes=\**: The length of time in minutes that the plug-in allows the hotfix installer process to return. -If not specified, the default value is 30 minutes. - - - - **HotfixConfigFileName=\**: Name for the hotfix configuration file. -If not specified, the default name DefaultHotfixConfig.xml is used. -For more information about required and optional arguments for the **Microsoft.HotfixPlugin** plug-in, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: Hashtable[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CauPluginName -Specifies one or more plug-ins to use when performing scans or updates. -You can specify multiple values separated with commas. -The default is the Microsoft.WindowsUpdatePlugin plug-in. -This plug-in coordinates the Windows Update Agent software resident on each cluster node, the same software that is used when updates are downloaded from Windows Update or Microsoft Update, or from a Windows Server Update Services (WSUS) server. -For more information about how plug-ins work with CAU, see the content about Cluster-Aware Updating plug-inshttp://go.microsoft.com/fwlink/p/?LinkId=235333. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterName -Specifies the name of the cluster on which to configure the CAU clustered role. -If not specified, then the current cluster is used. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConfigurationName -Specifies the Windows PowerShell session configuration that defines the session in which scripts (specified by **PreUpdateScript** and **PostUpdateScript**) and cmdlets are run, and can limit the cmdlets that are available to be run. -If either a pre-update or post-update script is specified but a configuration name is not specified, then the default session configuration that is built into Windows PowerShell ("Microsoft.PowerShell") is used. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DaysOfWeek -Specifies the days of the week on which the task will be triggered. -Multiple values can be specified either separated with commas or as a hexadecimal sum. - - - **Sunday:** (0x01) - - - **Monday:** (0x02) - - - **Tuesday:** (0x04) - - - **Wednesday:** (0x08) - - - **Thursday:** (0x10) - - - **Friday:** (0x20) - - - **Saturday:** (0x40) -**Examples:** - - - **-DaysOfWeek:** Monday, Wednesday, Friday - - - **-DaysOfWeek:** 0x02, 0x08, 0x20 - - - **-DaysOfWeek:** 0x2A - -```yaml -Type: Weekdays -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableFirewallRules -Enables the **Remote Shutdown** Windows Firewall rule group on each cluster node, if it is not already enabled, each time the CAU clustered role performs an Updating Run. -Enabling this rule group permits inbound communication to each cluster node during each Updating Run that allows CAU to shut down and restart the node remotely (if the installation of an update requires a restart). -If Windows Firewall is in use on the cluster nodes and the rule group is not enabled, the Updating Run will fail. -The **Remote Shutdown** Windows Firewall rule group is not enabled when it will conflict with Group Policy settings that are configured for Windows Firewall. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IntervalWeeks -Specifies the interval between weeks when the task will be triggered. -An interval of `1` produces a weekly schedule. -An interval of `2` produces an every-other week schedule. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxFailedNodes -Specifies the maximum number of nodes on which updating can fail. -If one more than this number of nodes fails, then the Updating Run is stopped. -The range is from zero (`0`) through 1 less than the number of cluster nodes. -The default for most clusters is approximately one-third of the number of nodes. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxRetriesPerNode -Specifies the maximum number of times that the update process (including any pre-update and post-update scripts) will be retried per node. -The maximum is `64` and the default is `3`. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeOrder -Specifies the names of the cluster nodes in the order that they should be updated. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PostUpdateScript -Specifies the path and file name for a Windows PowerShell script to run after updating completes, just after the node leaves **Maintenance** mode. -The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. -As a best practice, the script should be located on a disk in cluster storage, to ensure that it is always accessible to all of the cluster nodes. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreUpdateScript -Specifies the path and file name for a Windows PowerShell script to run on each node before updating begins, and before the node is put into **Maintenance** mode. -The file name extension must be `.ps1` and the total length of the path plus the file name must be no longer than 260 characters. -As a best practice, the script should be located on a disk in cluster storage, to ensure that it is always accessible to all of the cluster nodes. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RebootTimeoutMinutes -Specifies the time in minutes that CAU will allow for the restarting of a node (if a restart is necessary). -If the restart does not complete within this time, then the Updating Run on that node will be marked as failed. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: 15 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RequireAllNodesOnline -Specifies that all cluster nodes must be online and reachable before updating begins. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunPluginsSerially -When multiple plug-ins are used during an Updating Run, specifies that CAU will scan each cluster node for applicable updates and stage the updates for each plug-in in the plug-in order passed in **CauPluginName**. -By default, CAU scans and stages the applicable updates for all plug-ins in parallel. -Regardless of the configuration of this parameter, CAU installs the applicable updates for each plug-in sequentially. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SeparateReboots -When multiple plug-ins are used during an Updating Run, specifies that CAU will shut down and restart a cluster node after each plug-in installs updates on the node, if the installation of an update by a plug-in requires a restart. -By default, during an Updating Run, all plug-ins complete the installation of updates on a cluster node before the node restarts one time (if a restart is necessary). -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartDate -Specifies the earliest date on which the Updating Run can be triggered. - -```yaml -Type: DateTime -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopAfter -Specifies the time in minutes after which the Updating Run will be canceled if it has not completed. -The time span can be expressed in the standard ways available in Windows PowerShell, for example, `01:30:00` represents one hour and thirty minutes. -By default, the Updating Run is allowed an unlimited amount of time to complete. -**Note:** If pre-update or post-update scripts are specified, then the entire process of running scripts and performing updates must be complete within this time limit. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopOnPluginFailure -When multiple plug-ins are used during an Updating Run, specifies that if a failure occurs during the application of updates on a node by any plug-in, subsequent updates on the node that are coordinated by the remaining plug-ins are stopped. -By default, a failure by one plug-in does not affect the application of updates on a node by other plug-ins. -**Note:** The parameter is valid only when multiple plug-ins are specified in **CauPluginName**. -If a single plug-in is specified, a warning appears. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WarnAfter -Specifies the time in minutes after which a warning will be logged if the Updating Run (including any pre-update and post-update scripts) has not completed. -By default, no warning will be logged, regardless of the time taken by the Updating Run. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateNow -Instructs the CAU clustered role to immediately initiate an Updating Run using the configured settings. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDefault -Specifies that default values will be used for all parameters that do not have specified values. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WeeksOfMonth -Specifies the weeks of the month when the Updating Run should be run. -The value `5` represents the last week of the month. - -```yaml -Type: Int32[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-CauClusterRole](./Add-CauClusterRole.md) - -[Disable-CauClusterRole](./Disable-CauClusterRole.md) - -[Enable-CauClusterRole](./Enable-CauClusterRole.md) - -[Get-CauClusterRole](./Get-CauClusterRole.md) - -[Remove-CauClusterRole](./Remove-CauClusterRole.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Stop-CauRun.md b/docset/winserver2012-ps/clusterawareupdating/Stop-CauRun.md deleted file mode 100644 index 62c44261bb..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Stop-CauRun.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/stop-caurun?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-CauRun - -## SYNOPSIS -Stops an Updating Run that is in progress on a cluster. - -## SYNTAX - -``` -Stop-CauRun [[-ClusterName] ] [-Credential ] [-Force] [-Wait] -``` - -## DESCRIPTION -The **Stop-CauRun** cmdlet stops an Updating Run that is in progress on a failover cluster. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Stop-CauRun -ClusterName CONTOSO-FC1 -Wait -Force -``` - -This example stops the Updating Run that is being performed by the CAU Update Coordinator that is configured on the cluster named CONTOSO-FC1. -The cmdlet waits to return until the canceled Updating Run has completely finished. -The cmdlet runs without displaying confirmation prompts. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster on which to stop an Updating Run that is in progress. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Returns after the canceled Updating Run has completely finished. -Otherwise, returns as soon as the stop request has been acknowledged by the current CAU Update Coordinator. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Get-CauRun](./Get-CauRun.md) - -[Invoke-CauRun](./Invoke-CauRun.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Test-CauSetup.md b/docset/winserver2012-ps/clusterawareupdating/Test-CauSetup.md deleted file mode 100644 index e444cdfe1c..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Test-CauSetup.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/test-causetup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-CauSetup - -## SYNOPSIS -Tests whether a cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU). - -## SYNTAX - -``` -Test-CauSetup [[-ClusterName] ] [[-Credential] ] -``` - -## DESCRIPTION -The **Test-CauSetup** cmdlet tests whether a failover cluster is properly set up to apply software updates using Cluster-Aware Updating (CAU). -The cmdlet performs a Best Practices Analyzer (BPA) scan of the failover cluster and network environment by invoking the ClusterAwareUpdating BPA model that is installed with CAU. -To view the results of a BPA scan that is performed by **Test-CauSetup**, including possible problems and resolution steps, run the **Get-BpaResult** cmdlet. - -Note: You must run **Test-CauSetup** with local administrative credentials. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Test-CauSetup -ClusterName CONTOSO-FC1 -Test-CauSetup completed successfully. To view the results, run the "Get-BpaResult Microsoft/Windows/ClusterAwareUpdating" Windows PowerShell cmdlet. -``` - -This example tests whether failover cluster CONTOSO-FC1 is properly set up for CAU. - -## PARAMETERS - -### -ClusterName -Specifies the name of the cluster on which to test for proper setup. -This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Credential -Specifies the administrative credentials for the target cluster. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauBpaProgress - -## NOTES - -## RELATED LINKS - -[Invoke-BpaModel](../bestpractices/Invoke-BpaModel.md) - -[Get-BpaResult](../bestpractices/Get-BpaResult.md) - diff --git a/docset/winserver2012-ps/clusterawareupdating/Unregister-CauPlugin.md b/docset/winserver2012-ps/clusterawareupdating/Unregister-CauPlugin.md deleted file mode 100644 index 1ab683d13a..0000000000 --- a/docset/winserver2012-ps/clusterawareupdating/Unregister-CauPlugin.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -external help file: ClusterAware_Cmdlets.xml -Module Name: ClusterAwareUpdating -online version: https://learn.microsoft.com/powershell/module/clusterawareupdating/unregister-cauplugin?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Unregister-CauPlugin - -## SYNOPSIS -Removes a software updating plug-in from the list of plug-ins that are used by Cluster-Aware Updating (CAU). - -## SYNTAX - -``` -Unregister-CauPlugin [-Name] -``` - -## DESCRIPTION -The **Unregister-CauPlugin** cmdlet removes a software updating plug-in from the list of plug-ins that are used by Cluster-Aware Updating (CAU). -The plug-in can be removed, but afterwards, it cannot be used for Updating Runs. -The Microsoft.WindowsUpdatePlugin and Microsoft.HotfixPlugin plug-ins, which are installed with CAU, cannot be unregistered. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Unregister-CauPlugin -Name Plugin01 -``` - -This example removes the plug-in named Plugin01 from the list of plug-ins that are used by Cluster-Aware Updating (CAU). - -## PARAMETERS - -### -Name -Specifies the name of the plug-in to unregister. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.ClusterAwareUpdating.CauPlugin - -## NOTES - -## RELATED LINKS - -[Get-CauPlugin](./Get-CauPlugin.md) - -[Register-CauPlugin](./Register-CauPlugin.md) - diff --git a/docset/winserver2012-ps/dcbqos/DcbQoS.md b/docset/winserver2012-ps/dcbqos/DcbQoS.md deleted file mode 100644 index f2fb53dea4..0000000000 --- a/docset/winserver2012-ps/dcbqos/DcbQoS.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: b57d41f8-8b6b-4012-912f-b08109101281 -Module Name: DcbQoS ---- - -# DcbQoS Module -## Description -This reference provides cmdlet descriptions and syntax for all Data Center Bridging (DCB) Quality of Service (QoS)-specific cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## DcbQoS Cmdlets -### [Disable-NetQosFlowControl](./Disable-NetQosFlowControl.md) -Disables link level flow control based on the IEEE 802.1p priority. - -### [Enable-NetQosFlowControl](./Enable-NetQosFlowControl.md) -Enables link level flow control based on the IEEE 802.1p priority. - -### [Get-NetQosDcbxSetting](./Get-NetQosDcbxSetting.md) -Gets the data center bridging exchange (DCBX) settings. - -### [Get-NetQosFlowControl](./Get-NetQosFlowControl.md) -Gets the priority-based flow control (PFC) settings. - -### [Get-NetQosTrafficClass](./Get-NetQosTrafficClass.md) -Gets the traffic class settings. - -### [New-NetQosTrafficClass](./New-NetQosTrafficClass.md) -Creates a new traffic class. - -### [Remove-NetQosTrafficClass](./Remove-NetQosTrafficClass.md) -Removes a traffic class. - -### [Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) -Sets the data center bridging exchange (DCBX) settings. - -### [Set-NetQosFlowControl](./Set-NetQosFlowControl.md) -Sets the flow control settings. - -### [Set-NetQosTrafficClass](./Set-NetQosTrafficClass.md) -Sets the traffic class settings. - diff --git a/docset/winserver2012-ps/dcbqos/Disable-NetQosFlowControl.md b/docset/winserver2012-ps/dcbqos/Disable-NetQosFlowControl.md deleted file mode 100644 index 77a4e31f9c..0000000000 --- a/docset/winserver2012-ps/dcbqos/Disable-NetQosFlowControl.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/disable-netqosflowcontrol?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetQosFlowControl - -## SYNOPSIS -Disables link level flow control based on the IEEE 802.1p priority. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetQosFlowControl [[-Priority] ] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetQosFlowControl [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetQosFlowControl** cmdlet disables priority-based flow control (PFC) in Windows Server® 2012 and later. -PFC is part of the IEEE data center bridging (DCB) standard. -If Windows Server 2012 or later is configured to be not willing to accept configurations from a remote device, Windows Server 2012 or later will program DCB capable network adapters, which will disable PFC at the link level. - -For more information on remote device configurations, see the Set-NetQosDcbxSetting cmdlet. - -For more information on PFC, see the Enable-NetQosFlowControl cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Disable-NetQosFlowControl -Priority 6 -``` - -This example disables flow control on traffic tagged with priority 6. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the IEEE 802.1p priority value. - -```yaml -Type: Byte[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains the flow control setting per priority. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains flow control settings per priority. -Only when the **PassThru** parameter is specified will this cmdlet return the MSFT_NetQosFlowControlSettingData object. - -## NOTES - -## RELATED LINKS - -[Enable-NetQosFlowControl](./Enable-NetQosFlowControl.md) - -[Get-NetQosFlowControl](./Get-NetQosFlowControl.md) - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - -[Set-NetQosFlowControl](./Set-NetQosFlowControl.md) - diff --git a/docset/winserver2012-ps/dcbqos/Enable-NetQosFlowControl.md b/docset/winserver2012-ps/dcbqos/Enable-NetQosFlowControl.md deleted file mode 100644 index ee5ec95759..0000000000 --- a/docset/winserver2012-ps/dcbqos/Enable-NetQosFlowControl.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/enable-netqosflowcontrol?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetQosFlowControl - -## SYNOPSIS -Enables link level flow control based on the IEEE 802.1p priority. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetQosFlowControl [[-Priority] ] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetQosFlowControl [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetQosFlowControl** cmdlet enables priority-based flow control (PFC) in Windows Server® 2012 and later. -PFC is part of the IEEE data center bridging (DCB) standard. -If Windows Server 2012 or later is configured to be not willing to accept configurations from a remote device, Windows Server 2012 or later will program DCB capable NICs, which will enable PFC at the link level. - -For more information on remote device configurations, see the Set-NetQosDcbxSetting cmdlet. - -Enabling flow control on both ends of a link reduces the chance of packet loss due to link congestion. -Some upper layer protocol even assumes a lossless underlying protocol. -In such case, it is essential to enable flow control. -PFC makes it possible to enable flow control just for one type of traffic, denoted by the IEEE 802.1p priority. -It is critical to have consistent PFC settings on both ends of the link. -A mis-matched configuration is equivalent to not having flow control at all. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Enable-NetQosFlowControl -Priority 3,6 -``` - -This example enables flow control on traffic tagged with priority 3 and priority 6. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the IEEE 802.1p priority value. - -```yaml -Type: Byte[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains the follow control setting per priority. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains flow control settings per priority. -Only when the **PassThru** parameter is specified will this cmdlet return the MSFT_NetQosFlowControlSettingData object. - -## NOTES - -## RELATED LINKS - -[Disable-NetQosFlowControl](./Disable-NetQosFlowControl.md) - -[Get-NetQosFlowControl](./Get-NetQosFlowControl.md) - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - -[Set-NetQosFlowControl](./Set-NetQosFlowControl.md) - diff --git a/docset/winserver2012-ps/dcbqos/Get-NetQosDcbxSetting.md b/docset/winserver2012-ps/dcbqos/Get-NetQosDcbxSetting.md deleted file mode 100644 index b7d9fdcf26..0000000000 --- a/docset/winserver2012-ps/dcbqos/Get-NetQosDcbxSetting.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/get-netqosdcbxsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetQosDcbxSetting - -## SYNOPSIS -Gets the data center bridging exchange (DCBX) settings. - -## SYNTAX - -``` -Get-NetQosDcbxSetting [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetQosDcbxSetting** cmdlet allows users to get the data center bridging exchange (DCBX) settings. -The only setting that Windows Server® 2012 allows a user to configure is whether the network adapters in the computer running Windows Server 2012 or later should accept data center bridging (DCB) configurations from the computer or from a remote device. - -DCB is the IEEE standard. -DCBX is part of the DCB standard. -Windows Server 2012 and later does not implement DCBX. -Some network adapters may implement DCBX. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetQosDcbxSetting -Willing -------- -True -``` - -This example shows that the computer, such as all DCB capable network adapters, is willing to accept configurations from a remote peer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosDcbxSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosDcbxSettingData output object contains the DCBX setting configured in Windows Server 2012 and later. - -## NOTES - -## RELATED LINKS - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - diff --git a/docset/winserver2012-ps/dcbqos/Get-NetQosFlowControl.md b/docset/winserver2012-ps/dcbqos/Get-NetQosFlowControl.md deleted file mode 100644 index 055b2b3f99..0000000000 --- a/docset/winserver2012-ps/dcbqos/Get-NetQosFlowControl.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/get-netqosflowcontrol?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetQosFlowControl - -## SYNOPSIS -Gets the priority-based flow control (PFC) settings. - -## SYNTAX - -``` -Get-NetQosFlowControl [[-Priority] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetQosFlowControl** cmdlet gets the priority-based flow control (PFC) settings programmed in Windows Server® 2012 and later. - -For more information on PFC, see the Enable-NetQosFlowControl cmdlet. - -PFC is part of the IEEE data center bridging (DCB) standard. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetQosFlowControl -Priority Enabled --------- ------- -0 False -1 False -2 False -3 True -4 False -5 False -6 False -7 False -``` - -This example displays flow control settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the IEEE 802.1p priority value. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains the flow control settings per priority. - -## NOTES - -## RELATED LINKS - -[Enable-NetQosFlowControl](./Enable-NetQosFlowControl.md) - -[Disable-NetQosFlowControl](./Disable-NetQosFlowControl.md) - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - -[Set-NetQosFlowControl](./Set-NetQosFlowControl.md) - diff --git a/docset/winserver2012-ps/dcbqos/Get-NetQosTrafficClass.md b/docset/winserver2012-ps/dcbqos/Get-NetQosTrafficClass.md deleted file mode 100644 index 16f2725bd0..0000000000 --- a/docset/winserver2012-ps/dcbqos/Get-NetQosTrafficClass.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/get-netqostrafficclass?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetQosTrafficClass - -## SYNOPSIS -Gets the traffic class settings. - -## SYNTAX - -``` -Get-NetQosTrafficClass [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetQosTrafficClass** cmdlet retrieves network traffic classes configured in Windows Server® 2012 and later. -A traffic class contains one or more types of traffic, each of which is differentiated by the IEEE 802.1p priority. - -For more information on the traffic class, see the New-NetQosTrafficClass cmdlet. - -This cmdlet only retrieves the traffic classes configured in Windows Server 2012 and later. -The traffic classes are not necessarily configured as-is on a network adapter in the computer. -To see the traffic class configuration on a network adapter, run the Get-NetAdapterQos cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetQosTrafficClass -Name Algorithm Bandwidth(%) Priority ----- --------- ------------ -------- -[Default] ETS 40 0-2,4-7 -SMB ETS 60 3 -``` - -This example displays all of the traffic classes. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the traffic class. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. - -## NOTES - -## RELATED LINKS - -[Get-NetAdapterQos](../netadapter/Get-NetAdapterQos.md) - -[New-NetQosTrafficClass](./New-NetQosTrafficClass.md) - -[Set-NetQosTrafficClass](./Set-NetQosTrafficClass.md) - diff --git a/docset/winserver2012-ps/dcbqos/New-NetQosTrafficClass.md b/docset/winserver2012-ps/dcbqos/New-NetQosTrafficClass.md deleted file mode 100644 index 5bdbd21e82..0000000000 --- a/docset/winserver2012-ps/dcbqos/New-NetQosTrafficClass.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/new-netqostrafficclass?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-NetQosTrafficClass - -## SYNOPSIS -Creates a new traffic class. - -## SYNTAX - -``` -New-NetQosTrafficClass [-Name] [-Algorithm] [-Priority] [-AsJob] - [-BandwidthPercentage ] [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -This **New-NetQosTrafficClass** cmdlet creates a new traffic class. -Traffic class is specified in the enhanced transmission selection (ETS) specification in the IEEE data center bridging (DCB) standard. -In creating a traffic class, the user specifies which types of traffic, differentiated by the IEEE 802.1p priority, are mapped to the traffic class, what transmission algorithm it uses, and how much bandwidth it gets. -If Windows Server® 2012 or later is set to be not willing to accept DCB configurations from a remote device, then Windows Server 2012 or later will program DCB capable network adapters to add this new traffic class. - -For more information on remote device configurations, see the Set-NetQosDcbxSetting cmdlet. - -There is a default traffic class created by Windows Server 2012 or later. -All 8 priorities are mapped to this default traffic class, which selects ETS as its transmission algorithm and has all of the total bandwidth. -Users cannot delete the default traffic class. -Since a traffic class must have at least one type of traffic mapped to it and there are 8 or less types of such traffic, which is limited by IEEE 802.1p, only 7 additional traffic classes can be created. - -In reality, a network adapter that supports DCB may support less than 8 traffic classes. -If there are more traffic classes configured in Windows Server 2012 or later than what a network adapter can support, then Windows Server 2012 or later will not send the configurations to the network adapter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> New-NetQosTrafficClass -Name "SMB" -Priority 3 -Algorithm ETS -BandwidthPercentage 60 -Name Algorithm Bandwidth(%) Priority ----- --------- ------------ -------- -SMB ETS 60 3 -``` - -Create a traffic class for traffic tagged with the 802.1p value of 3. -This traffic class, named as SMB, has 60 percent of the entire bandwidth. - -## PARAMETERS - -### -Algorithm -Specifies the transmission selection algorithm to assign to the traffic class. -The acceptable values for this parameter are: ETS or Strict -ETS refers to IEEE 802.1Qaz Enhanced Transmission Selection. -Strict refers to Strict Priority scheduling. -Both of the algorithms are specified in the IEEE 802.1Q standard. - -```yaml -Type: Algorithm -Parameter Sets: (All) -Aliases: Tsa - -Required: True -Position: 2 -Default value: Ets -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BandwidthPercentage -Specifies the percent of total bandwidth to assign to the traffic class. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: Bandwidth, Bw - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the traffic class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the IEEE 802.1p priority values. -One priority can be mapped to only one traffic class whereas multiple priorities can be mapped to the same traffic class. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. - -## NOTES - -## RELATED LINKS - -[Get-NetQosTrafficClass](./Get-NetQosTrafficClass.md) - -[Set-NetQosTrafficClass](./Set-NetQosTrafficClass.md) - diff --git a/docset/winserver2012-ps/dcbqos/Remove-NetQosTrafficClass.md b/docset/winserver2012-ps/dcbqos/Remove-NetQosTrafficClass.md deleted file mode 100644 index 659784d690..0000000000 --- a/docset/winserver2012-ps/dcbqos/Remove-NetQosTrafficClass.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/remove-netqostrafficclass?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-NetQosTrafficClass - -## SYNOPSIS -Removes a traffic class. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-NetQosTrafficClass [[-Name] ] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-NetQosTrafficClass [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-NetQosTrafficClass** cmdlet removes traffic classes in Windows Server® 2012 and later. -If Windows Server 2012 or later is set to be not willing to accept configurations from a remote device, then Windows Server 2012 or later will program data center bridging (DCB)-capable network adapters to remove the specified traffic classes. - -For more information on remote device configurations, see the Set-NetQosDcbxSetting cmdlet. - -For more information on traffic class, see the New-NetQosTrafficClass cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-NetQosTrafficClass -Name SMB -``` - -This example removes the traffic class named SMB. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the traffic class. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. -Only when the **PassThru** parameter is specified will the cmdlet return the MSFT_NetQosTrafficClassSettingData object. - -## NOTES - -## RELATED LINKS - -[Get-NetQosTrafficClass](./Get-NetQosTrafficClass.md) - -[New-NetQosTrafficClass](./New-NetQosTrafficClass.md) - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - -[Set-NetQosTrafficClass](./Set-NetQosTrafficClass.md) - diff --git a/docset/winserver2012-ps/dcbqos/Set-NetQosDcbxSetting.md b/docset/winserver2012-ps/dcbqos/Set-NetQosDcbxSetting.md deleted file mode 100644 index 1c0d9a3c1b..0000000000 --- a/docset/winserver2012-ps/dcbqos/Set-NetQosDcbxSetting.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/set-netqosdcbxsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetQosDcbxSetting - -## SYNOPSIS -Sets the data center bridging exchange (DCBX) settings. - -## SYNTAX - -``` -Set-NetQosDcbxSetting [-AsJob] [-CimSession ] [-InputObject ] [-PassThru] - [-ThrottleLimit ] -Willing [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetQosDcbxSetting** cmdlet sets the data center bridging exchange (DCBX) settings. -The only setting that Windows Server® 2012 and later allows a user to set is that the network adapters in computers running Windows Server 2012 and later should accept data center bridging (DCB) configurations from Windows Server 2012 and later or from a remote device via the DCBX protocol, which is specified in the IEEE data center bridging (DCB) standard. - -If the **Willing** parameter is set to True, then Windows Server 2012 or later will not send priority-based flow control (PFC) and traffic class settings to DCB-capable network adapters in the computer. -If the **Willing** parameter is set to False, then Windows Server 2012 or later will send the settings to the network adapters. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-NetQosDcbxSetting -Willing $true -``` - -This example enables the DCBX willing state, so that a DCB-capable network adapter is willing to accept configurations from a remote peer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Willing -Specifies that a DCB-capable network adapter should accept the configuration from a remote peer via the DCBX protocol. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosDcbxSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosDcbxSettingData object contains the DCBX setting configured in Windows Server 2012 and later. -Only when the **PassThru** parameter is specified will the command return the MSFT_NetQosDcbxSettingData object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosDcbxSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-NetQosDcbxSetting](./Get-NetQosDcbxSetting.md) - -[Get-NetQosDcbxSetting](./Get-NetQosDcbxSetting.md) - diff --git a/docset/winserver2012-ps/dcbqos/Set-NetQosFlowControl.md b/docset/winserver2012-ps/dcbqos/Set-NetQosFlowControl.md deleted file mode 100644 index 76012fab2c..0000000000 --- a/docset/winserver2012-ps/dcbqos/Set-NetQosFlowControl.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/set-netqosflowcontrol?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetQosFlowControl - -## SYNOPSIS -Sets the flow control settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetQosFlowControl [[-Priority] ] [-AsJob] [-CimSession ] [-Enabled ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetQosFlowControl [-AsJob] [-CimSession ] [-Enabled ] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetQosFlowControl** cmdlet set the enabled state of priority-based flow control (PFC) in Windows Server® 2012 and later. -If Windows Server 2012 or later is set to be not willing to accept configurations from a remote device, Windows Server 2012 or later will send the updated settings to data center bridging (DCB)-capable network adapters in the computer. - -For more information on remote device configurations, see the Set-NetQosDcbxSetting cmdlet. - -Priority-based flow control (PFC) is part of the IEEE data center bridging (DCB) standard. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-NetQosFlowControl -Priority 5 -Enabled $true -``` - -This example enables flow control on traffic tagged with priority 5. -This cmdlet is equivalent to the Enable-NetQosFlowControl with priority 5. - -### EXAMPLE 2 -``` -PS C:\> Get-NetQosFlowControl -Priority 5 | Set-NetQosFlowControl -Enabled $false -``` - -This example gets the flow control settings for traffic tagged with priority 5 and disables the flow control settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Sets the enabled state for flow control based on priority values. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the IEEE 802.1p priority value. - -```yaml -Type: Byte[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains the flow control setting per priority. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosFlowControlSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosFlowControlSettingData object contains flow control settings per priority. -Only when the **PassThru** parameter is specified will this cmdlet return the MSFT_NetQosFlowControlSettingData object. - -## NOTES - -## RELATED LINKS - -[Disable-NetQosFlowControl](./Disable-NetQosFlowControl.md) - -[Enable-NetQosFlowControl](./Enable-NetQosFlowControl.md) - -[Get-NetQosFlowControl](./Get-NetQosFlowControl.md) - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - diff --git a/docset/winserver2012-ps/dcbqos/Set-NetQosTrafficClass.md b/docset/winserver2012-ps/dcbqos/Set-NetQosTrafficClass.md deleted file mode 100644 index 59b1c1eab1..0000000000 --- a/docset/winserver2012-ps/dcbqos/Set-NetQosTrafficClass.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: DcbQos_Cmdlets.xml -Module Name: DcbQoS -online version: https://learn.microsoft.com/powershell/module/dcbqos/set-netqostrafficclass?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetQosTrafficClass - -## SYNOPSIS -Sets the traffic class settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetQosTrafficClass [[-Name] ] [-Algorithm ] [-AsJob] [-BandwidthPercentage ] - [-CimSession ] [-PassThru] [-Priority ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetQosTrafficClass [-Algorithm ] [-AsJob] [-BandwidthPercentage ] - [-CimSession ] [-PassThru] [-Priority ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetQosTrafficClass** cmdlet modifies the settings of a traffic class, such as the mapping between 802.1p priority and traffic class, the transmission algorithm to be used, and the bandwidth allocation to the traffic class. -If Windows Server® 2012 or later is set to be not willing to accept configurations from a remote device, then Windows Server 2012 or later will send the updated settings to data center bridging (DCB)-capable network adapters in the computer. - -For more information on remote device configurations, see the Set-NetQosDcbxSetting cmdlet. - -For more information on traffic class, see the New-NetQosTrafficClass cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-NetQosTrafficClass -Name SMB -BandwidthPercentage 50 -``` - -This example changes the bandwidth allocation to traffic class named SMB to 50 percent. - -### EXAMPLE 2 -``` -PS C:\> Get-NetQosTrafficClass -Name SMB | Set-NetQosTrafficClass -Priority 3,4 -``` - -This example gets the settings of the traffic class named SMB and changes the priority mapping setting so that traffic tagged with 3 or 4 are mapped to the traffic class named SMB. - -## PARAMETERS - -### -Algorithm -Specifies the transmission selection algorithm to assign to the traffic class, such as enhanced transmission selection (ETS). - -```yaml -Type: Algorithm -Parameter Sets: (All) -Aliases: Tsa - -Required: False -Position: Named -Default value: Ets -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BandwidthPercentage -Specifies the percent of total bandwidth to assign to the traffic class. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the traffic class. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the IEEE 802.1p priority values. - -```yaml -Type: Byte[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosTrafficClassSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosTrafficClassSettingData object contains a network traffic class. -Only when the **PassThru** parameter is specified will the cmdlet return the MSFT_NetQosTrafficClassSettingData object. - -## NOTES - -## RELATED LINKS - -[Get-NetQosTrafficClass](./Get-NetQosTrafficClass.md) - -[New-NetQosTrafficClass](./New-NetQosTrafficClass.md) - -[Remove-NetQosTrafficClass](./Remove-NetQosTrafficClass.md) - -[Set-NetQosDcbxSetting](./Set-NetQosDcbxSetting.md) - -[Set-NetQosTrafficClass](./Set-NetQosTrafficClass.md) - diff --git a/docset/winserver2012-ps/deduplication/Deduplication.md b/docset/winserver2012-ps/deduplication/Deduplication.md deleted file mode 100644 index d3035bd2c8..0000000000 --- a/docset/winserver2012-ps/deduplication/Deduplication.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 1395eca7-7eaf-4958-a114-fb8ab76b86cc -Module Name: Deduplication ---- - -# Deduplication Module -## Description -This reference provides cmdlet descriptions and syntax for all Windows Server Data Deduplication-specific cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## Deduplication Cmdlets -### [Disable-DedupVolume](./Disable-DedupVolume.md) -Disables data deduplication activity on one or more volumes. - -### [Enable-DedupVolume](./Enable-DedupVolume.md) -Enables data deduplication on one or more volumes. - -### [Get-DedupJob](./Get-DedupJob.md) -Returns status and information for currently running or queued deduplication jobs. - -### [Get-DedupMetadata](./Get-DedupMetadata.md) -Returns a DeduplicationMetadata object for every volume that has data deduplication metadata. - -### [Get-DedupSchedule](./Get-DedupSchedule.md) -Returns the DeduplicationJobSchedule objects defined on the system. - -### [Get-DedupStatus](./Get-DedupStatus.md) -Returns a Deduplication status object for every volume that has data deduplication metadata. - -### [Get-DedupVolume](./Get-DedupVolume.md) -Returns a DeduplicationVolume object for each volume that has data deduplication metadata. - -### [Measure-DedupFileMetadata](./Measure-DedupFileMetadata.md) -Measures deduplication metadata for files in a set of folders on the same volume. - -### [New-DedupSchedule](./New-DedupSchedule.md) -Creates a data deduplication schedule. - -### [Remove-DedupSchedule](./Remove-DedupSchedule.md) -Deletes the specified DeduplicationSchedule object. - -### [Set-DedupSchedule](./Set-DedupSchedule.md) -Changes configuration settings for data deduplication schedules. - -### [Set-DedupVolume](./Set-DedupVolume.md) -Changes data deduplication settings on one or more volumes. - -### [Start-DedupJob](./Start-DedupJob.md) -Starts a data deduplication job. - -### [Stop-DedupJob](./Stop-DedupJob.md) -Cancels one or more specified data deduplication jobs. - -### [Update-DedupStatus](./Update-DedupStatus.md) -Scans one or more specified volumes to compute fresh data deduplication savings information and returns a DeduplicationStatus object. - diff --git a/docset/winserver2012-ps/deduplication/Disable-DedupVolume.md b/docset/winserver2012-ps/deduplication/Disable-DedupVolume.md deleted file mode 100644 index 87e8a78f27..0000000000 --- a/docset/winserver2012-ps/deduplication/Disable-DedupVolume.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/disable-dedupvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-DedupVolume - -## SYNOPSIS -Disables data deduplication activity on one or more volumes. - -## SYNTAX - -``` -Disable-DedupVolume [-Volume] [-DataAccess] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] -``` - -## DESCRIPTION -The **Disable-DedupVolume** cmdlet disables further data deduplication activity on one or more volumes. -After you disable data deduplication, the volume remains in a deduplicated state and the existing deduplicated data is accessible. -The server stops running data deduplication jobs for the volume and new data is not deduplicated. -To undo data deduplication on a volume, use the **Start-DedupJob** cmdlet and specify Unoptimization for the *Type* parameter. - -After you disable data deduplication on a volume, you can perform all read-only deduplication cmdlet operations on the volume. -For example, you can use the **Get-DedupStatus** cmdlet to get deduplication status for a volume that has data deduplication metadata. -After you disable data deduplication on a volume, you cannot use the data deduplication job-related cmdlets and the **Update-DedupStatus** cmdlet to perform operations on the volume. -For example, you cannot use **Start-DedupJob** to start a data deduplication job for a volume on which you have disabled data deduplication. - -## EXAMPLES - -### Example 1: Disable data deduplication on volumes -``` -PS C:\> Disable-DedupVolume -Volume "D:","E:","F:","G:" -``` - -This command disables data deduplication for volumes D:, E:, F:, and G:. - -### Example 2: Disable data deduplication on a volume by using a GUID -``` -PS C:\>Disable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" -``` - -This command disables data deduplication for the volume that has the GUID 26a21bda-a627-11d7-9931-806e6f6e6963. - -### Example 3: Suspend I/O activity for a specified volume -``` -PS C:\> Disable-DedupVolume -Volume "X:" -DataAccess -``` - -This command suspends I/O activity for data deduplication on the specified volume. -Effectively, this command causes the data deduplication file system mini-filter to detach from the specified volume. -After this command completes, I/O to data deduplication files fails with an ERROR_INVALID_FUNCTION error until either the `Enable-DedupVolume -DataAccess` command runs, or the server restarts. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataAccess -Indicates that data access to deduplicated files on the volume is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies an array of system volumes for which to disable data deduplication. -Specify one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name,DeviceId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-DedupVolume](./Enable-DedupVolume.md) - -[Get-DedupVolume](./Get-DedupVolume.md) - -[Set-DedupVolume](./Set-DedupVolume.md) - -[Update-DedupStatus](./Update-DedupStatus.md) diff --git a/docset/winserver2012-ps/deduplication/Enable-DedupVolume.md b/docset/winserver2012-ps/deduplication/Enable-DedupVolume.md deleted file mode 100644 index d940bd9050..0000000000 --- a/docset/winserver2012-ps/deduplication/Enable-DedupVolume.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/enable-dedupvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-DedupVolume - -## SYNOPSIS -Enables data deduplication on one or more volumes. - -## SYNTAX - -``` -Enable-DedupVolume [-Volume] [-AsJob] [-CimSession ] [-DataAccess] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Enable-DedupVolume** cmdlet enables data deduplication on one or more volumes . -You can use the Set-DedupVolume cmdlet to customize the data deduplication settings. -Data deduplication is disabled by default. -Data deduplication is not supported for certain volumes, such as any volume that is not a NTFS file system or any volume that is smaller than 2 GB. - -## EXAMPLES - -### Example 1: Enable data deduplication on volumes -``` -PS C:\>Enable-DedupVolume -Volume D:,E:,F: -``` - -This command enables data deduplication on volumes D:, E:, and F:. - -### Example 2: Enable data deduplication on a volume by using a GUID -``` -PS C:\>Enable-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" -``` - -This command enables data deduplication for the volume that has the GUID 26a21bda-a627-11d7-9931-806e6f6e6963. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataAccess -Indicates that data access to deduplicated files on the volume is enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies an array of system volumes. -Specify one or more volume IDs, drive letters (such as D:), or volume GUID pathnames (using the form \\\\?\Volume{{GUID}}\\). -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name,DeviceId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-DedupVolume](./Disable-DedupVolume.md) - -[Get-DedupVolume](./Get-DedupVolume.md) - -[Set-DedupVolume](./Set-DedupVolume.md) diff --git a/docset/winserver2012-ps/deduplication/Get-DedupJob.md b/docset/winserver2012-ps/deduplication/Get-DedupJob.md deleted file mode 100644 index 9d82197349..0000000000 --- a/docset/winserver2012-ps/deduplication/Get-DedupJob.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/get-dedupjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DedupJob - -## SYNOPSIS -Returns status and information for currently running or queued deduplication jobs. - -## SYNTAX - -``` -Get-DedupJob [[-Type] ] [[-Volume] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DedupJob** returns status and information for currently running or queued deduplication jobs. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the names the type of data deduplication jobs for which to return the job state. -The acceptable values for this parameter are: Optimization, GarbageCollection, Scrubbing, Unoptimization. - -```yaml -Type: Type[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Volume -Specifies one or more file system volumes for which to return DeduplicationJob objects. -Enter one or more volume IDs, drive letters (such as `D:`), or volume GUID pathnames (using the form `\\\\?\Volume{{GUID}}\\`). -Separate multiple volumes with a comma. - -Returns a DeduplicationJob object for every currently active data deduplication job regardless of current job state. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Type[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Start-DedupJob](./Start-DedupJob.md) - -[Stop-DedupJob](./Stop-DedupJob.md) diff --git a/docset/winserver2012-ps/deduplication/Get-DedupMetadata.md b/docset/winserver2012-ps/deduplication/Get-DedupMetadata.md deleted file mode 100644 index 40702f33b3..0000000000 --- a/docset/winserver2012-ps/deduplication/Get-DedupMetadata.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/get-dedupmetadata?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DedupMetadata - -## SYNOPSIS -Returns a DeduplicationMetadata object for every volume that has data deduplication metadata. - -## SYNTAX - -``` -Get-DedupMetadata [[-Volume] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DedupMetadata** cmdlet returns a DeduplicationMetadata object for every volume that has optimization metadata. -A DeduplicationMetadata object includes read-only properties describing the nature of the deduplication data store such as chunk counts, container counts, average chunk size, and other statistics. - -This cmdlet can some time to run since the entire file system must be scanned. - -This cmdlet cannot be part of a schedule; it must be run manually. -If another optimization job is running on the specified volume when you kick of this cmdlet, then this cmdlet will fail. -It will also fail if there is not enough memory for the file system scan and cmdlet processing. -If this happens, then review the events and log files for more information. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -This cmdlet returns the following: - - - - DataChunkCount: Indicates the number of data chunks in a container. - - - - DataContainerCount: Indicates the number of containers in the data store. - - - - DataChunkAverageSize: Indicates the data store size (not including chunk metadata) divided by the total number of data chunks in the data store. - - - - StreamMapCount: Indicates the number of data streams in a container. - - - - StreamMapContainerCount: Indicates the number of containers in the stream map store. - - - - StreamMapAverageChunkCount: Indicates the stream map store size divided by the total number of streams in the store. - - - - HotspotCount: Indicates the number of hotspots in a container. - - - - HotspotContainerCount: Indicates the number of hotspots in the stream map store. - - - - CorruptionCount: Indicates the number of corruptions found on the volume. - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies one or more file system volumes for which to return a DeduplicationVolumeMetadata object. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name,DeviceId - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeMetadata -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/deduplication/Get-DedupSchedule.md b/docset/winserver2012-ps/deduplication/Get-DedupSchedule.md deleted file mode 100644 index e82aa72b48..0000000000 --- a/docset/winserver2012-ps/deduplication/Get-DedupSchedule.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/get-dedupschedule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DedupSchedule - -## SYNOPSIS -Returns the DeduplicationJobSchedule objects defined on the system. - -## SYNTAX - -``` -Get-DedupSchedule [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Type ] -``` - -## DESCRIPTION -The **Get-DedupSchedule** cmdlet returns the DeduplicationJobSchedule objects defined on the system. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-DedupSchedule -``` - -This example returns the currently active DataDeduplicationSchedule objects created using the New-DedupSchedule cmdlet. - -### Example 2 -``` -PS C:\>Get-DedupSchedule -Type Optimization -``` - -This example returns all data deduplication schedules for optimization jobs - -### EXAMPLE 3 -``` -PS C:\>Get-DedupSchedule -Name MySchedule -``` - -This example returns the data deduplication schedule named MySchedule. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of one or more data deduplication job schedules for which to return DeduplicationJobSchedule objects. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the names of one or more types of data deduplication job schedules for which to return DeduplicationJobSchedule objects. -The acceptable values for this parameter are: Optimization, GarbageCollection, Scrubbing, and Unoptimization. - -```yaml -Type: Type[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupSchedule.Type[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[New-DedupSchedule](./New-DedupSchedule.md) - -[Remove-DedupSchedule](./Remove-DedupSchedule.md) - -[Set-DedupSchedule](./Set-DedupSchedule.md) diff --git a/docset/winserver2012-ps/deduplication/Get-DedupStatus.md b/docset/winserver2012-ps/deduplication/Get-DedupStatus.md deleted file mode 100644 index 2d2ef2b1e9..0000000000 --- a/docset/winserver2012-ps/deduplication/Get-DedupStatus.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/get-dedupstatus?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DedupStatus - -## SYNOPSIS -Returns a Deduplication status object for every volume that has data deduplication metadata. - -## SYNTAX - -``` -Get-DedupStatus [[-Volume] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DedupStatus** cmdlet returns a Deduplication status object for every volume that has data deduplication metadata. -A DeduplicationStatus object includes read-only properties that describe capacity, free or used space and optimization savings and status on the volume, times, and completion status for the last jobs on the volume. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies one or more file system volumes for which to return a DeduplicationStatus object. -Enter one or more volume IDs, drive letters (such as `D:`), or volume GUID pathnames (using the form `\\\\?\Volume{{GUID}}\\`). -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name,DeviceId - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolumeStatus -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Update-DedupStatus](./Update-DedupStatus.md) diff --git a/docset/winserver2012-ps/deduplication/Get-DedupVolume.md b/docset/winserver2012-ps/deduplication/Get-DedupVolume.md deleted file mode 100644 index 5c79b3ac3f..0000000000 --- a/docset/winserver2012-ps/deduplication/Get-DedupVolume.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/get-dedupvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DedupVolume - -## SYNOPSIS -Returns a DeduplicationVolume object for each volume that has data deduplication metadata. - -## SYNTAX - -### ByVolumeId (Default) -``` -Get-DedupVolume [-AsJob] [-CimSession ] [-ThrottleLimit ] [-VolumeId ] -``` - -### ByVolume -``` -Get-DedupVolume [[-Volume] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DedupVolume** cmdlet returns a DeduplicationVolume object for each volume that has data deduplication metadata (in either the enabled or disabled state). -In a cluster, this cmdlet returns a DeduplicationVolume object only for volumes currently mounted by the managed node (whether the volumes are local or clustered volumes). - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-DedupVolume -Volume E: -``` - -This example returns the data deduplication settings for volume E. - -### Example 2 -``` -PS C:\>Get-DedupVolume -Volume "\\?\Volume{26a21bda-a627-11d7-9931-806e6f6e6963}\" -``` - -This example returns the data deduplication settings for the volume with the specified GUID. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies one or more file system volumes for which to return data deduplication metadata, or in the case of a cluster, volumes with data deduplication metadata currently mounted by the managed node. -Enter one or more volume IDs, drive letters (such as `D:`), or volume GUID pathnames (using the form `\\\\?\Volume{{GUID}}\\`). -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeId -Specifies a string that uniquely identifies the volume on which to return data deduplication metadata. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ObjectId,Id,DeviceId - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-DedupVolume](./Disable-DedupVolume.md) - -[Enable-DedupVolume](./Enable-DedupVolume.md) - -[Set-DedupVolume](./Set-DedupVolume.md) diff --git a/docset/winserver2012-ps/deduplication/Measure-DedupFileMetadata.md b/docset/winserver2012-ps/deduplication/Measure-DedupFileMetadata.md deleted file mode 100644 index b83d893601..0000000000 --- a/docset/winserver2012-ps/deduplication/Measure-DedupFileMetadata.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/measure-dedupfilemetadata?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Measure-DedupFileMetadata - -## SYNOPSIS -Measures deduplication metadata for files in a set of folders on the same volume. - -## SYNTAX - -``` -Measure-DedupFileMetadata [-Path] [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Measure-DedupFileMetadata** cmdlet measures deduplication metadata for files in a set of folders on the same volume. -The DedupDistinctSize value that this cmdlet returns indicates how much disk space you can reclaim on a volume if you delete a group of folders and then run a Garbage Collection job. - -Files often have chunks that are shared across other folders. -The deduplication engine calculates which chunks are unique and would be deleted after the Garbage Collection job. - -## EXAMPLES - -### Example 1: Measure potential disk space on a volume -``` -PS C:\>Measure-DedupFileMetadata -Path "X:\A_Data","X:\Archive1" -``` - -This command measures potential disk space that you can reclaim on all folders in the paths X:\A_Data and X:\Archive1. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies an array of paths to folders. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Update-DedupStatus](./Update-DedupStatus.md) diff --git a/docset/winserver2012-ps/deduplication/New-DedupSchedule.md b/docset/winserver2012-ps/deduplication/New-DedupSchedule.md deleted file mode 100644 index 814c81364d..0000000000 --- a/docset/winserver2012-ps/deduplication/New-DedupSchedule.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/new-dedupschedule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DedupSchedule - -## SYNOPSIS -Creates a data deduplication schedule. - -## SYNTAX - -``` -New-DedupSchedule [-Name] [-Type] [-AsJob] [-CimSession ] [-Days] [-Disable] - [-DurationHours ] [-Full] [-Memory ] [-Priority ] [-ReadOnly] [-Start ] - [-StopWhenSystemBusy] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **New-DedupSchedule** cmdlet creates a data deduplication schedule. -This cmdlet returns a **DeduplicationSchedule** object that you can use to customize the data deduplication schedule. -This cmdlet uses default settings to create a data deduplication schedule for the parameters that you do not specify. - -You can create a schedule to run the following types data deduplication jobs: - -- Optimization: This type of job performs both deduplication and compression of files according data deduplication policy for the volume. After initial optimization of a file, if that file is then modified and again meets the data deduplication policy threshold for optimization, the file is optimized again. -- GarbageCollection: This job processes deleted or modified data on the volume so that any data chunks that are no longer referenced are cleaned up. Garbage collection jobs process previously deleted or logically overwritten optimized content to create usable volume free space. When an optimized file is deleted or overwritten by new data, the old data in the chunk store is not immediately deleted. Garbage collection is scheduled to run weekly by default. Garbage collection is a processing-intensive operation, so you should allow the deletion load to reach a threshold and then manually run this job type, or schedule it for off hours. -- Scrubbing: This job processes data corruptions it finds during data integrity validation, performs possible corruption repair, and generates a scrubbing report. -- Unoptimization: This job undoes data deduplication on all of the optimized files on the volume. At the end of a successful unoptimization job, the server deletes all of the data deduplication metadata from the volume. - -For more information, see [Install and Configure Data Deduplication](https://technet.microsoft.com/library/hh831434.aspx) on TechNet. - -## EXAMPLES - -### Example 1: Create a data deduplication schedule for a garbage collection job -``` -PS C:\>New-DedupSchedule -Name "OffHoursGC" -Type GarbageCollection -Start 08:00 -DurationHours 5 -Days Sun -Priority Normal -``` - -This command creates a data deduplication schedule for a garbage collection job named OffHoursGC. -The job is scheduled to run on Sundays at 8:00 at normal priority. -The command specifies that the server cancels the job after 5 hours if the process has not ended. - -### Example 2: Create a data deduplication schedule for a scrubbing job -``` -PS C:\>New-DedupSchedule -Name "OffHoursScrub" -Type Scrubbing -Start 23:00 -StopWhenSystemBusy -DurationHours 6 -Days Mon,Tues,Wed,Thurs,Fri -Priority Normal -``` - -This command creates a data deduplication schedule for a scrubbing job named OffHoursScrub. -The command starts the scrubbing job at 23:00 on Monday through Friday at normal priority. -The **StopWhenSystemBusy** parameter specifies that the server stops the job when the system is busy and retries later. -The **DurationHours** parameter specifies that the server cancels the job after 6 hours if the process has not ended. - -### Example 3: Create a data deduplication schedule for an optimization job -``` -PS C:\>New-DedupSchedule -Name "MyWeekendOptimization" -Type Optimization -Days Mon,Tues,Wed,Thurs,Fri -Start 08:00 -DurationHours 9 -``` - -This command creates a data deduplication schedule for an optimization job named MyWeekdayOptimization. -The optimization job runs at a normal priority every weekday evening at 8:00. -**DurationHours** specifies that the server cancels the job after 9 hours if the process has not ended. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Days -Specifies an array of days of the week on which the server runs the data deduplication job. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday - -Required: False -Position: Named -Default value: Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Disable -Indicates that the server disables the data deduplication schedule immediately after you create it. -The server does not run the data deduplication schedule at the time that you specify in the **Start** parameter. -After you disable a data deduplication schedule, you can use the Set-DedupSchedule cmdlet to enable the schedule. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DurationHours -Specifies the number of hours that the server runs the task before canceling it. -The value 0 indicates that the server runs the job to completion. -This cmdlet safely stops a data deduplication job and does not affect the files that the server is processing when it cancels the job. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 2 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Full -If you specify GarbageCollection for the **Type** parameter: -Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume. -If you do not specify this parameter, garbage collection jobs free up space after a system threshold of delete data is exceeded. -We recommend that you run garbage collection regularly without specifying this parameter, and then once a month specify this parameter and run garbage collection again. - -If you specify Scrubbing for the **Type** parameter: -Indicates that scrubbing jobs validate the integrity of all data on the volume. -If you do not specify this parameter, the scrubbing job validates only critical metadata and data integrity issues that data deduplication previously encountered. -We recommend that you run scrubbing regularly without specifying this parameter, and then once a month specify this parameter and run scrubbing again. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Memory -Specifies the maximum percentage of physical computer memory that the data deduplication job can use. - -For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. -For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can set a higher memory consumption, such as 50. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the data deduplication job schedule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. -For jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this parameter to High. -For typical optimization jobs, we recommend that you set this parameter to Normal. - -```yaml -Type: Priority -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReadOnly -Indicates that the scrubbing job processes and reports on corruptions that it finds but does not run any repair actions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Start -Specifies a time to start this job. -The default value is 1:45am. - -Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German \[Germany\]) or MM/dd/yyyy (English \[United States\]). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StopWhenSystemBusy -Indicates that the server stops the job when the system is busy and retries later. -We recommend that you specify this parameter when you set a low priority for the job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of data deduplication job. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization - -```yaml -Type: Type -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: Optimization -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.DateTime - -### System.DayOfWeek[] - -### System.Management.Automation.SwitchParameter - -### System.UInt32 - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupSchedule.Priority - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupSchedule.Type - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DedupSchedule](./Get-DedupSchedule.md) - -[Remove-DedupSchedule](./Remove-DedupSchedule.md) - -[Set-DedupSchedule](./Set-DedupSchedule.md) diff --git a/docset/winserver2012-ps/deduplication/Remove-DedupSchedule.md b/docset/winserver2012-ps/deduplication/Remove-DedupSchedule.md deleted file mode 100644 index 48e92fda53..0000000000 --- a/docset/winserver2012-ps/deduplication/Remove-DedupSchedule.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/remove-dedupschedule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DedupSchedule - -## SYNOPSIS -Deletes the specified DeduplicationSchedule object. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DedupSchedule [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DedupSchedule [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject -``` - -## DESCRIPTION -The **Remove-DedupSchedule** cmdlet deletes the specified DeduplicationSchedule object. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-DedupSchedule -Name MyDailyOptimization -``` - -This example deletes the DeduplicationJobSchedule object named MyDailyOptimization. - -### Example 2 -``` -PS C:\>Remove-DedupSchedule -Type Unoptimization -``` - -This example deletes all unoptimized DeduplicationJobSchedule objects. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the CIM instance object that represents the instance to be changed. -Enter a variable that contains the object, or type a cmdlet or expression that gets the object, such as the Get-DedupVolume cmdlet. -A service object can be piped to the Set-DedupVolume cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of one or more data deduplication job schedules that will be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing data deduplication settings to be removed and pushes it through to the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DedupSchedule](./Get-DedupSchedule.md) - -[New-DedupSchedule](./New-DedupSchedule.md) - -[Set-DedupSchedule](./Set-DedupSchedule.md) diff --git a/docset/winserver2012-ps/deduplication/Set-DedupSchedule.md b/docset/winserver2012-ps/deduplication/Set-DedupSchedule.md deleted file mode 100644 index f5ec9cee85..0000000000 --- a/docset/winserver2012-ps/deduplication/Set-DedupSchedule.md +++ /dev/null @@ -1,374 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/set-dedupschedule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DedupSchedule - -## SYNOPSIS -Changes configuration settings for data deduplication schedules. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DedupSchedule [-Name] [-AsJob] [-CimSession ] [-Days] [-DurationHours ] - [-Enabled ] [-Full ] [-Memory ] [-PassThru] [-Priority ] - [-ReadOnly ] [-Start ] [-StopWhenSystemBusy ] [-ThrottleLimit ] - [-Type ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DedupSchedule [-AsJob] [-CimSession ] [-Days] [-DurationHours ] [-Enabled ] - [-Full ] [-Memory ] [-PassThru] [-Priority ] [-ReadOnly ] - [-Start ] [-StopWhenSystemBusy ] [-ThrottleLimit ] -InputObject -``` - -## DESCRIPTION -The **Set-DedupSchedule** cmdlet changes configuration settings for one or more data deduplication schedules. - -## EXAMPLES - -### Example 1: Change settings of a data deduplication schedule for a garbage collection job -``` -PS C:\>Set-DedupSchedule -Name "OffHoursGC" -Type GarbageCollection -Start 08:00 -DurationHours 5 -Days Sun -Priority Normal -``` - -This command changes the settings of a data deduplication schedule for a garbage collection job named OffHoursGC. -The job is scheduled to run on Sundays at 8:00 at normal priority. -The command specifies that the server cancels the job after 5 hours if the process has not ended. - -### Example 2: Change settings of a data deduplication schedule for a scrubbing job -``` -PS C:\>Set-DedupSchedule -Name "OffHoursScrub" -Type Scrubbing -Start 23:00 -StopWhenSystemBusy $True -DurationHours 6 -Days Mon,Tues,Wed,Thurs,Fri -Priority Normal -``` - -This command changes the settings of a data deduplication schedule for a scrubbing job named OffHoursScrub. -The command starts the scrubbing job at 23:00 on Monday through Friday at normal priority. -The **StopWhenSystemBusy** parameter specifies that the server stops the job when the system is busy and retries later. -The **DurationHours** parameter specifies that the server cancels the job after 6 hours if the process has not ended. - -### Example 3: Change settings of a data deduplication schedule for an optimization job -``` -PS C:\>Set-DedupSchedule -Name "MyWeekendOptimization" -Type Optimization -Days Mon,Tues,Wed,Thurs,Fri -Start 08:00 -DurationHours 9 -``` - -This command changes the settings of a data deduplication schedule for an optimization job named MyWeekdayOptimization. -The optimization job runs at a normal priority every weekday evening at 8:00. -**DurationHours** specifies that the server cancels the job after 9 hours if the process has not ended. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Days -Specifies an array of days of the week on which the server runs the data deduplication job. -The acceptable values for this parameter are: -- Monday -- Tuesday -- Wednesday -- Thursday -- Friday -- Saturday -- Sunday - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday - -Required: False -Position: Named -Default value: Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DurationHours -Specifies the number of hours that the server runs the task before canceling it. -The value 0 indicates that the server runs the job to completion. -This cmdlet safely stops a data deduplication job and does not affect the files that the server is processing when it cancels the job. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 2 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether or not a data deduplication schedule is enabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Full -If you specify GarbageCollection for the **Type** parameter: -Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume. -If you do not specify this parameter, garbage collection jobs free up space after a system threshold of delete data is exceeded. -We recommend that you run garbage collection regularly without specifying this parameter, and then once a month specify this parameter and run garbage collection again. - -If you specify Scrubbing for the **Type** parameter: -Indicates that scrubbing jobs validate the integrity of all data on the volume. -If you do not specify this parameter, the scrubbing job validates only critical metadata and data integrity issues that data deduplication previously encountered. -We recommend that you run scrubbing regularly without specifying this parameter, and then once a month specify this parameter and run scrubbing again. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Memory -Specifies the maximum percentage of physical computer memory that the data deduplication job can use. - -For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. -For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can set higher memory consumption, such as 50. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a data deduplication job schedule. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Sets the CPU and I/O priority for the optimization job that you run by using this cmdlet. -For jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this parameter to High. -For typical optimization jobs, we recommend that you set this parameter to Normal. - -```yaml -Type: Priority -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReadOnly -Indicates whether or not the scrubbing job processes and reports on corruptions that it finds but does not run any repair actions. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Start -Specifies a time to start this job. -The default value is 1:45am. - -Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German \[Germany\]) or MM/dd/yyyy (English \[United States\]). - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopWhenSystemBusy -Indicates whether or not the server stops the job when the system is busy and retries later. -We recommend that you specify this parameter when you set a low priority for the job. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies an array of types of data deduplication jobs. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization - -```yaml -Type: Type[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -### Microsoft.Management.Infrastructure.CimInstance# - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupSchedule.Type[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DedupSchedule](./Get-DedupSchedule.md) - -[New-DedupSchedule](./New-DedupSchedule.md) - -[Remove-DedupSchedule](./Remove-DedupSchedule.md) diff --git a/docset/winserver2012-ps/deduplication/Set-DedupVolume.md b/docset/winserver2012-ps/deduplication/Set-DedupVolume.md deleted file mode 100644 index 22949a1833..0000000000 --- a/docset/winserver2012-ps/deduplication/Set-DedupVolume.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/set-dedupvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DedupVolume - -## SYNOPSIS -Changes data deduplication settings on one or more volumes. - -## SYNTAX - -### ByVolume (Default) -```powershell -Set-DedupVolume [-Volume] [-AsJob] [-ChunkRedundancyThreshold ] [-CimSession ] - [-ExcludeFileType ] [-ExcludeFolder ] [-MinimumFileAgeDays ] - [-MinimumFileSize ] [-NoCompress ] [-NoCompressionFileType ] [-PassThru] - [-ThrottleLimit ] [-Verify ] -``` - -### InputObject (cdxml) -```powershell -Set-DedupVolume [-AsJob] [-ChunkRedundancyThreshold ] [-CimSession ] - [-ExcludeFileType ] [-ExcludeFolder ] [-MinimumFileAgeDays ] - [-MinimumFileSize ] [-NoCompress ] [-NoCompressionFileType ] [-PassThru] - [-ThrottleLimit ] [-Verify ] -InputObject -``` - -## DESCRIPTION -The **Set-DedupVolume** cmdlet changes data deduplication settings on one or more volumes. - -## EXAMPLES - -### Example 1: Set the exclude folders on a volume -```powershell -PS C:\>Set-DedupVolume -Volume F: -ExcludeFolder F:\temp,F:\SQL -``` - -This command sets the root folders under which all files are skipped during data deduplication. -The *ExcludeFolder* parameter specifies that the data deduplication engine processes the files in all of the folders on volume F: except for files in the Temp folder and the SQL folder. - -### Example 2: Set the minimum file age on a volume -```powershell -PS C:\>Set-DedupVolume -Volume E: -MinimumFileAgeDays 10 -``` - -This command sets the number of days since users have accessed a file before the deduplication engine optimizes the file. -The *MinimumFileAgeDays* parameter specifies that the data deduplication engine processes the files in all of the folders on volume E: that were not accessed in the last 10 days. - -### Example 3: Set the chunk redundancy threshold on a volume -```powershell -PS C:\>Set-DedupVolume -Volume D: -MinimumFileAgeDays 15 -ChunkRedundancyThreshold 50 -``` - -This command sets the number of identical chunks of data that the deduplication engine encounters during deduplication before the server creates a redundant copy of the data chunk. -The *MinimumFileAgeDays* parameter specifies that the data deduplication engine processes the files in all of the folders on volume D: that were not accessed in the last 15 days. -The *ChunkRedundancyThreshold* parameter specifies that if the data deduplication engine discovers 50 chunks of identical data, it makes one redundant copy as a safeguard. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChunkRedundancyThreshold -Specifies the number of identical chunks of data that the deduplication engine encounters before the server creates a redundant copy of the data chunk. -This increases the reliability of the server by adding redundancy to the most referenced chunks of data. - -Deduplication detects corruptions and the deduplication scrubbing job restores the corrupted chunks from a redundant copy, if it is available. -The default value is 100. -The minimum value that you can set is 20. -A low value for the *ChunkRedundancyThreshold* parameter reduces the effectiveness of data deduplication by creating more redundant copies of a chunk, and consumes more memory and disk space. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFileType -Specifies an array of extension types that the deduplication engine excludes from data deduplication and optimization. -Specify comma-separated values that are not preceded with a period (.). -When you change this setting, you override the existing values. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeFolder -Specifies an array of names of root folders under which the deduplication engine excludes files from data deduplication and optimization. -Full paths are accepted, however mount points are ignored since the mount point can change after configuration. -When you change this setting, you override the existing values. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MinimumFileAgeDays -Specifies a number of days. -The deduplication engine optimizes files that users have not accessed in the number of days that you specify. -If the last access time is not available, then the deduplication engine uses the last modified time. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: MinimumFileAge - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumFileSize -Specifies the minimum size threshold, in bytes, for files that are optimized. -The deduplication engine does not optimize files that do not meet the minimum threshold. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoCompress -Indicates whether or not the server compresses data after deduplication. -Compression uses more processor cycles but provides additional space savings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoCompressionFileType -Specifies an array of file types that the deduplication engine excludes from compression. -These file types are deduplicated but not compressed, typically because the file format is already compressed. -Specify comma-separated values that are not preceded with a period (.). -When you change this setting, you override the existing values. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Video files, previously compressed files, all Microsoft Office 2007 files. These include, but are not limited to: aac|aif|aiff|asf|asx|au|avi|flac|jpeg|m3u|mid|midi|mov|mp1|mp2|mp3|mp4|mpa|mpe|mpeg|mpeg2|mpeg3|mpg|ogg|qt|qtw|ram|rm|rmi|rmvb|snd|swf|vob|wav|wax|wma|wmv|wvx|accdb|accde|accdr|accdt|docm|docx|dotm|dotx|pptm|potm|potx|ppam|ppsx|pptx|sldx|sldm|thmx|xlsx|xlsm|xltx|xltm|xlsb|xlam|xll|ace|arc|arj|bhx|b2|cab|gz|gzip|hpk|hqx|jar|lha|lzh|lzx|pak|pit|rar|sea|sit|sqz|tgz|uu|uue|z|zip|zoo -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verify -Indicates whether or not the deduplication engine performs a byte-for-byte verification for each duplicate chunk that optimization creates, rather than relying on a cryptographically strong hash. -We do not recommend that you use this parameter. -Setting this parameter to $True can degrade optimization performance. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies an array of system volumes. -Specify one or more volume IDs, drive letters, or volume GUID paths. -For drive letters, use the format D:. -For volume GUID paths, use the format \\\\?\Volume{{GUID}}\. -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: ByVolume -Aliases: Path,Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupVolume - -## NOTES - -## RELATED LINKS - -[Disable-DedupVolume](./Disable-DedupVolume.md) - -[Enable-DedupVolume](./Enable-DedupVolume.md) - -[Get-DedupVolume](./Get-DedupVolume.md) diff --git a/docset/winserver2012-ps/deduplication/Start-DedupJob.md b/docset/winserver2012-ps/deduplication/Start-DedupJob.md deleted file mode 100644 index 4e8aa15df5..0000000000 --- a/docset/winserver2012-ps/deduplication/Start-DedupJob.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/start-dedupjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-DedupJob - -## SYNOPSIS -Starts a data deduplication job. - -## SYNTAX - -``` -Start-DedupJob [-Type] [[-Volume] ] [-AsJob] [-CimSession ] [-Full] - [-Memory ] [-Preempt] [-Priority ] [-ReadOnly] [-StopWhenSystemBusy] - [-ThrottleLimit ] [-Timestamp ] [-Wait] -``` - -## DESCRIPTION -The **Start-DedupJob** starts a new data deduplication job for one or more volumes. -The data deduplication job can queue if the server is running another job on the same volume or if the computer does not have sufficient resources to run the job. -The server marks the queued jobs that you start with this cmdlet as manual jobs and gives the manual jobs priority over scheduled jobs. -The server returns a **DeduplicationJob** object for each job that you start with this cmdlet. - -For multi-volume data deduplication jobs, you can use the **Preempt** parameter to move a job to the top of the job queue and cancel the current job. - -## EXAMPLES - -### Example 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Full -If you specify GarbageCollection for the **Type** parameter: -Indicates that garbage collection jobs free up all deleted or unreferenced data on the volume. -If you do not specify this parameter, garbage collection jobs free up space after a system threshold of delete data is exceeded. -We recommend that you run garbage collection regularly without specifying this parameter, and then once a month specify this parameter and run garbage collection again. - -If you specify Scrubbing for the **Type** parameter: -Indicates that scrubbing jobs validate the integrity of all data on the volume. -If you do not specify this parameter, the scrubbing job validates only critical metadata and data integrity issues that data deduplication previously encountered. -We recommend that you run scrubbing regularly without specifying this parameter, and then once a month specify this parameter and run scrubbing again. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Memory -Specifies the maximum percentage of physical computer memory that the data deduplication job can use. - -For optimization jobs, we recommend that you set a range from 15 to 50, and a higher memory consumption for jobs that you schedule to run when you specify the **StopWhenSystemBusy** parameter. -For garbage collection and scrubbing jobs, which you typically schedule to run in off hours, you can set a higher memory consumption, such as 50. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preempt -Indicates that the deduplication engine moves the job to the top of the job queue and cancels the current job. -After the server cancels the current job, the deduplication engine cannot run the preempting job if the server does not have enough memory to run the job. - -This parameter applies to manual data deduplication jobs only and is ignored for scheduled jobs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Sets the CPU and I/O priority for the optimization job run that you run by using this cmdlet. -For jobs that you run when you specify the **StopWhenSystemBusy** parameter, we recommend that you set this parameter to High. -For typical optimization jobs, we recommend that you set this parameter to Normal. - -```yaml -Type: Priority -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReadOnly -Indicates that the scrubbing job process and report on corruptions that it finds but does not run any repair actions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StopWhenSystemBusy -Indicates that the server stops the job when the system is busy and retries later. -We recommend that you specify this parameter when you set a low priority for the job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timestamp -Specifies a date and time. -This parameter applies only to unoptimization jobs. -The deduplication engine unoptimizes only files that it optimized or reoptimized since the **DateTime** value that you specify. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of data deduplication job. -The acceptable values for this parameter are: -- Optimization -- GarbageCollection -- Scrubbing -- Unoptimization - -```yaml -Type: Type -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Volume -Specifies an array of system volumes for which you want to manually queue data deduplication jobs. -Enter one or more volume IDs, drive letters (such as D:), or volume GUID pathnames (using the form `\\\\?\Volume{{GUID}}\\`). -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name,DeviceId - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Wait -Indicates that the cmdlet waits for the job to complete and provides progress information to the client. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.Automation.SwitchParameter - -### System.String[] - -### System.UInt32 - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Priority - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Type - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DedupJob](./Get-DedupJob.md) - -[Stop-DedupJob](./Stop-DedupJob.md) diff --git a/docset/winserver2012-ps/deduplication/Stop-DedupJob.md b/docset/winserver2012-ps/deduplication/Stop-DedupJob.md deleted file mode 100644 index b13ba77789..0000000000 --- a/docset/winserver2012-ps/deduplication/Stop-DedupJob.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/stop-dedupjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-DedupJob - -## SYNOPSIS -Cancels one or more specified data deduplication jobs. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-DedupJob [-Volume] [[-Type] ] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-DedupJob [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Stop-DedupJob [-AsJob] [-CimSession ] [-Id ] [-PassThru] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Stop-DedupJob** cmdlet cancels one or more specified data deduplication jobs. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Identifies the job to be cancel. -This can be obtained by running the Get-DedupJob cmdlet. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the CIM instance object that represents the instance to be changed. -Enter a variable that contains the object, or type a cmdlet or expression that gets the object, such as the Get-DedupVolume cmdlet. -A service object can be piped to the Set-DedupVolume cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing data deduplication settings you want to stop and pushes it through the pipeline to the next cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the names of one or more types of data deduplication job schedules for which to return DeduplicationJobSchedule objects. -The acceptable values for this parameter are: Optimization, GarbageCollection, Scrubbing, and Unoptimization. - -```yaml -Type: Type[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Volume -Specifies one or more file system volumes on which to cancel one or more named data deduplication jobs. -Enter one or more volume IDs, drive letters (such as `D:`), or volume GUID pathnames (using the form `\\\\?\Volume{{GUID}}\\`). -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Path,Name,DeviceId - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Type[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DedupJob](./Get-DedupJob.md) - -[Start-DedupJob](./Start-DedupJob.md) diff --git a/docset/winserver2012-ps/deduplication/Update-DedupStatus.md b/docset/winserver2012-ps/deduplication/Update-DedupStatus.md deleted file mode 100644 index b5888ac938..0000000000 --- a/docset/winserver2012-ps/deduplication/Update-DedupStatus.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Dedup_Cmdlets.xml -Module Name: Deduplication -online version: https://learn.microsoft.com/powershell/module/deduplication/update-dedupstatus?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-DedupStatus - -## SYNOPSIS -Scans one or more specified volumes to compute fresh data deduplication savings information and returns a DeduplicationStatus object. - -## SYNTAX - -``` -Update-DedupStatus [[-Volume] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Update-DedupStatus** cmdlet scans one or more specified volumes to compute fresh data deduplication savings information. -This cmdlet returns a DeduplicationStatus object. -For quick access to cached metadata use Get-DedupStatus. -When this cmdlet is run on multiple volumes with one cmdlet call, the analysis for each volume is done serially. - -Note: On large volumes this cmdlet can run for several minutes and will always perform a rescan after the initial scan. -The default behavior is to wait for completion, regardless of the length of time required to run the scan and rescan. - -To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option. - -This cmdlet returns the following metadata: - - - - DedupSavedSpace: Saved space is the difference between the logical size of the optimized files and the logical size of the store (the deduplicated user data plus data deduplication metadata). -This number will change continually. - - - - DedupRate: Data deduplication rate is the ratio of data deduplication saved space to the logical size of all of the files on the volume and is expressed in percentage. -This number will change continually. - - - - OptimizedFilesCount: Optimized files count is the number of optimized files on the specified volume. -Note that this number will remain steady (instead of decrease) as users delete files from, or add files to, the volume-until a garbage collection job is run. -This count is most accurate after a garbage collection job runs. - - - - OptimizedFilesSize: Optimized files size is the aggregate size of all optimized files on the specified volume. -Note that this number will remain steady (instead of decrease) as users delete files from, or add new files to, the volume-until a garbage collection job is run. -This number is most accurate after a garbage collection job runs. - - - - InPolicyFilesCount: In policy files count is the number of files that currently qualify for optimization. -This number will stay relatively constant between optimization jobs. - - - - InPolicyFilesSize: In policy files size is the aggregate size of all files that currently qualify for optimization. -This number will stay relatively constant between optimization jobs. - - - - LastOptimizationTime: Last optimization time specifies the data and time when an optimization job was run last on the specified volume. -This date and time will stay constant between optimization jobs. - - - - LastGarbageCollectionTime: Last garbage collection time specifies the data and time when a garbage collection job was run last on the specified volume. -This date and time will stay constant between optimization jobs. - - - - LastScrubbingTime: Last scrubbing time specifies the data and time when a scrubbing job was run last on the specified volume. -This date and time will stay constant between optimization jobs. - -## EXAMPLES - -### 1: -``` -PS C:\> -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Volume -Specifies one or more file system volumes for which to scan and compute fresh data deduplication savings information. -Enter one or more volume IDs, drive letters (such as `D:`), or volume GUID pathnames (using the form `\\\\?\Volume{{GUID}}\\`). -Separate multiple volumes with a comma. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Path,Name,DeviceId - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DedupStatus](./Get-DedupStatus.md) diff --git a/docset/winserver2012-ps/dfsn/DFSN.md b/docset/winserver2012-ps/dfsn/DFSN.md deleted file mode 100644 index c8b5aa01ce..0000000000 --- a/docset/winserver2012-ps/dfsn/DFSN.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: d94cf4d4-f7f8-4967-8d7c-1c9ffef8da12 -Module Name: DFSN ---- - -# DFSN Module -## Description -This reference provides cmdlet descriptions and syntax for all DFS Namespace cmdlets. -It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## DFSN Cmdlets -### [Get-DfsnAccess](./Get-DfsnAccess.md) -Gets permissions for a DFS namespace folder. - -### [Get-DfsnFolder](./Get-DfsnFolder.md) -Gets settings for a DFS namespace folder. - -### [Get-DfsnFolderTarget](./Get-DfsnFolderTarget.md) -Gets settings for targets of a DFS namespace folder. - -### [Get-DfsnRoot](./Get-DfsnRoot.md) -Gets settings for DFS namespaces. - -### [Get-DfsnRootTarget](./Get-DfsnRootTarget.md) -Gets settings for root targets of a DFS namespace. - -### [Get-DfsnServerConfiguration](./Get-DfsnServerConfiguration.md) -Gets DFS namespace settings for a DFSN root server. - -### [Grant-DfsnAccess](./Grant-DfsnAccess.md) -Grants permissions to users and groups to access a DFS namespace folder. - -### [Move-DfsnFolder](./Move-DfsnFolder.md) -Moves or renames a DFS namespace folder. - -### [New-DfsnFolder](./New-DfsnFolder.md) -Creates a folder in a DFS namespace. - -### [New-DfsnFolderTarget](./New-DfsnFolderTarget.md) -Adds a target to a DFS namespace folder. - -### [New-DfsnRoot](./New-DfsnRoot.md) -Creates a DFS namespace. - -### [New-DfsnRootTarget](./New-DfsnRootTarget.md) -Adds a root target to a DFS namespace. - -### [Remove-DfsnAccess](./Remove-DfsnAccess.md) -Removes users and groups from the ACL for a folder in a DFS namespace. - -### [Remove-DfsnFolder](./Remove-DfsnFolder.md) -Removes a DFS namespace folder. - -### [Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) -Removes a target for a DFS namespace folder. - -### [Remove-DfsnRoot](./Remove-DfsnRoot.md) -Removes a DFS namespace. - -### [Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) -Removes a target for a DFS namespace root. - -### [Revoke-DfsnAccess](./Revoke-DfsnAccess.md) -Revokes permissions for users to access and enumerate the contents of a DFS namespace folder. - -### [Set-DfsnFolder](./Set-DfsnFolder.md) -Changes settings for a DFS namespace folder. - -### [Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) -Changes settings for a target of a DFS namespace folder. - -### [Set-DfsnRoot](./Set-DfsnRoot.md) -Changes settings for a DFS namespace. - -### [Set-DfsnRootTarget](./Set-DfsnRootTarget.md) -Changes settings for a root target of a DFS namespace. - -### [Set-DfsnServerConfiguration](./Set-DfsnServerConfiguration.md) -Changes settings for a DFS namespace root server. - diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnAccess.md b/docset/winserver2012-ps/dfsn/Get-DfsnAccess.md deleted file mode 100644 index 4fa08241ab..0000000000 --- a/docset/winserver2012-ps/dfsn/Get-DfsnAccess.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: DfsNamespaceAccess.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/get-dfsnaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DfsnAccess - -## SYNOPSIS -Gets permissions for a DFS namespace folder. - -## SYNTAX - -``` -Get-DfsnAccess [-Path] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-DfsnAccess** cmdlet gets account names and access types for users and groups that have permissions for a Distributed File System (DFS) namespace folder. -You can use the Grant-DfsnAccess cmdlet and the Revoke-DfsnAccess cmdlet to manage access for DFS namespace folders. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Get permissions for a folder -``` -PS C:\> Get-DfsnAccess -Path "\\Contoso\Software\Projects" -``` - -This command gets permissions for a DFS namespace folder that has the path \\\\Contoso\Software\Projects. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for a DFS namespace folder. -This cmdlet gets permissions for the folder specified. -Provide a complete path for a folder, not a partial or relative path. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceAccess[] - -## NOTES - -## RELATED LINKS - -[Grant-DfsnAccess](./Grant-DfsnAccess.md) - -[Remove-DfsnAccess](./Remove-DfsnAccess.md) - -[Revoke-DfsnAccess](./Revoke-DfsnAccess.md) - diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md b/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md deleted file mode 100644 index e51619ffec..0000000000 --- a/docset/winserver2012-ps/dfsn/Get-DfsnFolder.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: DfsNamespaceFolder.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/get-dfsnfolder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DfsnFolder - -## SYNOPSIS -Gets settings for a DFS namespace folder. - -## SYNTAX - -``` -Get-DfsnFolder [-Path] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-DfsnRoot** cmdlet gets configuration settings for a Distributed File System (DFS) namespace folder. -Specify a folder by using its path. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Get settings for a specified folder -``` -PS C:\> Get-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -``` - -This command displays settings for the \\\\Contoso\AccountingResources\LegacySoftware folder. - -### Example 2: Get settings for all folders in a DFS namespace -``` -PS C:\> Get-DfsnFolder -Path "\\Contoso\AccountingResources\*" -``` - -The command uses the wildcard to get settings for all the folders in the \\\\Contoso\AccountingResources DFS namespace. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the folder. -This cmdlet gets configuration settings for the DFS namespace folder that has the path specified. - -You can use DFS namespace with the wildcard character to get settings for all the folders in the namespace. -See the Examples section. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolder[] - -## NOTES - -## RELATED LINKS - -[Move-DfsnFolder](./Move-DfsnFolder.md) - -[New-DfsnFolder](./New-DfsnFolder.md) - -[Remove-DfsnFolder](./Remove-DfsnFolder.md) - -[Set-DfsnFolder](./Set-DfsnFolder.md) - diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnFolderTarget.md b/docset/winserver2012-ps/dfsn/Get-DfsnFolderTarget.md deleted file mode 100644 index 748e41343e..0000000000 --- a/docset/winserver2012-ps/dfsn/Get-DfsnFolderTarget.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: DfsNamespaceFolderTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/get-dfsnfoldertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DfsnFolderTarget - -## SYNOPSIS -Gets settings for targets of a DFS namespace folder. - -## SYNTAX - -```powershell -Get-DfsnFolderTarget [-Path] [[-TargetPath] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DfsnFolderTarget** cmdlet gets settings for targets of a Distributed File System (DFS) namespace folder. -You can specify a DFS namespace folder path to see all the targets for that path. -You can specify a namespace path and a target path to see settings for a particular target. - -For more information about DFS namespaces, see [DFS Namespaces overview](/windows-server/storage/dfs-namespaces/dfs-overview). - -## EXAMPLES - -### Example 1: Get settings for a target -```powershell -PS C:\> Get-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" -NamespacePath : \\Contoso\AccountingResources\LegacySoftware -ReferralPriorityClass : sitecost-normal -ReferralPriorityRank : 0 -State : Online -TargetPath : \\Contoso-FS\LegacySoftware -PSComputerName : -``` - -This command gets settings for the target of the \\\\Contoso\AccountingResources\LegacySoftware folder with the folder target of \\\\Contoso-FS\LegacySoftware. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root folder of a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for the target of a DFS namespace folder. -This cmdlet gets settings for the target that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, FolderTarget - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolderTarget[] - -## NOTES - -## RELATED LINKS - -[New-DfsnFolderTarget](./New-DfsnFolderTarget.md) - -[Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) - -[Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnRoot.md b/docset/winserver2012-ps/dfsn/Get-DfsnRoot.md deleted file mode 100644 index 4ef74df0e4..0000000000 --- a/docset/winserver2012-ps/dfsn/Get-DfsnRoot.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: DfsNamespace.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/get-dfsnroot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DfsnRoot - -## SYNOPSIS -Gets settings for DFS namespaces. - -## SYNTAX - -### ByDomain (Default) -``` -Get-DfsnRoot [[-Domain] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -### ByRoot -``` -Get-DfsnRoot [[-Path] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -### ByServer -``` -Get-DfsnRoot [[-ComputerName] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-DfsnRoot** cmdlet gets configuration settings for Distributed File System (DFS) namespaces. -You can specify DFS namespaces by using a standalone or domain-based namespace path, by using a server, or by using a domain. -Use this cmdlet without parameters to see information on all DFS namespaces. -You can make changes to DFS settings by using the Set-DfsnRoot cmdlet. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Get DFS namespace configuration settings -``` -PS C:\> Get-DfsnRoot -Path "\\Contoso\AccountingResources" | Format-List -Path : \\Contoso\AccountingResources -Description : -Type : Standalone -State : Online -Flags : Site Costing -TimeToLiveSec : 300 -``` - -This command gets configuration settings for the namespace that has the Path \\\\Contoso\AccountingResources. -The command uses the **Format-List** cmdlet to format the output. -For more information about this cmdlet, type `Get-Help Format-List`. - -### Example 2: Get all DFS namespaces for a domain -``` -PS C:\> Get-DfsnRoot -Domain "Contoso.com" -``` - -This command gets all the DFS namespaces hosted in the domain Contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the name of a server. -This cmdlet gets configuration settings for all DFS namespaces that the specified server hosts. - -```yaml -Type: String -Parameter Sets: ByServer -Aliases: Server - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Domain -Specifies a domain name. -This cmdlet gets configuration settings for DFS namespaces in the domain specified. - -```yaml -Type: String -Parameter Sets: ByDomain -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root folder of a DFS namespace. -This cmdlet gets configuration settings for the DFS namespace that has the root path specified. - -```yaml -Type: String -Parameter Sets: ByRoot -Aliases: RootPath, root, namespace, NamespaceRoot - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespace[] - -## NOTES - -## RELATED LINKS - -[New-DfsnRoot](./New-DfsnRoot.md) - -[Remove-DfsnRoot](./Remove-DfsnRoot.md) - -[Set-DfsnRoot](./Set-DfsnRoot.md) - diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnRootTarget.md b/docset/winserver2012-ps/dfsn/Get-DfsnRootTarget.md deleted file mode 100644 index c04df2c584..0000000000 --- a/docset/winserver2012-ps/dfsn/Get-DfsnRootTarget.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: DfsNamespaceRootTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/get-dfsnroottarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DfsnRootTarget - -## SYNOPSIS -Gets settings for root targets of a DFS namespace. - -## SYNTAX - -``` -Get-DfsnRootTarget [-Path] [[-TargetPath] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DfsnRootTarget** cmdlet gets settings for root targets of a Distributed File System (DFS) namespace. -You can specify a DFS namespace path to see all the root targets for that namespace. -You can specify a namespace path and a target path to see settings for a single root target. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Get root targets for a NFS DFS namespaceDFS -``` -PS C:\> Get-DfsnRootTarget -Path "\\Contoso\AccountingSoftware" -``` - -This command gets the DFS namespace root targets for the namespace that has the path \\\\Contoso\AccountingSoftware. - -### Example 2: Get a specified root target -``` -PS C:\> Get-DfsnRootTarget -Path "\\Contoso\AccountingSoftware" -TargetPath "\\Contoso-FS\Software" -``` - -This command gets a single root target, specified by using the path \\\\Contoso\AccountingSoftware and the target path \\\\Contoso-FS\Software. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root folder of a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, NamespaceRoot - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for the root folder target of a DFS namespace. -This cmdlet gets settings for the root target that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, RootTargetPath - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceRootTarget - -## NOTES - -## RELATED LINKS - -[New-DfsnRootTarget](./New-DfsnRootTarget.md) - -[Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) - -[Set-DfsnRootTarget](./Set-DfsnRootTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/Get-DfsnServerConfiguration.md b/docset/winserver2012-ps/dfsn/Get-DfsnServerConfiguration.md deleted file mode 100644 index 12474dd4cd..0000000000 --- a/docset/winserver2012-ps/dfsn/Get-DfsnServerConfiguration.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: DfsNamespaceServerConfig.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/get-dfsnserverconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DfsnServerConfiguration - -## SYNOPSIS -Gets DFS namespace settings for a DFSN root server. - -## SYNTAX - -``` -Get-DfsnServerConfiguration [-ComputerName] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DfsnServerConfiguration** cmdlet gets Distributed File System (DFS) namespace settings for a DFS namespace root server. -A DFS namespace root server hosts one or more namespace root targets. -You can use this cmdlet to see current settings for a server, and you can use the Set-DfsnServerConfiguration cmdlet to make changes to a server. - -## EXAMPLES - -### Example 1: Get settings for a server -``` -PS C:\> Get-DfsnServerConfiguration -ComputerName "Contoso-FS" -ComputerName : Contoso-FS -LdapTimeoutSec : -PreferLogonDC : -EnableSiteCostedReferrals : -EnableInsiteReferrals : -SyncIntervalSec : -UseFqdn : -``` - -This command gets the Retrieves the configuration settings of the DFS namespace server Contoso-FS. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the host name or fully qualified domain name (FQDN) for a DFS namespace server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: NamespaceServer - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceServerConfig - -## NOTES - -## RELATED LINKS - -[Set-DfsnServerConfiguration](./Set-DfsnServerConfiguration.md) - diff --git a/docset/winserver2012-ps/dfsn/Grant-DfsnAccess.md b/docset/winserver2012-ps/dfsn/Grant-DfsnAccess.md deleted file mode 100644 index 32d4698012..0000000000 --- a/docset/winserver2012-ps/dfsn/Grant-DfsnAccess.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: DfsNamespaceAccess.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/grant-dfsnaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Grant-DfsnAccess - -## SYNOPSIS -Grants permissions to users and groups to access a DFS namespace folder. - -## SYNTAX - -``` -Grant-DfsnAccess [-Path] [-AccountName] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Grant-DfsnAccess** cmdlet grants permissions to users and groups for a Distributed File System (DFS) namespace folder. -This cmdlet grants permissions to access a folder and to enumerate its contents. -You can use the Get-DfsnAccess cmdlet to see the current permissions, and you can use the Revoke-DfsnAccess cmdlet to revoke permissions. - -For a DFS namespace which has Access-based enumeration enabled, users can see only the folders that they can access. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Grant a permission to a user -``` -PS C:\> Grant-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "Western\SarahJones" -``` - -This command grants the user Western\SarahJones permissions for the folder \\\\Contoso\Software\Projects. - -## PARAMETERS - -### -AccountName -Specifies an array of user and group accounts. -This cmdlet grants permissions to the accounts specified. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Account, user - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for a DFS namespace folder. -This cmdlet grants permissions to access the folder specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceAccess - -## NOTES - -## RELATED LINKS - -[Get-DfsnAccess](./Get-DfsnAccess.md) - -[Remove-DfsnAccess](./Remove-DfsnAccess.md) - -[Revoke-DfsnAccess](./Revoke-DfsnAccess.md) - diff --git a/docset/winserver2012-ps/dfsn/Move-DfsnFolder.md b/docset/winserver2012-ps/dfsn/Move-DfsnFolder.md deleted file mode 100644 index 9716f4e133..0000000000 --- a/docset/winserver2012-ps/dfsn/Move-DfsnFolder.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: DfsNamespaceFolder.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/move-dfsnfolder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-DfsnFolder - -## SYNOPSIS -Moves or renames a DFS namespace folder. - -## SYNTAX - -``` -Move-DfsnFolder [-Path] [-NewPath] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Move-DfsnFolder** cmdlet moves or renames a Distributed File System (DFS) namespace folder. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Move a folder -``` -PS C:\> Move-DfsnFolder -Path "\\Contoso\Western\Development\DesignDocuments" -NewPath "\\Contoso\Western\HumanResources\DesignDocuments" -``` - -This command moves the folder DesignDocuments to the location \\\\Contoso\Western\HumanResources. -After you run this command, the folder \\\\Contoso\Western\Development\DesignDocuments no longer exists. - -### Example 2: Rename a folder -``` -PS C:\> Move-DfsnFolder -Path "\\Contoso\AccountingSoftware\Software" -NewPath "\\Contoso\AccountingSoftware\LegacySoftware" -``` - -This command renames the folder Software in the \\\\Contoso\AccountingSoftware folder. -The new name is \\\\Contoso\AccountingSoftware\LegacySoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Moves or renames a DFS namespace folder without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPath -Specifies a path for the DFS namespace folder. -This cmdlet moves or renames the folder to have the path specified. -Do not specify an existing DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: NewDfsPath, NewNamespacePath - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path for a DFS namespace folder. -This cmdlet moves or renames the folder that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolder - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolder](./Get-DfsnFolder.md) - -[New-DfsnFolder](./New-DfsnFolder.md) - -[Remove-DfsnFolder](./Remove-DfsnFolder.md) - -[Set-DfsnFolder](./Set-DfsnFolder.md) - diff --git a/docset/winserver2012-ps/dfsn/New-DfsnFolder.md b/docset/winserver2012-ps/dfsn/New-DfsnFolder.md deleted file mode 100644 index 52f033fc36..0000000000 --- a/docset/winserver2012-ps/dfsn/New-DfsnFolder.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: DfsNamespaceFolder.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/new-dfsnfolder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DfsnFolder - -## SYNOPSIS -Creates a folder in a DFS namespace. - -## SYNTAX - -``` -New-DfsnFolder [-Path] [-TargetPath] [[-EnableInsiteReferrals] ] - [[-EnableTargetFailback] ] [[-State] ] [[-TimeToLiveSec] ] [[-Description] ] - [[-TargetState] ] [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-DfsnFolder** cmdlet creates a folder in a Distributed File System (DFS) namespace. -Specify the path and a path for a folder target for the new folder. - -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. - -You can specify settings for the new folder. -You can use this cmdlet to enable or disable the following settings: - -- In-site referrals. -- Target failback. - -You can also add a descriptive comment, select the state of the folder and folder target, and set the Time to Live (TTL) interval for referrals. - -Finally, you can specify the priority class and priority rank for referrals. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Create a DFS namespace folder -``` -PS C:\> New-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\AccountingLegacy" -EnableTargetFailback $True -Description "Folder for legacy software." -``` - -This command creates a folder called LegacySoftware in the \\\\Contoso\AccountingResources namespace. -The folder target is \\\\Contoso-FS\AccountingLegacy. -The command enables target failback for the folder. -The command includes a description for the new folder. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: desc - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, the DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: insite - -Required: False -Position: 2 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access a target on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to fail back to the preferred server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: failback, TargetFailback - -Required: False -Position: 3 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the folder. -This path must be unique. -This path cannot be the name of an existing DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityClass -Specifies the target priority class for a DFS namespace folder. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. - -```yaml -Type: ReferralPriorityClass -Parameter Sets: (All) -Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow, invalid - -Required: False -Position: 8 -Default value: Sitecost-normal -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a target in the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: PriorityRank, Rank - -Required: False -Position: 9 -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace folder. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 4 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for a target for the DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, FolderTarget - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetState -Specifies the state of the DFS namespace folder target. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder target that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to targets for this length of time. -The default TTL interval for folder referrals is 1800 seconds (30 minutes). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: ttl, TimeToLive - -Required: False -Position: 5 -Default value: 300 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolder - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolder](./Get-DfsnFolder.md) - -[Move-DfsnFolder](./Move-DfsnFolder.md) - -[Remove-DfsnFolder](./Remove-DfsnFolder.md) - -[Set-DfsnFolder](./Set-DfsnFolder.md) - diff --git a/docset/winserver2012-ps/dfsn/New-DfsnFolderTarget.md b/docset/winserver2012-ps/dfsn/New-DfsnFolderTarget.md deleted file mode 100644 index c553e74349..0000000000 --- a/docset/winserver2012-ps/dfsn/New-DfsnFolderTarget.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: DfsNamespaceFolderTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/new-dfsnfoldertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DfsnFolderTarget - -## SYNOPSIS -Adds a target to a DFS namespace folder. - -## SYNTAX - -``` -New-DfsnFolderTarget [-Path] [-TargetPath] [[-State] ] - [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-DfsnFolderTarget** cmdlet adds a target to a Distributed File System (DFS) namespace folder. -Specify the DFS namespace folder and the folder target. -You can set the state of the DFS namespace target and configure priority class and priority rank for referrals. - -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Add a target folder target -``` -PS C:\> New-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\Software" -ReferralPriorityClass GlobalLow -``` - -This command adds \\\\Contoso-FS\Software as a target for the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware with a referral priority of global low. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path of the DFS namespace folder. -This cmdlet adds a target for the folder that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityClass -Specifies the priority class for a DFS namespace folder target. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. - -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. - -```yaml -Type: ReferralPriorityClass -Parameter Sets: (All) -Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow, invalid - -Required: False -Position: 3 -Default value: Sitecost-normal -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a target of the DFS namespace folder. -Lower values have greater preference. -A value of zero (0) is the greatest preference. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: PriorityRank, Rank - -Required: False -Position: 4 -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder target that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 2 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for a target of the DFS namespace folder. -This cmdlet adds this path specified as the folder target. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, FolderTarget - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolderTarget - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolderTarget](./Get-DfsnFolderTarget.md) - -[Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) - -[Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/New-DfsnRoot.md b/docset/winserver2012-ps/dfsn/New-DfsnRoot.md deleted file mode 100644 index 0c4a84f119..0000000000 --- a/docset/winserver2012-ps/dfsn/New-DfsnRoot.md +++ /dev/null @@ -1,451 +0,0 @@ ---- -external help file: DfsNamespace.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/new-dfsnroot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DfsnRoot - -## SYNOPSIS -Creates a DFS namespace. - -## SYNTAX - -``` -New-DfsnRoot [-Path ] [-TargetPath] [-Type] [[-EnableSiteCosting] ] - [[-EnableInsiteReferrals] ] [[-EnableAccessBasedEnumeration] ] - [[-EnableRootScalability] ] [[-EnableTargetFailback] ] [[-Description] ] - [[-State] ] [[-TimeToLiveSec] ] [[-GrantAdminAccounts] ] [[-TargetState] ] - [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-DfsnRoot** cmdlet creates a Distributed File System (DFS) namespace. -Specify the root path and the root target path for the new namespace. -You must also specify a type: stand-alone namespace, Windows 2000 Server mode (Domain v1) namespace, or Windows Server 2008 mode (Domain v2) namespace. - -You can specify settings for the new namespace. -You can use this cmdlet to enable or disable the following settings: - -- Site costing. -- In-site referrals. -- Access-based enumeration. -- Root scalability. -- Target failback. - -You can also add a descriptive comment, select the state of the DFS namespace and DFS root target, and set the Time to Live (TTL) interval for referrals. - -To manage the DFS namespace, you can grant permissions to users or user groups. -Users who have these permissions can add, remove, and modify namespace folders and folder targets for the DFS namespace. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Create a Windows Server 2008 mode domain DFS namespace -``` -PS C:\> New-DfsnRoot -TargetPath "\\Contoso-FS\AccountingResources" -Type DomainV2 -Path "\\Contoso\AccountingResources" -``` - -This command creates a DFS namespace that has a root at the path \\\\Contoso\AccountingResources. -The root target for the path is the shared folder \\\\Contoso-FS\AccountingResources. -The namespace type is Windows Server 2008 mode, specified as a type of DomainV2. - -### Example 2: Create a stand-alone DFS namespace -``` -PS C:\> New-DfsnRoot -TargetPath "\\Contoso-FS\Software" -Type Standalone -EnableSiteCosting -Path "\\Contoso\Software" -``` - -This command creates a stand-alone DFS namespace that has a root at path \\\\Contoso\Software that has a namespace root target pointing to \\\\Contoso-FS\Software. -This namespace uses cost-based site selection. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: desc - -Required: False -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAccessBasedEnumeration -Indicates whether a DFS namespace uses access-based enumeration. -If this value is $True, a DFS namespace server shows a user only the files and folders that the user can access. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: abe, abde - -Required: False -Position: 4 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, the DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: insite - -Required: False -Position: 3 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableRootScalability -Indicates whether a DFS namespace uses root scalability mode. -If this value is $True, DFS namespace servers connect to the nearest domain controllers for periodic namespace updates. -If this value is $False, the servers connect to the primary domain controller (PDC) emulator. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: RootScalability, rootscale - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableSiteCosting -Indicates whether a DFS namespace uses cost-based selection. -If a client cannot access a folder target in-site, a DFS namespace server selects the least resource intensive alternative. -If you provide a value of $True for this parameter, DFS namespace favors high-speed links over wide area network (WAN) links. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: SiteCosting, sitecost - -Required: False -Position: 2 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access a target on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to fail back to the preferred server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: failback, TargetFailback - -Required: False -Position: 6 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GrantAdminAccounts -Specifies an array of accounts. -This cmdlet grants management permissions for the DFS namespace to the users and user groups specified. -Users can add, remove, and modify namespace folders and folder targets. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: GrantAdmin, GrantAdminAccess - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root of a DFS namespace. -This path must be unique. -This path cannot be the name of an existing DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RootPath, root, namespace, NamespaceRoot - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityClass -Specifies the target priority class for a DFS namespace root. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. - -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. - -```yaml -Type: ReferralPriorityClass -Parameter Sets: (All) -Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow, invalid - -Required: False -Position: 12 -Default value: Sitecost-normal -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a root target of the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: PriorityRank, Rank - -Required: False -Position: 13 -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace root. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder that is offline. -If you set a namespace root to a value of Offline, the entire namespace becomes inaccessible. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 8 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for a root target of the DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: NamespaceRootTarget - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetState -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder target that is Offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 11 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to root targets for this length of time. -The default TTL interval for root referrals is 300 seconds. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: ttl, TimeToLive - -Required: False -Position: 9 -Default value: 300 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Type -Specifies the type of a DFS namespace as a Type object. -The acceptable values for this parameter are: - -- Standalone. -Specifies a stand-alone namespace. -- DomainV1. -Specifies a Windows 2000 Server mode domain namespace. -- DomainV2. -Specifies a Windows Server 2008 mode domain namespace. - -```yaml -Type: Type -Parameter Sets: (All) -Aliases: -Accepted values: Standalone, DomainV1, DomainV2 - -Required: True -Position: 1 -Default value: Domain-v2 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespace - -## NOTES - -## RELATED LINKS - -[Get-DfsnRoot](./Get-DfsnRoot.md) - -[Remove-DfsnRoot](./Remove-DfsnRoot.md) - -[Set-DfsnRoot](./Set-DfsnRoot.md) - diff --git a/docset/winserver2012-ps/dfsn/New-DfsnRootTarget.md b/docset/winserver2012-ps/dfsn/New-DfsnRootTarget.md deleted file mode 100644 index 7a3519cf70..0000000000 --- a/docset/winserver2012-ps/dfsn/New-DfsnRootTarget.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: DfsNamespaceRootTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/new-dfsnroottarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DfsnRootTarget - -## SYNOPSIS -Adds a root target to a DFS namespace. - -## SYNTAX - -``` -New-DfsnRootTarget [-Path ] [-TargetPath] [[-State] ] - [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **New-DfsnRootTarget** cmdlet adds a root target to a Distributed File System (DFS) namespace. -Specify the DFS namespace root folder and the new root folder target. -You can set the state of the DFS namespace target and configure priority class and priority rank for referrals. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Add a DFS namespace root target -``` -PS C:\> New-DfsnRootTarget -Path "\\Contoso\Software" -TargetPath "\\Contoso-FS04\Software" -``` - -This command adds a new DFS namespace root target, \\\\Contoso-FS04\Software, to the namespace that has the root path \\\\Contoso\Software. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root of a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, NamespaceRoot - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityClass -Specifies the target priority class for a DFS namespace root. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. - -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. - -```yaml -Type: ReferralPriorityClass -Parameter Sets: (All) -Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow, invalid - -Required: False -Position: 2 -Default value: Sitecost-normal -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a root target of the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: PriorityRank, Rank - -Required: False -Position: 3 -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder target that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 1 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for a root target of the DFS namespace. -This cmdlet adds the folder that the path specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, RootTargetPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceRootTarget - -## NOTES - -## RELATED LINKS - -[Get-DfsnRootTarget](./Get-DfsnRootTarget.md) - -[Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) - -[Set-DfsnRootTarget](./Set-DfsnRootTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/Remove-DfsnAccess.md b/docset/winserver2012-ps/dfsn/Remove-DfsnAccess.md deleted file mode 100644 index 18f8702e74..0000000000 --- a/docset/winserver2012-ps/dfsn/Remove-DfsnAccess.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: DfsNamespaceAccess.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/remove-dfsnaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DfsnAccess - -## SYNOPSIS -Removes users and groups from the ACL for a folder in a DFS namespace. - -## SYNTAX - -``` -Remove-DfsnAccess [-Path] [-AccountName] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-DfsnAccess** cmdlet removes users and groups from the access control list (ACL) for a Distributed File System (DFS) namespace folder. -When you remove a user from an ACL, the current permissions in the ACL may still allow that user to access the folder. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Remove a user from the ACL for a folder -``` -PS C:\> Remove-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "Western\SarahJones" -``` - -This command removes the user Western\SarahJones from the access control list of \\\\Contoso\Software\Projects. - -## PARAMETERS - -### -AccountName -Specifies an array of user and group accounts. -This cmdlet removes the accounts specified from the ACL of a DFS namespace folder. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Account, User - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for a DFS namespace folder. -This cmdlet removes user accounts or group accounts from the ACL of the folder specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DfsnAccess](./Get-DfsnAccess.md) - -[Grant-DfsnAccess](./Grant-DfsnAccess.md) - -[Revoke-DfsnAccess](./Revoke-DfsnAccess.md) - diff --git a/docset/winserver2012-ps/dfsn/Remove-DfsnFolder.md b/docset/winserver2012-ps/dfsn/Remove-DfsnFolder.md deleted file mode 100644 index 70a1660ebb..0000000000 --- a/docset/winserver2012-ps/dfsn/Remove-DfsnFolder.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: DfsNamespaceFolder.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/remove-dfsnfolder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DfsnFolder - -## SYNOPSIS -Removes a DFS namespace folder. - -## SYNTAX - -``` -Remove-DfsnFolder [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-DfsnFolder** cmdlet removes a Distributed File System (DFS) namespace folder. -When you remove a folder, this cmdlet deletes all the folder targets for the folder. -This cmdlet does not delete the folders specified by DFS namespace targets or the files in those folders. - -If you remove the last folder within a parent directory, the cmdlet removes the parent folder as well, unless it is the DFS namespace root. -To remove a DFS namespace root, use the Remove-DfsnRoot cmdlet. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Remove a DFS namespace folder -``` -PS C:\> Remove-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -``` - -This command removes the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a DFS namespace folder without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path for a DFS namespace folder. -This cmdlet removes the folder that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolder](./Get-DfsnFolder.md) - -[Move-DfsnFolder](./Move-DfsnFolder.md) - -[New-DfsnFolder](./New-DfsnFolder.md) - -[Set-DfsnFolder](./Set-DfsnFolder.md) - -[Remove-DfsnRoot](./Remove-DfsnRoot.md) - diff --git a/docset/winserver2012-ps/dfsn/Remove-DfsnFolderTarget.md b/docset/winserver2012-ps/dfsn/Remove-DfsnFolderTarget.md deleted file mode 100644 index 3d5eb9fbcd..0000000000 --- a/docset/winserver2012-ps/dfsn/Remove-DfsnFolderTarget.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: DfsNamespaceFolderTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/remove-dfsnfoldertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DfsnFolderTarget - -## SYNOPSIS -Removes a target for a DFS namespace folder. - -## SYNTAX - -``` -Remove-DfsnFolderTarget [-Path] [-TargetPath] [-Force] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-DfsnFolderTarget** cmdlet removes a target for a Distributed File System (DFS) namespace folder. -A folder target is the Universal Naming Convention (UNC) path of a shared folder or another namespace associated with a folder in a namespace. -The folder target is where data and content is stored. -This cmdlet deletes a target, but does not delete the contents of the folder target. - -A DFS namespace folder can have more than one target. -If you remove the last target associated with a DFS namespace folder, this cmdlet deletes the namespace folder as well. -Users cannot use the DFS namespace folder after you delete it. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Remove a target folderfolder targetfolder target -``` -PS C:\> Remove-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" -``` - -This command removes the target \\\\Contoso-FS\LegacySoftware for the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a DFS namespace without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path for the DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for the folder target. -This cmdlet removes the folder target that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, FolderTarget - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolderTarget](./Get-DfsnFolderTarget.md) - -[New-DfsnFolderTarget](./New-DfsnFolderTarget.md) - -[Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/Remove-DfsnRoot.md b/docset/winserver2012-ps/dfsn/Remove-DfsnRoot.md deleted file mode 100644 index 42690fd38b..0000000000 --- a/docset/winserver2012-ps/dfsn/Remove-DfsnRoot.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: DfsNamespace.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/remove-dfsnroot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DfsnRoot - -## SYNOPSIS -Removes a DFS namespace. - -## SYNTAX - -``` -Remove-DfsnRoot [-Path] [-Force] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-DfsnRoot** cmdlet removes a Distributed File System (DFS) namespace. -When you remove a namespace, you remove all the folders in the namespace. -Users cannot use the DFS namespace folders after you remove the namespace. -This cmdlet does not delete the folders specified by DFS namespace targets or the files in those folders. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Remove a DFS namespace -``` -PS C:\> Remove-DfsnRoot -Path "\\Contoso\AccountingResources" -Confirm - -Performing operation "Delete DFS Namespace" on Target "\\Contoso\AccountingResources" - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): -``` - -This command removes the DFS namespace that has the path \\\\Contoso\AccountingResources. -The command does not include the **Force** parameter, so you must confirm the operation. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a DFS namespace without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path for the root of a DFS namespace. -This cmdlet removes the namespace that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RootPath, root, namespace, NamespaceRoot - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DfsnRoot](./Get-DfsnRoot.md) - -[New-DfsnRoot](./New-DfsnRoot.md) - -[Set-DfsnRoot](./Set-DfsnRoot.md) - diff --git a/docset/winserver2012-ps/dfsn/Remove-DfsnRootTarget.md b/docset/winserver2012-ps/dfsn/Remove-DfsnRootTarget.md deleted file mode 100644 index c7f01062d5..0000000000 --- a/docset/winserver2012-ps/dfsn/Remove-DfsnRootTarget.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: DfsNamespaceRootTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/remove-dfsnroottarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DfsnRootTarget - -## SYNOPSIS -Removes a target for a DFS namespace root. - -## SYNTAX - -``` -Remove-DfsnRootTarget [-Path ] [-TargetPath] [-Cleanup] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-DfsnRootTarget** cmdlet removes a target for a Distributed File System (DFS) namespace root. -A folder target is the Universal Naming Convention (UNC) path of a shared folder or another namespace associated with a folder in a namespace. -The folder target is where data and content is stored. -This cmdlet deletes a target, but does not delete the contents of the folder target. - -A DFS namespace root can have more than one root target. -If you remove the last root target associated with a DFS namespace root, this cmdlet deletes the namespace as well. -Users cannot use the DFS namespace path after you delete the namespace. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Remove a root target -``` -PS C:\> Remove-DfsnRootTarget -TargetPath "\\Contoso-FS\AccountingSoftware" -Path "\\Contoso\AccountingSoftware" -``` - -This command removes the DFS root target path \\\\Contoso-FS\AccountingSoftware from the DFS namespace that has the path \\\\Contoso\AccountingSoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cleanup -Indicates that the cmdlet attempts to force a clean-up of the root target in Active Directory Domain Services (AD DS). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path for the root of a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, NamespaceRoot - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for the folder target. -This cmdlet removes the folder target that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, RootTargetPath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DfsnRootTarget](./Get-DfsnRootTarget.md) - -[New-DfsnRootTarget](./New-DfsnRootTarget.md) - -[Set-DfsnRootTarget](./Set-DfsnRootTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/Revoke-DfsnAccess.md b/docset/winserver2012-ps/dfsn/Revoke-DfsnAccess.md deleted file mode 100644 index 84d8d77980..0000000000 --- a/docset/winserver2012-ps/dfsn/Revoke-DfsnAccess.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: DfsNamespaceAccess.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/revoke-dfsnaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Revoke-DfsnAccess - -## SYNOPSIS -Revokes permissions for users to access and enumerate the contents of a DFS namespace folder. - -## SYNTAX - -``` -Revoke-DfsnAccess [-Path] [-AccountName] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Revoke-DfsnAccess** cmdlet revokes permissions for users and groups to access and enumerate the contents of a Distributed File System (DFS) namespace folder. -You can use the Get-DfsnAccess cmdlet to see the current permissions, and you can use the Grant-DfsnAccess cmdlet to grant permissions. - -For a DFS namespace which has Access-based Enumeration enabled, users can see only the folders that they can access. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Revoke permissions for a user -``` -PS C:\> Revoke-DfsnAccess -Path "\\Contoso\Software\Projects" -AccountName "Western\SarahJones" -``` - -This command revokes permissions to access and view the contents of the DFS namespace folder \\\\Contoso\Software\Projects for a specified user. - -## PARAMETERS - -### -AccountName -Specifies an array of user and group accounts. -This cmdlet revokes permissions for the accounts specified. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Account, User - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for a DFS namespace folder. -This cmdlet revokes permissions for the folder specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceAccess - -## NOTES - -## RELATED LINKS - -[Get-DfsnAccess](./Get-DfsnAccess.md) - -[Grant-DfsnAccess](./Grant-DfsnAccess.md) - -[Remove-DfsnAccess](./Remove-DfsnAccess.md) - diff --git a/docset/winserver2012-ps/dfsn/Set-DfsnFolder.md b/docset/winserver2012-ps/dfsn/Set-DfsnFolder.md deleted file mode 100644 index 6987e54132..0000000000 --- a/docset/winserver2012-ps/dfsn/Set-DfsnFolder.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: DfsNamespaceFolder.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/set-dfsnfolder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DfsnFolder - -## SYNOPSIS -Changes settings for a DFS namespace folder. - -## SYNTAX - -``` -Set-DfsnFolder [-Path] [[-EnableInsiteReferrals] ] [[-EnableTargetFailback] ] - [[-State] ] [[-TimeToLiveSec] ] [[-Description] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DfsnFolder** cmdlet changes settings for a Distributed File System (DFS) namespace folder. - -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. - -You can use this cmdlet to enable or disable the following settings: - -- In-site referrals. -- Target failback. - -You can also add or change a descriptive comment, change the state of the DFS namespace, or set the Time to Live (TTL) interval for referrals. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Enable settings for a DFS namespace folder -``` -PS C:\> Set-DfsnFolder -Path "\\Contoso\AccountingResources\LegacySoftware" -EnableInsiteReferrals $True -EnableTargetFailback $True -``` - -This command enables in-site referrals and target failback for the DFS namespace folder \\\\Contoso\AccountingResources\LegacySoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: desc - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, a DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: insite - -Required: False -Position: 1 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access target link on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to use the preferred server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: failback, TargetFailback - -Required: False -Position: 2 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the DFS namespace folder. -This cmdlet modifies the folder that has the path specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace folder. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 3 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to targets for this length of time. -The default TTL interval for folder referrals is 1800 seconds (30 minutes). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: ttl, TimeToLive - -Required: False -Position: 4 -Default value: 300 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolder - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolder](./Get-DfsnFolder.md) - -[Move-DfsnFolder](./Move-DfsnFolder.md) - -[New-DfsnFolder](./New-DfsnFolder.md) - -[Remove-DfsnFolder](./Remove-DfsnFolder.md) - diff --git a/docset/winserver2012-ps/dfsn/Set-DfsnFolderTarget.md b/docset/winserver2012-ps/dfsn/Set-DfsnFolderTarget.md deleted file mode 100644 index ee3db95adb..0000000000 --- a/docset/winserver2012-ps/dfsn/Set-DfsnFolderTarget.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -external help file: DfsNamespaceFolderTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/set-dfsnfoldertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DfsnFolderTarget - -## SYNOPSIS -Changes settings for a target of a DFS namespace folder. - -## SYNTAX - -``` -Set-DfsnFolderTarget [-Path] [-TargetPath] [[-State] ] - [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DfsnRootTarget** cmdlet changes settings for a target of a Distributed File System (DFS) namespace folder. -You can change the state of the DFS namespace target and configure priority class and priority rank for referrals. - -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Change the state for a folder target -``` -PS C:\> Set-DfsnFolderTarget -Path "\\Contoso\AccountingResources\LegacySoftware" -TargetPath "\\Contoso-FS\LegacySoftware" -State Online -``` - -This command changes the state for a target for the folder \\\\Contoso\AccountingResources\LegacySoftware to Online. -The folder target is \\\\Contoso-FS\LegacySoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the DFS namespace folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, FolderPath, NamespacePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityClass -Specifies the priority class for a DFS namespace folder target. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh: The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh: The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal: The middle or normal site cost priority class for a DFS target. - -- SiteCostLow: The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow: The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. - -```yaml -Type: ReferralPriorityClass -Parameter Sets: (All) -Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow, invalid - -Required: False -Position: 3 -Default value: Sitecost-normal -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a target of the DFS namespace folder. -Lower values have greater preference. -A value of zero (0) is the greatest preference. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: PriorityRank, Rank - -Required: False -Position: 4 -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace folder target. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace target that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 2 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for a target of the DFS namespace folder. -This cmdlet changes settings for the target that the path specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, FolderTarget - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceFolderTarget - -## NOTES - -## RELATED LINKS - -[Get-DfsnFolderTarget](./Get-DfsnFolderTarget.md) - -[New-DfsnFolderTarget](./New-DfsnFolderTarget.md) - -[Remove-DfsnFolderTarget](./Remove-DfsnFolderTarget.md) - -[Set-DfsnFolderTarget](./Set-DfsnFolderTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/Set-DfsnRoot.md b/docset/winserver2012-ps/dfsn/Set-DfsnRoot.md deleted file mode 100644 index 4b8aae64a2..0000000000 --- a/docset/winserver2012-ps/dfsn/Set-DfsnRoot.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -external help file: DfsNamespace.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/set-dfsnroot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DfsnRoot - -## SYNOPSIS -Changes settings for a DFS namespace. - -## SYNTAX - -``` -Set-DfsnRoot [-Path] [[-EnableSiteCosting] ] [[-EnableInsiteReferrals] ] - [[-EnableAccessBasedEnumeration] ] [[-EnableRootScalability] ] - [[-EnableTargetFailback] ] [[-Description] ] [[-State] ] [[-TimeToLiveSec] ] - [[-GrantAdminAccounts] ] [[-RevokeAdminAccounts] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DfsnRoot** cmdlet changes settings for a Distributed File System (DFS) namespace. - -You can use this cmdlet to enable or disable the following settings: - -- Site costing. -- In-site referrals. -- Access-based enumeration. -- Root scalability. -- Target failback. - -You can also add or change a descriptive comment, change the state of the DFS namespace, or set the Time to Live (TTL) interval for referrals. - -To manage the DFS namespace, you can use this cmdlet to grant or revoke permissions to users or user groups. -Users who have these permissions can add, remove, and modify namespace folders and folder targets for the DFS namespace. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Change root scalability and TTL -``` -PS C:\> Set-DfsnRoot -Path "\\Contoso\AccountingResources" -EnableRootScalability $True -TimeToLiveSec 900 -``` - -This command modifies settings for the DFS namespace that has the path \\\\Contoso\AccountingResources. -The command enables root scalability, which allows the DFS namespace server to poll domain controllers for updates. -The command also sets the referral TTL interval to 900 seconds. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: desc - -Required: False -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableAccessBasedEnumeration -Indicates whether a DFS namespace uses Access-based enumeration. -If this value is $True, a DFS namespace server shows a user only the files and folders that the user can access. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: abe, abde - -Required: False -Position: 3 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableInsiteReferrals -Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client. -If this value is $True, a DFS namespace server provides only in-site referrals. -If this value is $False, the DFS namespace server provides in-site referrals first, then other referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: insite - -Required: False -Position: 2 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableRootScalability -Indicates whether a DFS namespace uses root scalability mode. -If this value is $True, DFS namespace servers connect to the nearest domain controllers for periodic namespace updates. -If this value is $False, the servers connect to the primary domain controller (PDC) emulator. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: RootScalability, rootscale - -Required: False -Position: 4 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableSiteCosting -Indicates whether a DFS namespace uses cost-based selection. -If a client cannot access a folder target in-site, a DFS namespace server selects the least resource-intensive alternative. -If you provide a value of $True for this parameter, the DFS namespace favors high-speed links over wide area network (WAN) links. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: SiteCosting, sitecost - -Required: False -Position: 1 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableTargetFailback -Indicates whether a DFS namespace uses target failback. -If a client attempts to access target link on a server and that server is not available, the client fails over to another referral. -If this value is $True, once the first server becomes available again, the client fails back to the first server. -If this value is $False, the DFS namespace server does not require the client to fail back to the preferred server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: failback, TargetFailback - -Required: False -Position: 5 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GrantAdminAccounts -Specifies an array of accounts. -This cmdlet grants management permissions the users and user groups specified for the DFS namespace. -Users can add, remove, and modify namespace folders and folder targets. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: GrantAdmin, GrantAdminAccess - -Required: False -Position: 9 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root of a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: RootPath, root, namespace, NamespaceRoot - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RevokeAdminAccounts -Specifies an array of accounts. -This cmdlet removes management permissions for the users and user groups specified for the DFS namespace. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: RevokeAdmin, RevokeAdminAccess - -Required: False -Position: 10 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace root. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace folder that is offline. -If you set a namespace root to a value of Offline, the entire namespace becomes inaccessible. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 7 -Default value: ONLINE -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLiveSec -Specifies a TTL interval, in seconds, for referrals. -Clients store referrals to root targets for this length of time. -The default TTL interval for root referrals is 300 seconds. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: ttl, TimeToLive - -Required: False -Position: 8 -Default value: 300 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespace - -## NOTES - -## RELATED LINKS - -[Get-DfsnRoot](./Get-DfsnRoot.md) - -[New-DfsnRoot](./New-DfsnRoot.md) - -[Remove-DfsnRoot](./Remove-DfsnRoot.md) - diff --git a/docset/winserver2012-ps/dfsn/Set-DfsnRootTarget.md b/docset/winserver2012-ps/dfsn/Set-DfsnRootTarget.md deleted file mode 100644 index e31cd37157..0000000000 --- a/docset/winserver2012-ps/dfsn/Set-DfsnRootTarget.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: DfsNamespaceRootTarget.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/set-dfsnroottarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DfsnRootTarget - -## SYNOPSIS -Changes settings for a root target of a DFS namespace. - -## SYNTAX - -``` -Set-DfsnRootTarget [-Path] [-TargetPath] [[-State] ] - [[-ReferralPriorityClass] ] [[-ReferralPriorityRank] ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DfsnRootTarget** cmdlet changes settings for a root target of a Distributed File System (DFS) namespace. -You can change the state of the DFS namespace target and configure priority class and priority rank for referrals. - -A DFS namespace folder has one or more folder targets that are shared folders on computers. -When a client attempts to connect to a folder, the DFS namespace server provides a list of folder targets, called referrals. -The server determines the order for referrals and clients attempt to connect to a folder target in the order that the server provides. - -For more information about DFS namespaces, see Overview of DFS Namespaceshttp://technet.microsoft.com/library/cc730736 (http://technet.microsoft.com/library/cc730736) on TechNet. - -## EXAMPLES - -### Example 1: Set a referral priority value -``` -PS C:\> Set-DfsnRootTarget -Path "\\contoso.com\dfsroot" -TargetPath "\\Contoso-fs\dfsroot" -ReferralPriorityClass GlobalLow -``` - -This command sets the referral priority class to a value of GlobalLow for the DFS namespace root target that has the path \\\\Contoso\AccountingSoftware and the target path \\\\Contoso-FS\AccountingSoftware. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a path for the root of a DFS namespace. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DfsPath, NamespaceRoot - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityClass -Specifies the priority class for a DFS namespace root target. -Target priority offers you the ability to classify and rank in-site targets. -You can specify targets to receive the highest or lowest preference, and you can divide the remaining targets based on their site cost for a DFS client to connect to them. -The acceptable values for this parameter are: - -- GlobalHigh. -The highest priority class for a DFS target. -Targets assigned this class receive global preference. -- SiteCostHigh. -The highest site cost priority class for a DFS target. -Targets assigned this class receive the most preference among targets of the same site cost for a given DFS client. -- SiteCostNormal. -The middle or normal site cost priority class for a DFS target. - -- SiteCostLow. -The lowest site cost priority class for a DFS target. -Targets assigned this class receive the least preference among targets of the same site cost for a given DFS client. -- GlobalLow. -The lowest level of priority class for a DFS target. -Targets assigned this class receive the least preference globally. - -```yaml -Type: ReferralPriorityClass -Parameter Sets: (All) -Aliases: PriorityClass, Class -Accepted values: sitecostnormal, globalhigh, sitecosthigh, sitecostlow, globallow, invalid - -Required: False -Position: 3 -Default value: Sitecost-normal -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReferralPriorityRank -Specifies the priority rank, as an integer, for a root target of the DFS namespace. -Lower values have greater preference. -A value of zero (0) is the greatest preference. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: PriorityRank, Rank - -Required: False -Position: 4 -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the DFS namespace root target. -The acceptable values for this parameter are: - -- Online -- Offline - -Clients do not receive referrals for a DFS namespace target that is offline. - -```yaml -Type: State -Parameter Sets: (All) -Aliases: -Accepted values: Offline, Online - -Required: False -Position: 2 -Default value: OK -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPath -Specifies a path for a root target of the DFS namespace. -This cmdlet changes settings for the root target that the path specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Target, DfsTarget, RootTargetPath - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceRootTarget - -## NOTES - -## RELATED LINKS - -[Get-DfsnRootTarget](./Get-DfsnRootTarget.md) - -[New-DfsnRootTarget](./New-DfsnRootTarget.md) - -[Remove-DfsnRootTarget](./Remove-DfsnRootTarget.md) - diff --git a/docset/winserver2012-ps/dfsn/Set-DfsnServerConfiguration.md b/docset/winserver2012-ps/dfsn/Set-DfsnServerConfiguration.md deleted file mode 100644 index 862669c518..0000000000 --- a/docset/winserver2012-ps/dfsn/Set-DfsnServerConfiguration.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: DfsNamespaceServerConfig.cdxml-help.xml -Module Name: DFSN -online version: https://learn.microsoft.com/powershell/module/dfsn/set-dfsnserverconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DfsnServerConfiguration - -## SYNOPSIS -Changes settings for a DFS namespace root server. - -## SYNTAX - -``` -Set-DfsnServerConfiguration [-ComputerName] [[-SyncIntervalSec] ] - [[-EnableSiteCostedReferrals] ] [[-EnableInsiteReferrals] ] [[-LdapTimeoutSec] ] - [[-PreferLogonDC] ] [[-UseFqdn] ] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DfsnServerConfiguration** cmdlet changes settings for a Distributed File System (DFS) namespace root server. -A DFS namespace root server hosts one or more namespace root targets. - -You can use this cmdlet to enable in-site referrals or to use cost in organizing referrals for targets in a site. -You can also change the synchronization interval for servers that connect to a primary domain controller (PDC) emulator and change the Lightweight Directory Access Protocol (LDAP) time-out. -You can specify whether referrals prefer the logon domain controller. -You can also specify whether the server provides referrals as fully qualified domain names (FQDN) or NETBios names. - -To see current values for these settings, use the Get-DfsnServerConfiguration cmdlet. - -## EXAMPLES - -### Example 1: Set LDAP time-out for a DFS namespace server -``` -PS C:\> Set-DfsnServerConfiguration -ComputerName "localhost" -LdapTimeoutSec 60 -``` - -This command sets an LDAP time-out value of 60 seconds for the local computer, which is a DFS namespace server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the host name or FQDN for the DFS namespace server for which the cmdlet modifies settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Server, name, NamespaceServer - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableInsiteReferrals -Indicates whether this server provides only in-site referrals. -If you assign a value of $True, the server returns only referrals for targets in the same site as the client. -If you assign a value of $False, the server returns in-site referrals and other referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: insite - -Required: False -Position: 3 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableSiteCostedReferrals -Indicates whether the server can use cost-based selection. -If you specify a value of $True, the DFS namespace server provides referrals for folder targets to clients in the following order: - -- Folder targets in the same site as a client, in random order. -- Folder targets for which the DFS namespace server has information. -The referrals for the nearest site are first, in random order, followed by the next nearest site, in random order. -- Targets for which DFS namespace server has no site information, in random order. - -If you specify a value of $False, the DFS namespace server provides referrals for folder targets to clients in the following order: - -- Folder targets in the same site as the client, in random order. -- Other folder targets, in random order. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: Sitecosted, SiteCostedReferrals - -Required: False -Position: 2 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LdapTimeoutSec -Specifies a time-out value, in seconds, for Lightweight Directory Access Protocol (LDAP) requests for the DFS namespace server. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: LdapTimeout - -Required: False -Position: 4 -Default value: 30 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreferLogonDC -Indicates whether to prefer the logon domain controller in referrals. -If you specify a value of $True for this parameter, the DFS namespace server places referrals to the computer that hosts the logon domain controller at the top of the list of referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SyncIntervalSec -Specifies an interval, in seconds. -This interval controls how often domain-based DFS namespace root servers and domain controllers connect to the PDC emulator to get updates of DFS namespace metadata. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: SyncInterval - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseFqdn -Indicates whether a DFS namespace server uses FQDNs in referrals. -If this parameter has a value of $True, the server uses FQDNs in referrals. -If this parameter has a value of $False, the server uses NetBIOS names. -The default for DFS namespace servers is to use NetBIOS names in referrals. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: Fqdn, dfsdnsconfig, UseFullyQualifiedDomainNames - -Required: False -Position: 6 -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DfsNamespaceServerConfig - -## NOTES - -## RELATED LINKS - -[Get-DfsnServerConfiguration](./Get-DfsnServerConfiguration.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerInDC.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerInDC.md deleted file mode 100644 index 9c5a121755..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerInDC.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverindc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerInDC - -## SYNOPSIS -Adds the computer running the DHCP server service to the list of authorized Dynamic Host Configuration Protocol (DHCP) server services in Active Directory (AD). - -## SYNTAX - -``` -Add-DhcpServerInDC [[-DnsName] ] [[-IPAddress] ] [-AsJob] [-CimSession ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerInDC** cmdlet adds the computer running the DHCP server service to the list of authorized Dynamic Host Configuration Protocol (DHCP) server services in the Active Directory (AD). -A DHCP server service running on a domain joined computer needs to be authorized in AD so that it can start leasing IP addresses on the network. - -If neither the **DnsName** nor the **IPAddress** parameter is specified, the local server will be added in the AD. - -If only the **DnsName** parameter is specified, the specified Domain Name System (DNS) name will be added in AD. - -In both these cases, any of the IP addresses of the computer running the DHCP server service being added into the domain controller are added as part of the server object in AD. - -If the **DnsName** and the **IPAddress** parameter are specified, the object will be added to domain controller with specified values. - -In addition to adding the computer running the DHCP server service in DC, this cmdlet also triggers the DHCP server service to perform an authorization check. - -The trigger for authorization check will be done even if the addition of computer running the DHCP server service fails with an object already exists error. - -The following warning will be displayed if the computer running the DHCP server service is already authorized and the trigger for the server authorization check succeeded: - - - `The DHCP server is already authorized in Active Directory. -The authorization check on the DHCP server has been initiated.` - -The following warning will be displayed if the computer running the DHCP server service is already authorized, but the trigger for the server authorization check failed: - - - `The DHCP server is already authorized in Active Directory. -Failed to initiate the authorization check on the DHCP server. -Error code: %d` - -The following warning will be displayed if the addition of the computer running the DHCP server service in AD succeeded, but the trigger for the server authorization check failed: - - - `The DHCP server has been successfully authorized in Active Directory. -Failed to initiate the authorization check on the DHCP server. -Error code: %d` - -If the addition of computer running the DHCP server service to AD fails with an error other than object_already_exists_error, then an error is returned and authorization check on the server is not triggered. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerInDC -DnsName dhcpserver.contoso.com -IPAddress 10.10.10.2 -``` - -This example adds an object in the AD domain for the DHCP server service running on the computer with the DNS name dhcpserver.contoso.com and the IP address 10.10.10.2, and authorizes the DHCP server service to serve DHCP clients on the network. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerInDC -DnsName dhcpserver.contoso.com -``` - -This example adds an object in the AD domain for the DHCP server service running on the computer with the DNS name dhcpserver.contoso.com, and authorizes the DHCP server service to serve DHCP clients on the network. -The IP address for the DHCP server service object in AD will be obtained by looking up dhcpserver.contoso.com in DNS. - -### EXAMPLE 3 -``` -PS C:\>Add-DhcpServerInDC -``` - -This example adds an object in the AD domain for the DHCP server service running on the local computer. -The IP address for the computer running the DHCP server service in AD will be obtained by looking up the hostname of the local computer in DNS. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsName -Specifies the DNS name of the computer running the DHCP server service to be added to the list of authorized DHCP server services in AD. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IP address of the computer running the DHCP server service which is added to the list of authorized DHCP server services in AD. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerInDC -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerInDC -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerInDC](./Get-DhcpServerInDC.md) - -[Remove-DhcpServerInDC](./Remove-DhcpServerInDC.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Class.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Class.md deleted file mode 100644 index e64b8b9974..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Class.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Class - -## SYNOPSIS -Adds an IPv4 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv4Class [-Name] [-Type] [-Data] [-AsJob] [-CimSession ] - [-ComputerName ] [-Description ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServer4Class** cmdlet adds an IPv4 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-DhcpServerv4Class -Name "User Class for Lab Computers" -Type User -Data "LabComputers" -``` - -This example adds a DHCPv4 user class for lab computers on the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\> Add-DhcpServerv4Class -Name "MSUCClient" -Type Vendor -Data "MS-UC-Client" -``` - -This example adds a DHCPv4 vendor class for Microsoft Unified Communication clients on the DHCP server service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Data -Specifies data for the vendor or user class. -This is the value expected in the request from the DHCP client which belongs to this vendor or user class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description string for the class being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the vendor or user class being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class. -The acceptable values for this parameter are: Vendor and User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4Class](./Get-DhcpServerv4Class.md) - -[Remove-DhcpServerv4Class](./Remove-DhcpServerv4Class.md) - -[Set-DhcpServerv4Class](./Set-DhcpServerv4Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4ExclusionRange.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4ExclusionRange.md deleted file mode 100644 index a43d6c0b9e..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4ExclusionRange.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4exclusionrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4ExclusionRange - -## SYNOPSIS -Adds a range of excluded IP addresses for an IPv4 scope. - -## SYNTAX - -``` -Add-DhcpServerv4ExclusionRange [-ScopeId] [-StartRange] [-EndRange] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4ExclusionRange** cmdlet adds a range of excluded IP addresses for an IPv4 scope. -The excluded IP addresses are not leased out by the Dynamic Host Configuration Protocol (DHCP) server service to any DHCP client. -The only exception to this is reservation. -If an IP address is reserved, then the same IP address will be leased to the designated client even if it falls within the exclusion range. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-Dhcpserverv4ExclusionRange -ScopeId 10.1.1.0 -StartRange 10.1.1.1 -EndRange 10.1.1.10 -``` - -This example adds excludes the IP address range from 10.1.1.1 through 10.1.1.10 from the scope 10.1.1.0 on the DHCP server service running on the local computer. - -### EXAMPLE 2 -``` -PS C:\>Add-Dhcpserverv4ExclusionRange -ComputerName dhcpserver.contoso.com -ScopeId 20.1.1.0 -StartRange 20.1.1.1 -EndRange 20.1.1.1 -``` - -This example excludes the IP address 20.1.1.1 from the scope 20.1.1.0 on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRange -The end IP address of the range being excluded. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the identifier (ID) of the IPv4 scope from which the IP addresses are being excluded. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IP address of the range being excluded. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ExclusionRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ExclusionRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4ExclusionRange](./Get-DhcpServerv4ExclusionRange.md) - -[Remove-DhcpServerv4ExclusionRange](./Remove-DhcpServerv4ExclusionRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Failover.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Failover.md deleted file mode 100644 index 662dcc0254..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Failover.md +++ /dev/null @@ -1,410 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4failover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Failover - -## SYNOPSIS -Adds a new IPv4 failover relationship on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DhcpServerv4Failover [-Name] [-ScopeId] [-PartnerServer] [-AsJob] - [-AutoStateTransition ] [-CimSession ] [-ComputerName ] [-Force] - [-LoadBalancePercent ] [-MaxClientLeadTime ] [-PassThru] [-SharedSecret ] - [-StateSwitchInterval ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DhcpServerv4Failover [-Name] [-ScopeId] [-PartnerServer] [-AsJob] - [-AutoStateTransition ] [-CimSession ] [-ComputerName ] [-Force] - [-MaxClientLeadTime ] [-PassThru] [-ReservePercent ] [-ServerRole ] - [-SharedSecret ] [-StateSwitchInterval ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Failover** cmdlet adds a new IPv4 failover relationship to a Dynamic Host Configuration Protocol (DHCP) server service. -The first parameter set adds a failover relationship with load balance mode. -The second parameter set adds the failover relationship in hot-standby mode. - -This cmdlet creates the failover relationship on both of the DHCP server services with the specified parameters. -The **ScopeId** parameter value specified on the source DHCP server service, or local computer running the DHCP server service is identically setup on the partner DHCP server service. - -If the **SharedSecret** parameter is specified, message digest authentication will be automatically turned on for the newly created failover relationship. - -By default, user confirmation will be sought if the **SharedSecret** parameter is specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -SharedSecret "sEcReT" -``` - -This example creates a load balance, or active-active, failover relationship between the DHCP server services running on the computers named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. -These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. -Message authentication is enabled for the server-to-server message exchange with the specified shared secret. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ServerRole Standby -ScopeId 10.10.10.0,20.20.20.0 -``` - -This example creates a hot standby, or active-passive, failover relationship between the DHCP server services running on the computers named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. -These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. -The DHCP server service running on the computer named dhcpserver.contoso.com will be the standby DHCP server service and the DHCP server service running on the computer named dhcpserver2.contoso.com will be the active DHCP server service in the failover relationship. - -### EXAMPLE 3 -``` -PS C:\>Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -LoadBalancePercent 70 -MaxClientLeadTime 2:00:00 -AutoStateTransition $true -StateSwitchInterval 2:00:00 -``` - -This example creates a load balance, or active-active, failover relationship between the DHCP server services running on the computer named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. -These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. -70% of the client requests will be served by DHCP server service running on the computer named dhcpserver.contoso.com and 30% by the DHCP server service running on the computer named dhcpserver2.contoso.com. -The maximum client lead time for the failover relationship is set to 2 hours. -The automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state is turned on and the timer for automatic state transition is set to 2 hours. - -### EXAMPLE 4 -``` -PS C:\>Add-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -PartnerServer dhcpserver2.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -ReservePercent 10 -MaxClientLeadTime 2:00:00 -AutoStateTransition $true -StateSwitchInterval 2:00:00 -``` - -This example creates a hot standby, or Active-Passive, failover relationship between the DHCP server service running on the computer named dhcpserver.contoso.com and dhcpserver2.contoso.com with the scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service running on the computer named dhcpserver.contoso.com added to the failover relationship. -These scopes will be created on the partner DHCP server service running on the computer named dhcpserver2.contoso.com as part of the failover relationship creation. -The DHCP server service running on the computer named dhcpserver2.contoso.com will be standby DHCP server service and the DHCP server service running on the computer named dhcpserver.contoso.com will be the active DHCP server service in the failover relationship. -10% of the free IP addresses in the scopes will be reserved for the standby DHCP server service. -The maximum client lead time for the failover relationship is set to 2 hours. -The automatic state transition from the COMMUNICATED INTERUPTED state to the PARTNER DOWN state is turned on and the timer for automatic state transition is set to 2 hours. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoStateTransition -Specifies the enabled state for automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state based on expiration of the timer, using the **StateSwitchInterval** parameter, while in the COMMUNICATION INTERRUPTED state. -The acceptable values for this parameter are: True or False. -The default value is False. - -If the **StateSwitchInterval** parameter is specified, then this parameter is automatically set to True. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that, if the **SharedSecret** parameter is specified, the user confirmation is required since the **SharedSecret** parameter value may be transferred in plain text transport in the case of remote management. -Specifying this parameter turns off the user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancePercent -Specifies the percentage of DHCP client requests which should be served by the local DHCP server service or the DHCP server service running on the computer specified in the **ComputerName** parameter. -The remaining requests would be served by the partner DHCP server service. - -The default value is 50%. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxClientLeadTime -Specifies the maximum client lead time for the failover relationship. -The default value is 1 hour. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the failover relationship to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerServer -Specifies the IPv4 address, or host name, of the partner DHCP server service with which the failover relationship is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservePercent -Specifies the percentage of free IPv4 addresses in the IPv4 address pool of the scope which should be reserved on the standby DHCP server service. - -In the case of a failover, the IPv4 address from this reserved pool on the standby DHCP server service will be leased to new DHCP clients. - -The default value is 5%. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifiers, in IPv4 address format, which are to be added to the failover relationship. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerRole -Specifies the role of the local DHCP server service in the hot standby mode. -The acceptable values for this parameter are: Active or Standby. - -The default value is Active for the local DHCP server service, such as the partner DHCP server service that is specified will be a standby DHCP server service. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedSecret -Specifies the shared secret to be used for message digest authentication. -If not specified, then the message digest authentication is turned off. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateSwitchInterval -Specifies the time interval for which the DHCP server service operates in the COMMUNICATION INTERRUPTED state before transitioning to the PARTNER DOWN state. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-Content](https://go.microsoft.com/fwlink/p/?LinkID=204574) - -[Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) - -[Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) - -[Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) - -[Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) - -[Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) - -[Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4FailoverScope.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4FailoverScope.md deleted file mode 100644 index 16a9a0fd04..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4FailoverScope.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4failoverscope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4FailoverScope - -## SYNOPSIS -Adds one or more specified scopes to the failover relationship. - -## SYNTAX - -``` -Add-DhcpServerv4FailoverScope [-Name] [-ScopeId] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4FailoverScope** cmdlet adds one or more specified scopes to the failover relationship. -The failover relationship to which the scope is being added and the scopes being added to it, should it exist. -The specified scopes should not exist on the partner Dynamic Host Configuration Protocol (DHCP) server service of the failover relationship. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4FailoverScope -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -ScopeId 10.10.10.0, 20.20.20.0 -``` - -This example adds the scopes 10.10.10.0 and 20.20.20.0 to the failover relationship "SFO-SIN-Failover. -The specified scopes and the failover relationship should be present on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the failover relationship to which the scopes are being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifiers (IDs), in IPv4 address format, which are to be added to the failover relationship. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-Content](https://go.microsoft.com/fwlink/p/?LinkID=204574) - -[Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) - -[Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) - -[Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) - -[Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) - -[Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) - -[Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Filter.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Filter.md deleted file mode 100644 index 5c173e3e31..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Filter.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4filter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Filter - -## SYNOPSIS -Adds a MAC address filter to the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv4Filter [-List] [-MacAddress] [-AsJob] [-CimSession ] - [-ComputerName ] [-Description ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Filter** cmdlet adds the specified MAC address filter to the Dynamic Host Configuration Protocol (DHCP) server service. -The MAC address can be added to the allow list or the deny list. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-DhcpServerv4Filter -List Allow -MacAddress F0-DE-F1-7A-00-5E -Description "Ivan's Laptop" -``` - -This example adds the specified client identified by the MAC address to the allowed list of MAC address filters. - -### Example 2 -``` -PS C:\>Add-DhcpServerv4Filter -List Allow -MacAddress F0-DE-F1-7A-00-5E, F0-DE-F1-7A-00-5C -``` - -This example adds the specified clients identified by their MAC address to the allowed list of MAC address filters. - -### Example 3 -``` -PS C:\>Import-Csv -Path MacAddressFilters.csv | Add-DhcpServerv4Filter -ComputerName dhcpserver.contoso.com -List Allow -``` - -This example adds all of the MAC address filters in the file named MacAddressFilters.csv to the allow MAC address list of the DHCP server service running on the computer named dhcpserver.contoso.com. -The Import-Csvhttp://go.microsoft.com/fwlink/p/?LinkID=113341 cmdlet returns the objects with Mac address filter fields that are piped to this cmdlet, which in turn adds the MAC address filters to the server. -The file named MacAddressFilters.csv should be in the following comma-separated values (CSV) format: - -MacAddress,Description - -1a-1b-1c-1d-1e-1f,Computer1 - -2a-2b-2c-2d-2e-2f,Computer2 - -3a-3b-3c-3d-3e-3f,Computer3 - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description string for the MAC address filter being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Specifies that, if one or more of the MAC addresses are already present in the allow or deny list, then the matching MAC addresses are deleted and the new entries created. - -This parameter is useful in the case where the MAC address specified is already present in one list, such as the allow list, and the same MAC address now needs to be added to the other list, such as the deny list. - -If this parameter is not specified, then the cmdlet will fail if the specified MAC address is already present in any of the lists. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -List -Specifies the list to which one or more MAC addresses are to be added. -The acceptable values for this parameter are: Allow or Deny. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MacAddress -Specifies one or more MAC addresses which are to be added to the MAC address filter list. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Import-Csv](https://go.microsoft.com/fwlink/p/?LinkID=113341) - -[Get-DhcpServerv4Filter](./Get-DhcpServerv4Filter.md) - -[Get-DhcpServerv4FilterList](./Get-DhcpServerv4FilterList.md) - -[Get-DhcpServerV4Lease](./Get-DhcpServerv4Lease.md) - -[Remove-DhcpServerv4Filter](./Remove-DhcpServerv4Filter.md) - -[Set-DhcpServerv4FilterList](./Set-DhcpServerv4FilterList.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Lease.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Lease.md deleted file mode 100644 index c4aaa38ff1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Lease.md +++ /dev/null @@ -1,416 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4lease?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Lease - -## SYNOPSIS -Adds a new IPv4 address lease in the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv4Lease [-ScopeId] [-IPAddress] [-ClientId] - [-AddressState ] [-AsJob] [-CimSession ] [-ClientType ] [-ComputerName ] - [-Description ] [-DnsRegistration ] [-DnsRR ] [-HostName ] - [-LeaseExpiryTime ] [-NapCapable ] [-NapStatus ] [-PassThru] [-PolicyName ] - [-ProbationEnds ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Lease** cmdlet adds a new IPv4 address lease on the Dynamic Host Configuration Protocol (DHCP) server service. -This cmdlet is only supported for DHCP server service running on Windows Server® 2012. -This cmdlet is for testing purposes only. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4Lease -IPAddress 10.10.10.11 -ScopeId 10.10.10.0 -ClientId F0-DE-F1-7A-00-5E -LeaseExpiryTime "2012-01-28 01:38:13Z" -HostName MyComputer.contoso.com -``` - -This example adds an IPv4 address lease for the IPv4 address 10.10.10.11 on the DHCP server service running on the local computer. - -## PARAMETERS - -### -AddressState -Specifies the state of the IPv4 Address lease. -The acceptable values for this parameter are: Offered, Active, Declined, Expired, or Inactive. -The default value is Active. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies the client identifier (ID) to be set on the IPv4 address lease. -Windows clients use the MAC address as the client ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientType -Specifies the type of the client. -The acceptable values for this parameter are: Unspecified, DHCP, BootP, Both, Reservation, or None. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description string to be set on the IPv4 address lease. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsRegistration -Indicates the status of the DNS registration of the lease. -The acceptable values for this parameter are: - - - Complete: For an active lease, registration of the required records , as specified by the **DnsRR** parameter value of PTR or AandPTR, is complete. - - - - For an expired lease, deletion of the required records has been done. - - - Pending: For an active lease, registration of the required records, as specified by the **DnsRR** parameter value of PTR or AandPTR, is pending. - - - - For an expired lease, deletion of the required records is pending. - - - Not applicable: When the **DnsRR** parameter is set to NoRegistration such as when no dynamic DNS registration is to be performed by the DHCP server service, this parameter is set to Not applicable. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsRR -Indicates the type of DNS record to be registered by the DHCP server service for this lease. -The acceptable values for this parameter are: - - - PTR: Only PTR record to be registered by the DHCP server service. - - - AandPTR: Both A and PTR records to be registered by the DHCP server service. - - - NoRegistration: No DNS registration is done by the DHCP server service. -If the dynamic DNS is turned off on the DHCP server service, then this parameter is set to NoRegistration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostName -Specifies the DNS host name of the client for which the IP address lease is to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv4 Address for which the IPv4 address lease record is to be added on the DHCP server service. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LeaseExpiryTime -Specifies the expiry time of the IPv4 address lease. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapCapable -Indicates that the client is network access protection (NAP) capable. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapStatus -Specifies the NAP status of the client. -The acceptable values for this parameter are: NoQuarantine, RestrictedAccess, DropPacket, Probation, Exempt, DefaultQuarSetting, or NoQuarInfo. -The default value is NoQuarantine. - -If this parameter is specified as Probation and a probation period is not specified, then this cmdlet will return an error. - -If this parameter is not specified or is specified as something other than Probation and probation period is not specified, then the probation period to set to 0. - -If this parameter is not specified and probation period is specified, then this parameter is set to Probation. - -If this parameter is not specified or is specified as something other than Probation and the **ProbationEnds** parameter is specified, then this cmdlet will return an error. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy to be set on the IPv4 address lease record being added. -Note: The DHCP server service does not check whether the policy specified exists on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProbationEnds -Specifies the end-time of probation to be set on the IPv4 address lease record. - -The default value is 0. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the subnet mask to be set on the IPv4 address lease record being added. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4Lease](./Get-DhcpServerv4Lease.md) - -[Remove-DhcpServerv4Lease](./Remove-DhcpServerv4Lease.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4OptionDefinition.md deleted file mode 100644 index e0bade6052..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4OptionDefinition.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4OptionDefinition - -## SYNOPSIS -Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv4OptionDefinition [-Name] [-OptionId] [-Type] [-AsJob] - [-CimSession ] [-ComputerName ] [-DefaultValue ] [-Description ] - [-MultiValued] [-PassThru] [-ThrottleLimit ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service. -An option definition needs to exist before an option value of that type can be configured. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4OptionDefinition -Name WPAD -OptionId 252 -Type String -``` - -This example adds the IPv4 option definition for web proxy auto detection (wpad) to the DHCPv4 server service. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv4OptionDefinition -Name UCIdentifier -OptionId 1 -Type BinaryData -VendorClass MS-UC-Client -Description "UC Identifier" -``` - -This example adds the option definition for the Unified Communications (UC) identifier for the vendor class named MS-UC-Client. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultValue -Specifies the default value for the option for which a definition is created. -The syntax to specify the default value for the option as follows: - - - Byte, Word, DWord, DWordDword: These values can be specified as decimal or hexadecimal strings. - - - IPAddress, IPv6Address: These values can be specified as IP address strings. - - - String: This value can be specified as a string. - - - BinaryData, EncapsulatedData: These values can be specified as hexadecimal strings. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the option definition being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MultiValued -Allows for multiple values. -The acceptable values for this parameter are: True or False. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DHCPv4 option. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numerical identifier of the option. -The acceptable values for this parameter are: 1 through 255. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the data type of the values for this option. -The acceptable values for this parameter are: - -- Byte -- Word -- DWord -- DWordDword -- IPAddress -- String -- BinaryData -- EncapsulatedData -- IPv6Address - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Byte, Word, DWord, DWordDWord, IPv4Address, IPv6Address, String, BinaryData, EncapsulatedData - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Adds the Option Definition for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4OptionDefinition](./Get-DhcpServerv4OptionDefinition.md) - -[Remove-DhcpServerv4OptionDefinition](./Remove-DhcpServerv4OptionDefinition.md) - -[Set-DhcpServerv4OptionDefinition](./Set-DhcpServerv4OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Policy.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Policy.md deleted file mode 100644 index 9eca917cca..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Policy.md +++ /dev/null @@ -1,521 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4policy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Policy - -## SYNOPSIS -Adds a new policy either at the server level or at the scope level. - -## SYNTAX - -``` -Add-DhcpServerv4Policy [-Name] [-Condition] [-AsJob] [-CimSession ] - [-CircuitId ] [-ClientId ] [-ComputerName ] [-Description ] - [-Enabled ] [-MacAddress ] [-PassThru] [-ProcessingOrder ] [-RelayAgent ] - [-RemoteId ] [-ScopeId ] [-SubscriberId ] [-ThrottleLimit ] - [-UserClass ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Policy** cmdlet adds a new policy either at the server level or at the scope level. -The policy name must be unique at the level, either server or specific scope, where the policy is added and should have at least one condition as specified by the **VendorClass**, **UserClass**, **MACAddress**, **ClientId**, **RelayAgent**, **CircuitId**, **RemoteId**, or **SubscriberId** parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4Policy -Name HyperVPolicy -Condition OR -MacAddress EQ,00155D*,000569* -``` - -This example creates a server level policy for virtual machine (VM) clients. -The MAC addresses of Hyper-V VMs (00-15-5D) and VMWare VMs (00-05-69) are used as a condition in the policy. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv4Policy -Name PhysicalComputersPolicy -Condition OR -MacAddress NE,00155D*,000569* -``` - -This example creates a server level policy for non-Hyper-V clients. -The MAC address of Hyper-V VMs (`00-15-5D`) and VMware VMs (`000569`) is used as a negation condition in the policy. - -### EXAMPLE 3 -``` -PS C:\>Add-DhcpServerv4Policy -Name VMPolicy -ScopeId 10.10.10.0 -Condition OR -MacAddress EQ,00155D*,000569* -``` - -This example creates a scope level policy for virtual machine (VM) clients inside the scope 10.10.10.0. -The MAC addresses of Hyper-V VMs (00-15-5D) and VMware VMs (00-05-69) are used as a condition in the policy. - -### EXAMPLE 4 -``` -PS C:\>Add-DhcpServerv4Policy -Name PrinterPolicy -ScopeId 10.10.10.0 -Condition OR -VendorClass EQ,"HP Printer","Xerox Printer" -``` - -This example creates a printer policy inside the scope 10.10.10.0 based on the vendor class of printers. -The vendor classes need to be defined before being used in the policy. - -### EXAMPLE 5 -``` -PS C:\>Add-DhcpServerv4Policy -Name LabComputerPolicy -ScopeId 10.10.10.0 -Condition OR -UserClass EQ,LabComputers -``` - -This example creates a lab computers policy inside the scope 10.10.10.0 based on the user class. -The user class needs to be defined before being used in the policy. - -### EXAMPLE 6 -``` -PS C:\>Add-DhcpServerv4Policy -Name RelayAgentBasedPolicy -ScopeId 10.10.10.0 -Condition OR -RelayAgent EQ,01030a0b0c02050000000123 -``` - -This example creates a policy based on the relay agent information (option 82) inside the scope 10.10.10.0. -The DHCP relay agent needs to be configured with the relay agent information option (option 82). - -### EXAMPLE 7 -``` -PS C:\>Add-DhcpServerv4Policy -Name DevicesPolicy -ScopeId 10.10.10.0 -Condition OR -MacAddress EQ,F8DB7F* -VendorClass EQ,Android -``` - -This example creates a policy by combining conditions, using OR, based on MAC address prefix of HTC phone devices and vendor class of Android, inside the scope 10.10.10.0. -The vendor class needs to be defined before being used in the policy. - -### EXAMPLE 8 -``` -PS C:\>Add-DhcpServerv4Policy -Name HyperVPolicy -Condition OR -MacAddress EQ,00155D*,000569* -ProcessingOrder 2 -Enabled False -``` - -This example creates a server level policy for virtual machine (VM) clients and assigns a processing order and creates the policy in a disabled state. -The MAC addresses of Hyper-V VMs (00-15-5D) and VMWare VMs (00-05-69) are used as a condition in the policy. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CircuitId -Specifies the comparator to use and the values with which to compare the circuit id sub-option. -The first element is the comparator, either EQ or NE, followed by a single value. -No wildcard characters are allowed. - -The value can again be followed by another comparator, either EQ or NE, which is followed by another value for comparison. - -The input format for the value is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientId -Specifies the comparator to use and the values with which to compare client identifier. -The first element is the comparator, either EQ or NE, and subsequent elements are values. -A trailing wildcard character can be present to indicate partial match. - -The values can again be followed by another comparator, either EQ or NE, which is followed by another set of values for comparison. - -The input format is a hexadecimal string with or without hyphen separation. -For example: `EQ, 00-11-22-33-44-55, AA-BB-CC-DD-EE*`. - -The output format is a hexadecimal string with hyphen separation. - -The values following the EQ operator will be treated as multiple assertions which are logically combined (OR'd). - -The values following the NE operator will be treated as multiple assertions which are logically differenced (AND'd). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -Specifies the logical operator between conditions when multiple conditions are specified. -The acceptable values for this parameter are: AND or OR. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description string of the policy being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Specifies the enabled state of a policy. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MacAddress -Specifies the comparator to use and the values with which to compare the MAC Address in the client request. -The first element is the comparator, EQ or NE, and the subsequent elements are values. -If the last character in a value is an asterisk (`*`), then the subsequent characters are treated as wildcard characters for the comparison. - -The values can again be followed by another comparator, EQ or NE, which is followed by another set of values. - -The input format is a hexadecimal string with or without hyphen separation. -A trailing wildcard character can be present to indicate partial match. -For example: `00-1F-3B-7C-B7-89, 00-1F-3B-7C-B7-*, 001F3B7CB789`. - -The output format is a hexadecimal string with hyphen separation. - -The values following the EQ operator will be treated as multiple assertions which are logically combined (OR'd). - -The values following the NE operator will be treated as multiple assertions which are logically differenced (AND'd). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessingOrder -Specifies the order of this policy with respect to other policies in the scope or server. -The DHCP server service will process the policies in the specified order while evaluating client requests. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RelayAgent -Specifies the comparator to use and values with which to compare the relay agent information. -The first element is the comparator, EQ or NE, and subsequent elements are values. -No wildcard characters are allowed. - -The values can again be followed by another comparator, EQ or NE, which is followed by another set of values. - -The input format is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemoteId -Specifies the comparator to use and values with which to compare the remote ID sub-option. -The first element is the comparator, EQ or NE, followed by a single value. -No wildcard characters are allowed. - -The value can again be followed by another comparator, EQ or NE, which is followed by another value. - -The input format for the value is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier, in IPv4 address format, in which the policy is being added. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriberId -Specifies the comparator to use and the values with which to compare the subscriber ID sub-option. -The first element is the comparator, EQ or NE, and followed by a single value. -No wildcard characters are allowed. - -The value can again be followed by another comparator, EQ or NE, which is followed by another value. - -The input format is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Specifies the comparator to use and the user class values to compare with the user class field in the client request. -The first element to be specified is the comparator, EQ or NE, and the subsequent elements are values. -A trailing wildcard character can be present to indicate partial match. - -The values can again be followed by another comparator, EQ or NE, which is followed by another set of values. - -The values to be specified are the user class names which already exist on the server. - -The values following the EQ operator are treated as multiple assertions which are logically combined (OR'd). - -The values following the NE operator are treated as multiple assertions which are logically differenced (AND'd). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Specifies the comparator to use and vendor class values to compare with the vendor class field in the client request. -The first element is the comparator, EQ or NE, and the subsequent elements are values. -If the last character in a value is an asterisk (`*`), then the subsequent characters are treated as wildcard characters for the comparison. - -The values can again be followed by another comparator, EQ or NE, which is followed by another set of values. - -The values to be specified are the vendor class names which already exist on the server. - -The values following the EQ operator are treated as multiple assertions which are logically combined (OR'd). - -The values following the NE operator are treated as multiple assertions which are logically differenced (AND'd). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) - -[Get-DhcpServerv4Policy](./Get-DhcpServerv4Policy.md) - -[Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) - -[Remove-DhcpServerv4Policy](./Remove-DhcpServerv4Policy.md) - -[Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) - -[Set-DhcpServerv4Policy](./Set-DhcpServerv4Policy.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4PolicyIPRange.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4PolicyIPRange.md deleted file mode 100644 index 96a73a9c0b..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4PolicyIPRange.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4policyiprange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4PolicyIPRange - -## SYNOPSIS -Adds an IP range to an existing policy at the scope level. - -## SYNTAX - -``` -Add-DhcpServerv4PolicyIPRange [-Name] [-ScopeId] [-StartRange] - [-EndRange] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4PolicyIPRange** cmdlet adds an IP range to an existing policy at the scope level. -If the policy already has one or more IP ranges, then those ranges are also retained. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4PolicyIPRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name HyperVPolicy -StartRange 10.10.10.10 -EndRange 10.10.10.20 -``` - -This example adds the IP address range from 10.10.10.10 through 10.10.10.20 to the Hyper-V policy named HyperVPolicy in the scope 10.10.10.0. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending IP address of the range being added to the policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy for which the IP address range is being assigned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier, in IPv4 address format, which contains the specified policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IP address of the range being added to the policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4PolicyIPRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Policy](./Add-DhcpServerv4Policy.md) - -[Get-DhcpServerv4Policy](./Get-DhcpServerv4Policy.md) - -[Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) - -[Remove-DhcpServerv4Policy](./Remove-DhcpServerv4Policy.md) - -[Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) - -[Set-DhcpServerv4Policy](./Set-DhcpServerv4Policy.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Reservation.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Reservation.md deleted file mode 100644 index 9374543297..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Reservation.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Reservation - -## SYNOPSIS -Reserves the specified IPv4 address in the scope for a client. - -## SYNTAX - -``` -Add-DhcpServerv4Reservation [-ScopeId] [-IPAddress] [-ClientId] [-AsJob] - [-CimSession ] [-ComputerName ] [-Description ] [-Name ] [-PassThru] - [-ThrottleLimit ] [-Type ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Reservation** cmdlet reserves the specified IPv4 address in the scope for a client. -Once reserved, the IP address will be leased only to the client identified by the specific client identifier (ID). - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4Reservation -ScopeId 10.10.10.0 -IPAddress 10.10.10.8 -ClientId F0-DE-F1-7A-00-5E -Description "Reservation for Printer" -``` - -This example adds a reserved IP address for the client identified by the specified client ID. - -### EXAMPLE 2 -``` -PS C:\>Import-Csv -Path Reservations.csv | Add-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -``` - -This example adds all of the reservations in the file named Reservations.csv to the DHCP server service running on the computer named dhcpserver.contoso.com. -The Import-Csvhttp://go.microsoft.com/fwlink/p/?LinkId=113341 cmdlet returns the objects with reservation fields and pipes the objects to this cmdlet, which adds these reservations to the DHCP server services. -The file named Reservations.csv should contain the reservations in the following comma-separated values (CSV) format: - -ScopeId,IPAddress,Name,ClientId,Description - -10.10.10.0,10.10.10.10,Computer1,1a-1b-1c-1d-1e-1f,Reserved for Computer1 - -20.20.20.0,20.20.20.11,Computer2,2a-2b-2c-2d-2e-2f,Reserved for Computer2 - -30.30.30.0,30.30.30.12,Computer3,3a-3b-3c-3d-3e-3f,Reserved for Computer3 - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.11 | Add-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -``` - -This example converts one of the leases into a reservation. -The Get-DhcpServerv4Lease cmdlet returns the IP address lease object and pipes the object to this cmdlet, which creates the reservation with the IP address and client ID in the lease object. - -### EXAMPLE 4 -``` -PS C:\>$freeip = Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 - - - -PS C:\>Add-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -IPAddress $freeip -ClientId F0-DE-F1-7A-00-5E -Description "Reservation for Printer" -``` - -This example creates a reservation for the client identified by the specified client ID from any of the free IP addresses in the scope 10.10.10.0. -The Get-DhcpServerv4FreeIPAddress cmdlet fetches a free IP address in the scope, then this cmdlet reserves an address for the specified client ID. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies the unique identifier (ID) for the client. -For Windows clients, the MAC address is used as the client ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the reservation being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv4 address to be reserved for the client. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the reservation being created. -This parameter value can be the host name of the client or a name to be used to identify the reservation on the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the identifier (ID) of the scope in which the reservation is being created. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of client request for which this IP address is reserved. -The acceptable values for this parameter are: DHCP, BootP, or Both. -The default value is Both. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Import-Csv](https://go.microsoft.com/fwlink/p/?LinkId=113341) - -[Get-DhcpServerv4FreeIPAddress](./Get-DhcpServerv4FreeIPAddress.md) - -[Get-DhcpServerv4Lease](./Get-DhcpServerv4Lease.md) - -[Get-DhcpServerv4Reservation](./Get-DhcpServerv4Reservation.md) - -[Remove-DhcpServerv4Reservation](./Remove-DhcpServerv4Reservation.md) - -[Set-DhcpServerv4Reservation](./Set-DhcpServerv4Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Scope.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Scope.md deleted file mode 100644 index 103dcecd4b..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Scope.md +++ /dev/null @@ -1,408 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Scope - -## SYNOPSIS -Adds an IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv4Scope [-StartRange] [-EndRange] [-SubnetMask] - [-Name] [-ActivatePolicies ] [-AsJob] [-CimSession ] [-ComputerName ] - [-Delay ] [-Description ] [-LeaseDuration ] [-MaxBootpClients ] [-NapEnable] - [-NapProfile ] [-PassThru] [-State ] [-SuperscopeName ] [-ThrottleLimit ] - [-Type ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Scope** cmdlet adds an IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv4Scope -Name "Lab-4 Network" -StartRange 10.10.10.1 -EndRange 10.10.10.254 -SubnetMask 255.255.255.0 -``` - -This example adds a new scope for 10.10.10.0/24 subnet on the DHCP server service running on the local computer. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -Name "Lab-5 Network" -StartRange 20.20.20.1 -EndRange 20.20.20.254 -SubnetMask 255.255.255.0 -State InActive -NapEnable -``` - -This example adds the specified inactive scope for 20.20.20.0/24 subnet on the DHCP server service. -The scope is enabled for NAP. - -### EXAMPLE 3 -``` -PS C:\>Add-DhcpServerv4Scope -Name "Lab-6 Network" -StartRange 30.30.30.1 -EndRange 30.30.30.254 -SubnetMask 255.255.255.0 -SuperScope "Expanded Lab-6 Network" -``` - -This example adds a new scope for 30.30.30.0/24 subnet on the DHCP server service running on the local computer. -The scope is added as part of the superscope named Expanded Lab-6 Network. - -## PARAMETERS - -### -ActivatePolicies -Specifies the enabled state of the policy enforcement on the scope being added. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delay -Specifies the number of milliseconds by which the DHCP server service should wait before responding to the client requests. -This parameter should be configured if the scope is part of a split scope deployment and this DHCP server service should act as a secondary DHCP server service for the scope being added. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description string for the IPv4 scope being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending IP address of the range within the subnet from which IP addresses should be leased by the DHCP server service. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LeaseDuration -Specifies the time interval for which an IP address should be leased to a client in this scope. -This should be specified in the format `day.hrs:mins:secs`. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 8.00:00:00 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxBootpClients -Specifies, if the scope type is specified as Both to allow for both DHCP and BootP clients, the maximum number of BootP clients which should be leased an IP address from this scope. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the IPv4 scope being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapEnable -Specifies the enabled state of Network Access Protection (NAP) for this scope. -If NAP is enabled, then the DHCP server service passes the statement of health (SoH) received from the client to the network policy server (NPS). -Based on the NAP profile set, the NPS determines the network access to be granted to the client. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapProfile -Specifies that the NAP profile should be set only if NAP is enabled on the scope. -The NAP profile refers to the MS Service Class which is a condition used in network policies on NPS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IP address of the range within the subnet from which IP addresses should be leased by the DHCP server service. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the scope when created. -The acceptable values for this parameter are: Active or Inactive. -Only an active scope will respond to client requests. -The default value is Active. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Active -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubnetMask -Specifies the subnet mask for the scope specified in IP address format. -For example: `255.255.255.0`. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuperscopeName -Specifies the name of the superscope to which the scope will be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of clients to be serviced by the scope. -The acceptable values for this parameter are: DHCP, BootP, or Both. -The type of the scope determines if the DHCP server service responds to only DHCP client requests, only BootP client requests, or Both types of clients. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: DHCP -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Get-DhcpServerv4ScopeStatistics](./Get-DhcpServerv4ScopeStatistics.md) - -[Remove-DhcpServerv4Scope](./Remove-DhcpServerv4Scope.md) - -[Set-DhcpServerv4Scope](./Set-DhcpServerv4Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Superscope.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Superscope.md deleted file mode 100644 index 0edaeb3bb8..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv4Superscope.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv4superscope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv4Superscope - -## SYNOPSIS -Adds one or more specified scopes to a superscope. - -## SYNTAX - -``` -Add-DhcpServerv4Superscope [-SuperscopeName] [-ScopeId] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv4Superscope** cmdlet adds one or more specified IPv4 scopes to a superscope; if the superscope does not exist, then the superscope will be created. -The IPv4 scopes to be added must already exist. -If a scope already belongs to another superscope, then the scope will not be moved to be part of the new superscope unless the **Force** parameter is specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-DhcpServerv4Superscope -SuperscopeName "Expanded Lab-4 Network" -ScopeId 10.1.1.0, 10.1.2.0 -``` - -This example adds the scopes 10.1.1.0 and 10.1.2.0 to the superscope named Expanded Lab-4 Network on the DHCP server service running on the local computer. - -### EXAMPLE 2 -``` -PS C:\> Add-DhcpServerv4Superscope -SuperscopeName "Expanded Lab-5 Network" -ScopeId 10.1.1.0, 10.1.2.0 -Force -``` - -This example adds the scopes 10.1.1.0 and 10.1.2.0 to the superscope named Expanded Lab-5 Network on the DHCP server service running on the local computer. -The **Force** parameter ensures that the scopes are removed from the existing superscope association, if any exist. -Since the older superscope does not contain any scopes, the superscope is automatically deleted. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that, if a specified scope is already part of a different superscope, the specified scope will be removed from that superscope and added to the specified superscope. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the IPv4 address of one or more scopes which need to be added to superscope specified in the **SuperscopeName** parameter. -The specified scope must already exist. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuperscopeName -Specifies the name of the superscope to which the scopes will be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Superscope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Superscope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4Superscope](./Get-DhcpServerv4Superscope.md) - -[Remove-DhcpServerv4Superscope](./Remove-DhcpServerv4Superscope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Class.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Class.md deleted file mode 100644 index ee3218354f..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Class.md +++ /dev/null @@ -1,255 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv6class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv6Class - -## SYNOPSIS -Adds an IPv6 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv6Class [-Name] [-Type] [-Data] [-AsJob] [-CimSession ] - [-ComputerName ] [-Description ] [-PassThru] [-ThrottleLimit ] [-VendorId ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv6Class** cmdlet adds an IPv6 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. - -The **VendorId** parameter needs to be specified if a vendor class is being added, but should not be specified for a user class. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv6Class -Name "User Class for Lab Computers" -Type User -Data "LabComputers" -``` - -This example adds a DHCPv6 user class for lab computers. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv6Class -Name "Vendor Class for Printers" -Type Vendor -Data "JetPrinters" -VendorId 100 -``` - -This example adds a DHCPv6 vendor class for printers from a specific vendor identified by the vendor ID. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv6 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Data -Specifies the data for the vendor or user class. -This is the actual value expected to be present in the request from the client belonging to this vendor or user class. -The format for this parameter can be given as ANSI or hexadecimal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description string to be set on the vendor or user class being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the vendor or user class being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class. -The acceptable values for this parameter are: Vendor or User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorId -Specifies the enterprise number of the vendor class. -If this parameter is specified for user class, then an error is displayed. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6Class](./Get-DhcpServerv6Class.md) - -[Remove-DhcpServerv6Class](./Remove-DhcpServerv6Class.md) - -[Set-DhcpServerv6Class](./Set-DhcpServerv6Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6ExclusionRange.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6ExclusionRange.md deleted file mode 100644 index 7db77d90af..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6ExclusionRange.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv6exclusionrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv6ExclusionRange - -## SYNOPSIS -Sets the range of IPv6 addresses to exclude from an IPv6 scope. - -## SYNTAX - -``` -Add-DhcpServerv6ExclusionRange [-Prefix] [-StartRange] [-EndRange] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv6ExclusionRange** cmdlet sets the range of IPv6 addresses to exclude from an IPv6 scope. -The IP addresses from this range will not be leased out by the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv6ExclusionRange -Prefix 2001:4898:7020:1020:: -StartRange 2001:4898:7020:1020::1 -EndRange 2001:4898:7020:1020::10 -``` - -This example excludes the IPv6 addresses from 2001:4898:7020:1020::1 to 2001:4898:7020:1020::10 from DHCPv6 scope 2001:4898:7020:1020:: on the DHCP server service running on the local computer. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv6ExclusionRange -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -StartRange 2001:4898:7020:1020::1 -EndRange 2001:4898:7020:1020::1 -``` - -This example excludes the IPv6 address 2001:4898:7020:1020::1 from the DHCPv6 scope 2001:4898:7020:1020:: on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending IP address in exclusion range, as a string formatted as an IPv6 address. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefix of the scope to which the exclusion range is being added. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IP address in exclusion range, as a string formatted as an IPv6 address. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6ExclusionRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6ExclusionRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6ExclusionRange](./Get-DhcpServerv6ExclusionRange.md) - -[Remove-DhcpServerv6ExclusionRange](./Remove-DhcpServerv6ExclusionRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Lease.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Lease.md deleted file mode 100644 index 185bc1a4ad..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Lease.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv6lease?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv6Lease - -## SYNOPSIS -Adds a new IPv6 address lease to the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Add-DhcpServerv6Lease [-IPAddress] [-ClientDuid] [-Iaid] [-AddressType ] - [-AsJob] [-CimSession ] [-ComputerName ] [-Description ] [-HostName ] - [-LeaseExpiryTime ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv6Lease** cmdlet adds a new IPv6 address lease to the Dynamic Host Configuration Protocol (DHCP) server service. -This cmdlet is used for testing purposes only. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv6Lease -IPAddress 2001:4898:7020:1020::10 -ClientDuid 00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E -Iaid 234890455 -LeaseExpiryTime "2012-01-28 01:38:13Z" -HostName MyComputer.contoso.com -``` - -This example adds an IP address lease for 2001:4898:7020:1020::10 on the DHCP server service running on the local computer. - -## PARAMETERS - -### -AddressType -Specifies the type of IPv6 address being added. -The acceptable values for this parameter are: IANA or IATA. -The default value is IANA. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientDuid -Specifies the DHCPv6 client identifier (ID) (DUID) for the client for which the lease is being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description string to set on the lease record being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostName -Specifies the DNS name to set on the lease record being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Iaid -Specifies the identity association ID (IAID) to set on the IPv6 lease record. - -The IAID is specific for each network adapter on the client computer. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv6 address for which the lease record is being added. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LeaseExpiryTime -Specifies the valid lease expiry time to set on the IPv6 lease being added. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6Lease](./Get-DhcpServerv6Lease.md) - -[Remove-DhcpServerv6Lease](./Remove-DhcpServerv6Lease.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6OptionDefinition.md deleted file mode 100644 index c2674f4582..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6OptionDefinition.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv6optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv6OptionDefinition - -## SYNOPSIS -Adds a DHCPv6 option definition to a Dynamic Host Configuration Protocol (DHCP) server service running on the local or a remote computer. - -## SYNTAX - -``` -Add-DhcpServerv6OptionDefinition [-Name] [-OptionId] [-Type] [-AsJob] - [-CimSession ] [-ComputerName ] [-DefaultValue ] [-Description ] - [-MultiValued] [-PassThru] [-ThrottleLimit ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv6OptionDefinition** cmdlet adds a DHCPv6 option definition to a Dynamic Host Configuration Protocol (DHCP) server service running on the local or a remote computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-DhcpServerv6OptionDefinition -Name "Broadcast and Multicast Service Controller IPv6 Address" -OptionId 36 -Type IPv6Address -``` - -This example adds the Broadcast and Multi-cast Service Controller IPv6 Address option definition to the DHCPv6 server service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultValue -Specifies the default value for the option. - -If the type of the option is Byte, Word, DWord, or DWordDword, then the default value must be specified as one or more decimal or hexadecimal strings. - -If the type of the option is IPAddress or IPv6Address, then the default value must be specified as an IP address string. - -If the type of the option is String, then the default value must be specified as a string. - -If the type of the option is BinaryData or EncapsulatedData, then the default value must be specified as a hexadecimal string. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description of the option definition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MultiValued -Specifies that the option allows multiple values to be specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the option. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OptionId -Specifies the integer identifier (ID) for the option. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the data type of the option. -The acceptable values for this parameter are: Byte, Word, DWord, DWordDword, IPAddress, String, BinaryData, EncapsulatedData, or IPv6Address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Adds the option definition only for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6OptionDefinition](./Get-DhcpServerv6OptionDefinition.md) - -[Remove-DhcpServerv6OptionDefinition](./Remove-DhcpServerv6OptionDefinition.md) - -[Set-DhcpServerv6OptionDefinition](./Set-DhcpServerv6OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Reservation.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Reservation.md deleted file mode 100644 index 0a8ef5f0c1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Reservation.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv6reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv6Reservation - -## SYNOPSIS -Adds an IPv6 Reservation to an IPv6 prefix or scope. - -## SYNTAX - -``` -Add-DhcpServerv6Reservation [-Prefix] [-IPAddress] [-ClientDuid] - [-Iaid] [[-Name] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-Description ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv6Reservation** cmdlet reserves a specified IPv6 address for the client identified by the specified Dynamic Host Configuration Protocol (DHCP) v6 unique identifier (ID) (DUID) and identity association ID (IAID). - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-DhcpServerv6Reservation -Prefix 2001:4898:7020:1020:: -IPAddress 2001:4898:7020:1020::1 -ClientDuid 00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E -Iaid 234890455 -``` - -This example reserves the specified IPv6 address for the specified **ClientDuid** and **Iaid** parameter values. -After the reservation is added, the DHCP server service will assign only the specified IP address to the client request which contains the specified **ClientDuid** and **Iaid** parameter values. - -### EXAMPLE 2 -``` -PS C:\> Import-Csv -Path Reservations.csv | Add-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -``` - -This example adds all of the reservations in the file named Reservations.csv to the DHCP server service running on the computer named dhcpserver.contoso.com. -The Import-Csvhttp://go.microsoft.com/fwlink/p/?LinkId=113341 cmdlet returns the objects with reservation fields and pipes the objects to this cmdlet, which adds these reservations to the DHCP server service. -The file named Reservations.csv should contain the reservations in the following comma-separated values (CSV) format: - -Prefix,IPAddress,Name,ClientDuid,Iaid,Description - -2001:4898:7020:1020::,2001:4898:7020:1020::1,Computer1,00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E,234890455,Reserved for Computer1 - -2001:4898:7020:1020::,2001:4898:7020:1020::2,Computer2,00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-6E,234890465,Reserved for Computer2 - -2001:4898:7020:1020::,2001:4898:7020:1020::3,Computer3,00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-7E,234890475,Reserved for Computer3 - -### Example 3 -``` -PS C:\>$freeip = Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: - - - -PS C:\>Add-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -IPAddress $freeip -ClientDuid 00-01-00-01-15-F9-7F-AB-F0-DE-F1-7A-00-5E -Iaid 234890455 -Description "Reservation for Printer" -``` - -This example creates a reservation for the client identified by the specified client ID from any of the free IP address in the scope 2001:4898:7020:1020::. -The Get-DhcpServerv6FreeIPAddress cmdlet fetches a free IP address in that scope, then this cmdlet reserves the IP address for the specified client ID. - -### EXAMPLE 4 -``` -PS C:\> Get-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::11 | Add-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example converts one of the leases into a reservation. -The Get-DhcpServerv6Lease cmdlet returns an IP address lease object and pipes the object to this cmdlet, which creates the reservation with the IP address, client DUID, and IAID in the lease object. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientDuid -Specifies the DUID of the client. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description string for the IPv6 reservation being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Iaid -Specifies the DHCPv6 IAID of a specific network interface of the client. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv6 address to be reserved for the client. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the client. -This parameter value can be the actual host name of the client or a name assigned to identify the reserved client on the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefix which identifies the scope in which the reservation is created. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Import-Csv](https://go.microsoft.com/fwlink/p/?LinkId=113341) - -[Get-DhcpServerv6FreeIPAddress](./Get-DhcpServerv6FreeIPAddress.md) - -[Get-DhcpServerv6Lease](./Get-DhcpServerv6Lease.md) - -[Get-DhcpServerv6Reservation](./Get-DhcpServerv6Reservation.md) - -[Remove-DhcpServerv6Reservation](./Remove-DhcpServerv6Reservation.md) - -[Set-DhcpServerv6Reservation](./Set-DhcpServerv6Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Scope.md b/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Scope.md deleted file mode 100644 index 0ba9f8c842..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Add-DhcpServerv6Scope.md +++ /dev/null @@ -1,330 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/add-dhcpserverv6scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DhcpServerv6Scope - -## SYNOPSIS -Adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -## SYNTAX - -``` -Add-DhcpServerv6Scope [-Prefix] [-Name] [-AsJob] [-CimSession ] - [-ComputerName ] [-Description ] [-PassThru] [-Preference ] - [-PreferredLifetime ] [-State ] [-T1 ] [-T2 ] [-ThrottleLimit ] - [-ValidLifeTime ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DhcpServerv6Scope** cmdlet adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DhcpServerv6Scope -Prefix 2001:4898:7020:1020:: -Name "IPv6 Lab-4 Network" -``` - -The above command adds a DHCPv6 scope with subnet prefix 2001:4898:7020:1020:: and specified scope name to the DHCP server running on local computer. - -### EXAMPLE 2 -``` -PS C:\>Add-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Name "IPv6 Lab-4 Network" -PreferredLifeTime 4.00:00:00 -ValidLifeTime 6.00:00:00 -State Inactive -``` - -This example adds an inactive DHCPv6 scope with the subnet prefix 2001:4898:7020:1020::, specifies the scope name, sets the preferred lifetime to 4 days, and sets the valid lifetime to 6 days to the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description associated with the scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name associated with the scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preference -Specifies the value for the preference field to be used by the DHCP server service while responding to clients in this subnet. -The acceptable values for this parameter are: 0 through 255. - -The default value is 0. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreferredLifetime -Specifies the preferred life time of the IPv6 address leased by the DHCP server service. -The default value is 8 days. - -This parameter value should be same or less than the **ValidLifeTime** parameter value. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefix of the scope being added. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the scope. -The acceptable values for this parameter are: Enabled or Disabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -T1 -Specifies the lease renewal time. -The default value is 4 days. -The DHCP client is expected to use a unicast message to renew the lease at the time specified by this parameter value from the same DHCP server service from which DHCP client had initially obtained the lease. - -This parameter value should be less than the **T2** and **PreferredLifetime** parameter values. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -T2 -Specifies the lease rebind time. -The default value is 6.4 days. -The DHCP client is expected to use a multi-cast message to renew the lease at the time equal to this parameter value from any DHCP server service if the renewal attempt at time specified by the **T1** parameter fails. - -This parameter value should be greater than the **T1** parameter value and less than the **PreferredLifetime** parameter value. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidLifeTime -Specifies the valid life time of the IPv6 address leased by the DHCP server service. -The default value is `12` days. - -This parameter value should be same or greater than the **PreferredLifetime** parameter value. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - -[Get-DhcpServerv6ScopeStatistics](./Get-DhcpServerv6ScopeStatistics.md) - -[Remove-DhcpServerv6Scope](./Remove-DhcpServerv6Scope.md) - -[Set-DhcpServerv6Scope](./Set-DhcpServerv6Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Backup-DhcpServer.md b/docset/winserver2012-ps/dhcpserver/Backup-DhcpServer.md deleted file mode 100644 index 5a2133a6ae..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Backup-DhcpServer.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/backup-dhcpserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Backup-DhcpServer - -## SYNOPSIS -Backs up the Dynamic Host Configuration Protocol (DHCP) database of DHCP server service to the specified location. - -## SYNTAX - -``` -Backup-DhcpServer [-Path] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Backup-DhcpServer** cmdlet backs up the Dynamic Host Configuration Protocol (DHCP) database of DHCP server service to specified location. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Backup-DhcpServer -ComputerName dhcpserver.contoso.com -Path C:\Windows\system32\dhcp\backup -``` - -This example backs up the DHCP server database to the specified location. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IP address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the directory where the backed up database will be stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Export-DhcpServer](./Export-DhcpServer.md) - -[Import-DhcpServer](./Import-DhcpServer.md) - -[Restore-DhcpServer](./Restore-DhcpServer.md) - diff --git a/docset/winserver2012-ps/dhcpserver/DhcpServer.md b/docset/winserver2012-ps/dhcpserver/DhcpServer.md deleted file mode 100644 index 8dbac97381..0000000000 --- a/docset/winserver2012-ps/dhcpserver/DhcpServer.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 90eaa9df-133a-450c-8728-91055cd946a1 -Module Name: DhcpServer ---- - -# DhcpServer Module -## Description -This reference provides cmdlet descriptions and syntax for all Dynamic Host Configuration Protocol (DHCP) server service-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -Also see [DHCP Classes](https://go.microsoft.com/FWLink/p/?LinkId=260590). - -## DhcpServer Cmdlets -### [Add-DhcpServerInDC](./Add-DhcpServerInDC.md) -Adds the computer running the DHCP server service to the list of authorized Dynamic Host Configuration Protocol (DHCP) server services in Active Directory (AD). - -### [Add-DhcpServerv4Class](./Add-DhcpServerv4Class.md) -Adds an IPv4 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv4ExclusionRange](./Add-DhcpServerv4ExclusionRange.md) -Adds a range of excluded IP addresses for an IPv4 scope. - -### [Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) -Adds a new IPv4 failover relationship on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) -Adds one or more specified scopes to the failover relationship. - -### [Add-DhcpServerv4Filter](./Add-DhcpServerv4Filter.md) -Adds a MAC address filter to the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv4Lease](./Add-DhcpServerv4Lease.md) -Adds a new IPv4 address lease in the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv4OptionDefinition](./Add-DhcpServerv4OptionDefinition.md) -Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv4Policy](./Add-DhcpServerv4Policy.md) -Adds a new policy either at the server level or at the scope level. - -### [Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) -Adds an IP range to an existing policy at the scope level. - -### [Add-DhcpServerv4Reservation](./Add-DhcpServerv4Reservation.md) -Reserves the specified IPv4 address in the scope for a client. - -### [Add-DhcpServerv4Scope](./Add-DhcpServerv4Scope.md) -Adds an IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv4Superscope](./Add-DhcpServerv4Superscope.md) -Adds one or more specified scopes to a superscope. - -### [Add-DhcpServerv6Class](./Add-DhcpServerv6Class.md) -Adds an IPv6 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv6ExclusionRange](./Add-DhcpServerv6ExclusionRange.md) -Sets the range of IPv6 addresses to exclude from an IPv6 scope. - -### [Add-DhcpServerv6Lease](./Add-DhcpServerv6Lease.md) -Adds a new IPv6 address lease to the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Add-DhcpServerv6OptionDefinition](./Add-DhcpServerv6OptionDefinition.md) -Adds a DHCPv6 option definition to a Dynamic Host Configuration Protocol (DHCP) server service running on the local or a remote computer. - -### [Add-DhcpServerv6Reservation](./Add-DhcpServerv6Reservation.md) -Adds an IPv6 Reservation to an IPv6 prefix or scope. - -### [Add-DhcpServerv6Scope](./Add-DhcpServerv6Scope.md) -Adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -### [Backup-DhcpServer](./Backup-DhcpServer.md) -Backs up the Dynamic Host Configuration Protocol (DHCP) database of DHCP server service to the specified location. - -### [Export-DhcpServer](./Export-DhcpServer.md) -Exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file. - -### [Get-DhcpServerAuditLog](./Get-DhcpServerAuditLog.md) -Gets the configuration parameters related to the audit log of the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerDatabase](./Get-DhcpServerDatabase.md) -Gets the configuration parameters related to the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerInDC](./Get-DhcpServerInDC.md) -Retrieves the list of authorized computers running the Dynamic Host Configuration Protocol (DHCP) server service from Active Directory (AD). - -### [Get-DhcpServerSetting](./Get-DhcpServerSetting.md) -Gets the configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv4Binding](./Get-DhcpServerv4Binding.md) -Gets all of the IPv4 interfaces on the computer to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. - -### [Get-DhcpServerv4Class](./Get-DhcpServerv4Class.md) -Retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv4DnsSetting](./Get-DhcpServerv4DnsSetting.md) -Gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server level. - -### [Get-DhcpServerv4ExclusionRange](./Get-DhcpServerv4ExclusionRange.md) -Returns the IPv4 address ranges excluded from the specified scope identifiers (IDs). - -### [Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) -Gets the failover relationships configured on the Dynamic Host Configuration Protocol (DHCP) server service for the specific failover relationship name. - -### [Get-DhcpServerv4Filter](./Get-DhcpServerv4Filter.md) -Gets the list of all MAC addresses from the allow list or the deny list on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv4FilterList](./Get-DhcpServerv4FilterList.md) -Gets the enabled state of the allow filter list and deny filter list set on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv4FreeIPAddress](./Get-DhcpServerv4FreeIPAddress.md) -Gets one or more free, or unassigned, IPv4 Addresses from the specified scope. - -### [Get-DhcpServerv4Lease](./Get-DhcpServerv4Lease.md) -Gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv4OptionDefinition](./Get-DhcpServerv4OptionDefinition.md) -Gets the DHCPv4 option definition for the specified option identifiers (IDs). - -### [Get-DhcpServerv4OptionValue](./Get-DhcpServerv4OptionValue.md) -Returns the IPv4 option Values for one or more IPv4 options at the server, scope or reservation level. - -### [Get-DhcpServerv4Policy](./Get-DhcpServerv4Policy.md) -Gets one or more policies at the server level or the scope level. - -### [Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) -Gets one or more IP ranges from a policy in the specified scope. - -### [Get-DhcpServerv4Reservation](./Get-DhcpServerv4Reservation.md) -Gets one or more IPv4 reservations for the specified IP addresses or client identifiers (IDs). - -### [Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) -Returns the IPv4 scope configuration of the specified scopes. - -### [Get-DhcpServerv4ScopeStatistics](./Get-DhcpServerv4ScopeStatistics.md) -Gets the IPv4 scope statistics corresponding to the IPv4 scope identifiers (IDs) specified for a Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv4Statistics](./Get-DhcpServerv4Statistics.md) -Gets Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv4. - -### [Get-DhcpServerv4Superscope](./Get-DhcpServerv4Superscope.md) -Gets the configuration for the specified superscope. - -### [Get-DhcpServerv6Binding](./Get-DhcpServerv6Binding.md) -Returns the IPv6 interfaces to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. - -### [Get-DhcpServerv6Class](./Get-DhcpServerv6Class.md) -Gets the IPv6 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv6DnsSetting](./Get-DhcpServerv6DnsSetting.md) -Gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server-wide. - -### [Get-DhcpServerv6ExclusionRange](./Get-DhcpServerv6ExclusionRange.md) -Gets the IPv6 address ranges excluded from the specified IPv6 subnet prefix. - -### [Get-DhcpServerv6FreeIPAddress](./Get-DhcpServerv6FreeIPAddress.md) -Gets one or more free, or unassigned, IPv6 addresses from the specified scope. - -### [Get-DhcpServerv6Lease](./Get-DhcpServerv6Lease.md) -Gets one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv6OptionDefinition](./Get-DhcpServerv6OptionDefinition.md) -Gets the option definition for the option identified by the option identifier (ID). - -### [Get-DhcpServerv6OptionValue](./Get-DhcpServerv6OptionValue.md) -Returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope or, server level. - -### [Get-DhcpServerv6Reservation](./Get-DhcpServerv6Reservation.md) -Returns the reserved IPv6 addresses on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) -Gets the scope information for the specified IPv6 prefixes on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv6ScopeStatistics](./Get-DhcpServerv6ScopeStatistics.md) -Gets the IPv6 prefix statistics that correspond to the IPv6 prefix specified for a Dynamic Host Configuration Protocol (DHCP) server service. - -### [Get-DhcpServerv6StatelessStatistics](./Get-DhcpServerv6StatelessStatistics.md) -Gets a list of IPv6 subnet prefixes which have stateless clients and the number of addresses in use in each of the subnets. - -### [Get-DhcpServerv6StatelessStore](./Get-DhcpServerv6StatelessStore.md) -Gets the properties of IPv6 stateless store for the specified IPv6 subnet. - -### [Get-DhcpServerv6Statistics](./Get-DhcpServerv6Statistics.md) -Gets the Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv6. - -### [Get-DhcpServerVersion](./Get-DhcpServerVersion.md) -Gets the version of the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Import-DhcpServer](./Import-DhcpServer.md) -Imports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, from the specified file. - -### [Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) -Replicates scope configuration between failover partner Dynamic Host Configuration Protocol (DHCP) server services. - -### [Remove-DhcpServerInDC](./Remove-DhcpServerInDC.md) -Deletes the specified Dynamic Host Configuration Protocol (DHCP) server service from the list of authorized DHCP server services in Active Directory (AD). - -### [Remove-DhcpServerv4Class](./Remove-DhcpServerv4Class.md) -Deletes the IPv4 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv4ExclusionRange](./Remove-DhcpServerv4ExclusionRange.md) -Deletes a range of IPv4 addresses that were previously excluded from an IPv4 scope. - -### [Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) -Removes one or more specified failover relationships. - -### [Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) -Removes the specified scopes from the failover relationship. - -### [Remove-DhcpServerv4Filter](./Remove-DhcpServerv4Filter.md) -Deletes the specified MAC address or MAC address pattern from the allow list or the deny list of the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv4Lease](./Remove-DhcpServerv4Lease.md) -Deletes the specified IPv4 address lease record from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv4OptionDefinition](./Remove-DhcpServerv4OptionDefinition.md) -Deletes one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv4OptionValue](./Remove-DhcpServerv4OptionValue.md) -Deletes one or more IPv4 option values at the server, scope or reservation level, either for the standard IPv4 options or for the specified vendor or user class. - -### [Remove-DhcpServerv4Policy](./Remove-DhcpServerv4Policy.md) -Deletes one or more specified IPv4 policies either at the server level or the specified scope level. - -### [Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) -Deletes an IP range from an existing policy at the scope level. - -### [Remove-DhcpServerv4Reservation](./Remove-DhcpServerv4Reservation.md) -Deletes the IPv4 Reservation from the specified scope. - -### [Remove-DhcpServerv4Scope](./Remove-DhcpServerv4Scope.md) -Deletes the specified IPv4 scopes from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv4Superscope](./Remove-DhcpServerv4Superscope.md) -Removes one or more specified scopes from a superscope. - -### [Remove-DhcpServerv6Class](./Remove-DhcpServerv6Class.md) -Deletes the specified IPv6 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv6ExclusionRange](./Remove-DhcpServerv6ExclusionRange.md) -Deletes a range of IPv6 addresses previously excluded from an IPv6 scope. - -### [Remove-DhcpServerv6Lease](./Remove-DhcpServerv6Lease.md) -Deletes one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv6OptionDefinition](./Remove-DhcpServerv6OptionDefinition.md) -Deletes one or more IPv6 option definitions from the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Remove-DhcpServerv6OptionValue](./Remove-DhcpServerv6OptionValue.md) -Deletes one or more DHCPv6 option values set at the reservation level, scope level, or server level, either for the standard IPv6 options or for a specified vendor class. - -### [Remove-DhcpServerv6Reservation](./Remove-DhcpServerv6Reservation.md) -Deletes one or more IPv6 reservations from the specified scope. - -### [Remove-DhcpServerv6Scope](./Remove-DhcpServerv6Scope.md) -Deletes the IPv6 Scopes from the Dynamic Host Configuration Protocol (DHCP) server service corresponding to the specified prefixes. - -### [Restore-DhcpServer](./Restore-DhcpServer.md) -Restores the database of the Dynamic Host Configuration Protocol (DHCP) server service from the specified location. - -### [Set-DhcpServerAuditLog](./Set-DhcpServerAuditLog.md) -Sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer. - -### [Set-DhcpServerDatabase](./Set-DhcpServerDatabase.md) -Modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Set-DhcpServerSetting](./Set-DhcpServerSetting.md) -Sets one or more server level configuration parameters for the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Set-DhcpServerv4Binding](./Set-DhcpServerv4Binding.md) -Sets the binding state of specified IPv4 interface for the Dynamic Host Configuration Protocol (DHCP) server service running on the specified computer. - -### [Set-DhcpServerv4Class](./Set-DhcpServerv4Class.md) -Modifies an IPv4 vendor class or user class on the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -### [Set-DhcpServerv4DnsSetting](./Set-DhcpServerv4DnsSetting.md) -Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. - -### [Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) -Modifies the properties of an existing failover relationship. - -### [Set-DhcpServerv4FilterList](./Set-DhcpServerv4FilterList.md) -Sets the enabled state for the allow and the deny MAC address filter lists on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Set-DhcpServerv4OptionDefinition](./Set-DhcpServerv4OptionDefinition.md) -Modifies the properties of an existing IPv4 option definition. - -### [Set-DhcpServerv4OptionValue](./Set-DhcpServerv4OptionValue.md) -Sets an IPv4 option value at the server, scope, or reservation level. - -### [Set-DhcpServerv4Policy](./Set-DhcpServerv4Policy.md) -Sets the properties of an existing policy either at the server level or at the specified scope level. - -### [Set-DhcpServerv4Reservation](./Set-DhcpServerv4Reservation.md) -Modifies the properties of an IPv4 reservation. - -### [Set-DhcpServerv4Scope](./Set-DhcpServerv4Scope.md) -Sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Set-DhcpServerv6Binding](./Set-DhcpServerv6Binding.md) -Sets the binding state for the specified IPv6 interface of the Dynamic Host Configuration Protocol (DHCP) server service on the computer. - -### [Set-DhcpServerv6Class](./Set-DhcpServerv6Class.md) -Modifies the properties of an IPv6 vendor or user class on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Set-DhcpServerv6DnsSetting](./Set-DhcpServerv6DnsSetting.md) -Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. - -### [Set-DhcpServerv6OptionDefinition](./Set-DhcpServerv6OptionDefinition.md) -Modifies the properties of an existing DHCPv6 option definition. - -### [Set-DhcpServerv6OptionValue](./Set-DhcpServerv6OptionValue.md) -Sets an IPv6 option value at the server, scope, or reservation level. - -### [Set-DhcpServerv6Reservation](./Set-DhcpServerv6Reservation.md) -Modifies the properties of the specified IPv6 reservation. - -### [Set-DhcpServerv6Scope](./Set-DhcpServerv6Scope.md) -Modifies the properties of the IPv6 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -### [Set-DhcpServerv6StatelessStore](./Set-DhcpServerv6StatelessStore.md) -Sets the properties of IPv6 stateless store for the specified IPv6 prefix. - diff --git a/docset/winserver2012-ps/dhcpserver/Export-DhcpServer.md b/docset/winserver2012-ps/dhcpserver/Export-DhcpServer.md deleted file mode 100644 index 691b1f2fc4..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Export-DhcpServer.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/export-dhcpserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-DhcpServer - -## SYNOPSIS -Exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file. - -## SYNTAX - -``` -Export-DhcpServer [-File] [-CimSession ] [-ComputerName ] [-Force] [-Leases] - [-Prefix ] [-ScopeId ] -``` - -## DESCRIPTION -The **Export-DhcpServer** cmdlet exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file. - -If the **ScopeId** or **Prefix** parameter is specified, then only the specified scopes or prefixes and all server level settings are exported. - -If neither **ScopeId** nor **Prefix** is specified, then the entire DHCP server service configuration including all scopes, v4 and v6 and optionally the lease data, is exported. - -If **Leases** parameter is specified, then the lease data is also exported in addition to configuration data. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -``` - -This example exports all of the DHCP server, DHCPv4 and DHCPv6, configurations including scopes present on the DHCP server service to the specified export file in XML file format. - -### EXAMPLE 2 -``` -PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -ScopeId 10.10.10.0,20.20.20.0 -``` - -This example exports the specified scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service to the specified export file in XML file format. -The DHCPv4 server level configuration will also be exported to the specified file. - -### EXAMPLE 3 -``` -PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -ScopeId 10.10.10.0,20.20.20.0 -Leases -``` - -This example exports the specified scopes 10.10.10.0 and 20.20.20.0 present on the DHCP server service to the specified export file in XML file format, including the leases present in the specified scopes. -The DHCPv4 server level configuration will also be exported to the specified file. - -### EXAMPLE 4 -``` -PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -``` - -This example exports the specified scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: present on the DHCP server service to the specified export file in XML file format. -The DHCPv6 server level configuration will also be exported to the specified file. - -### EXAMPLE 5 -``` -PS C:\> Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -Leases -``` - -This example exports the specified scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: present on the DHCP server service to the specified export file in XML file format, including the leases present in the specified scopes. -The DHCP server level configuration will also be exported to the specified file. - -### EXAMPLE 6 -``` -PS C:\> Import-Csv -Path ScopeList.txt | Export-DhcpServer -ComputerName dhcpserver.contoso.com -File C:\exportdir\dhcpexport.xml -Leases -``` - -This example exports a list of scopes specified in file named ScopeList.txt to the specified export file in XML file format. -The Import-Csvhttp://go.microsoft.com/fwlink/p/?LinkId=113341 cmdlet returns the objects containing the scope IDs output and pipes the objects into this cmdlet, which exports the specified scopes. - -The file named ScopeList.txt should contain the following format: - -ScopeId - -10.10.10.0 - -20.20.20.0 - -30.30.30.0 - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the name of the file to which the data will be exported. -If the complete file path is not specified, then the file will be created in the current working directory. -If there is an existing file by the same name, then an error will be returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that, if there is a file that already exists with the specified name, the file will be overwritten. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Leases -Specifies that IP address leases will also be exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies one or more subnet prefixes of the IPv6 scopes which are to be exported. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifiers, in IPv4 address format, which are to be exported. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Import-Csv](https://go.microsoft.com/fwlink/p/?LinkId=113341) - -[Backup-DhcpServer](./Backup-DhcpServer.md) - -[Import-DhcpServer](./Import-DhcpServer.md) - -[Restore-DhcpServer](./Restore-DhcpServer.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerAuditLog.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerAuditLog.md deleted file mode 100644 index b561ecdde2..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerAuditLog.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverauditlog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerAuditLog - -## SYNOPSIS -Gets the configuration parameters related to the audit log of the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerAuditLog [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerAuditLog** cmdlet gets the configuration parameters related to the audit log of the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerAuditLog -ComputerName dhcpserver.contoso.com -``` - -This example gets the DHCP server service audit log settings for the DHCP server service on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerAuditLog -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerAuditLog](./Set-DhcpServerAuditLog.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerDatabase.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerDatabase.md deleted file mode 100644 index 1151659f01..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerDatabase.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverdatabase?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerDatabase - -## SYNOPSIS -Gets the configuration parameters related to the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerDatabase [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerDatabase** cmdlet gets the configuration parameters related to the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerDatabase -ComputerName dhcpserver.contoso.com -``` - -This example gets the DHCP server service database settings for the DHCP server service on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerDatabase -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerDatabase](./Set-DhcpServerDatabase.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerInDC.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerInDC.md deleted file mode 100644 index 28bfc4de65..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerInDC.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverindc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerInDC - -## SYNOPSIS -Retrieves the list of authorized computers running the Dynamic Host Configuration Protocol (DHCP) server service from Active Directory (AD). - -## SYNTAX - -``` -Get-DhcpServerInDC [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerInDC** cmdlet retrieves the list of authorized computers running the Dynamic Host Configuration Protocol (DHCP) server service from Active Directory (AD). -Only a computer running a DHCP server service that is authorized in AD can lease IP addresses on the network. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerInDC -``` - -This example gets the list of all computers running the DHCP server service which are authorized in the AD domain. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerInDC[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerInDC](./Add-DhcpServerInDC.md) - -[Remove-DhcpServerInDC](./Remove-DhcpServerInDC.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerSetting.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerSetting.md deleted file mode 100644 index debc96b1f9..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerSetting.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserversetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerSetting - -## SYNOPSIS -Gets the configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerSetting [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerSetting** cmdlet gets the configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerSetting -ComputerName dhcpserver.contoso.com -``` - -This example gets the DHCP server service settings for the DHCP server service on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4DnsSetting](./Get-DhcpServerv4DnsSetting.md) - -[Get-DhcpServerv6DnsSetting](./Get-DhcpServerv6DnsSetting.md) - -[Set-DhcpServerSetting](./Set-DhcpServerSetting.md) - -[Set-DhcpServerv4DnsSetting](./Set-DhcpServerv4DnsSetting.md) - -[Set-DhcpServerv6DnsSetting](./Set-DhcpServerv6DnsSetting.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerVersion.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerVersion.md deleted file mode 100644 index f3cd9489dd..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerVersion.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverversion?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerVersion - -## SYNOPSIS -Gets the version of the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerVersion [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerVersion** cmdlet gets the major and minor version of the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### Example 1: Get version of the DHCP server service -``` -PS C:\>Get-DhcpServerVersion -ComputerName dhcpserver.contoso.com -``` - -This example gets the major and minor version of the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerVersion -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerAuditLog](./Get-DhcpServerAuditLog.md) - -[Get-DhcpServerDatabase](./Get-DhcpServerDatabase.md) - -[Get-DhcpServerSetting](./Get-DhcpServerSetting.md) diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Binding.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Binding.md deleted file mode 100644 index b637edf776..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Binding.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4binding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Binding - -## SYNOPSIS -Gets all of the IPv4 interfaces on the computer to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. - -## SYNTAX - -``` -Get-DhcpServerv4Binding [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Binding** cmdlet gets all of the IPv4 interfaces on the computer to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4Binding -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the IPv4 interfaces on the computer named dhcpserver.contoso.com to which the DHCP server service is bound. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Binding[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerv4Binding](./Set-DhcpServerv4Binding.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Class.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Class.md deleted file mode 100644 index 691171e5e7..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Class.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Class - -## SYNOPSIS -Retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv4Class [[-Name] ] [[-Type] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Class** cmdlet retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. - -If only the **Type** parameter is specified, then all classes of the specified class type are retrieved. - -If neither the **Name** nor the **Type** parameter is specified, then all of the user and vendor classes are retrieved. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-DhcpServerv4Class -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the DHCPv4 class definitions, including vendor and user, which are present on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\> Get-DhcpServerv4Class -ComputerName dhcpserver.contoso.com -Type Vendor -``` - -This example gets all of the DHCPv4 vendor class definitions which are present on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 3 -``` -PS C:\> Get-DhcpServerv4Class -ComputerName dhcpserver.contoso.com -Name MSUCClient -``` - -This example gets the DHCPv4 vendor class definition for the specified vendor class named MSUCClient on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the vendor or user class being retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class. -The acceptable values for this parameter are: Vendor or User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstanceroot/Microsoft/Windows/DHCP/DhcpServerv4Class[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Class](./Add-DhcpServerv4Class.md) - -[Remove-DhcpServerv4Class](./Remove-DhcpServerv4Class.md) - -[Set-DhcpServerv4Class](./Set-DhcpServerv4Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4DnsSetting.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4DnsSetting.md deleted file mode 100644 index 6912f8bc72..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4DnsSetting.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4dnssetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4DnsSetting - -## SYNOPSIS -Gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server level. - -## SYNTAX - -``` -Get-DhcpServerv4DnsSetting [[-ScopeId] ] [[-IPAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4DnsSetting** cmdlet gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server level. - -If neither the **ScopeId** nor **IPAddress** parameter is specified, then DNS update settings from server level are returned. - -The **ScopeId** and **IPAddress** parameters cannot both be specified. - -This cmdlet gets the effective DNS setting at the specified level such as reservation, scope, or server. -If the DNS setting value is not configured at the specified level, then the DNS settings from the level above will be fetched if configured. -If the DNS setting is not specified at the server level, then the default behavior of the DHCP server service for DNS update is returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4DnsSetting -ComputerName dhcpserver.contoso.com -``` - -This example gets the DHCPv4 server-level or server-wide DNS registration setting on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4DnsSetting -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0. -``` - -This example gets the DNS registration setting configured on the computer named dhcpserver.contoso.com for the scope 10.10.10.0. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv4DnsSetting -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.10 -``` - -This example gets the DNS registration setting configured on the computer named dhcpserver.contoso.com for the reserved IP address 10.10.10.10. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IP6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IP address of the reservation for which the DNS update settings are to be retrieved. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, for which the DNS update settings are to be retrieved. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4DnsSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerv4DnsSetting](./Set-DhcpServerv4DnsSetting.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4ExclusionRange.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4ExclusionRange.md deleted file mode 100644 index 7cfeb43155..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4ExclusionRange.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4exclusionrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4ExclusionRange - -## SYNOPSIS -Returns the IPv4 address ranges excluded from the specified scope identifiers (IDs). - -## SYNTAX - -``` -Get-DhcpServerv4ExclusionRange [[-ScopeId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4ExclusionRange** cmdlet returns the IPv4 address ranges excluded from the specified scope identifiers (IDs). -If the **ScopeId** parameter is not specified, then all IPv4 address ranges excluded on the Dynamic Host Configuration Protocol (DHCP) server service are returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4ExclusionRange -ComputerName dhcpserver.contoso.com -``` - -This example gets all the excluded IPv4 address ranges on the specified DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4ExclusionRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example gets all the excluded IPv4 address ranges in the specified scope on the specified DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope IDs, in IPv4 address format, from which the excluded IP address ranges should be returned. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ExclusionRange[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4ExclusionRange](./Add-DhcpServerv4ExclusionRange.md) - -[Remove-DhcpServerv4ExclusionRange](./Remove-DhcpServerv4ExclusionRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Failover.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Failover.md deleted file mode 100644 index 494472338e..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Failover.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4failover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Failover - -## SYNOPSIS -Gets the failover relationships configured on the Dynamic Host Configuration Protocol (DHCP) server service for the specific failover relationship name. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-DhcpServerv4Failover [[-Name] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-DhcpServerv4Failover [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -ScopeId -``` - -## DESCRIPTION -The **Get-DhcpServerv4Failover** cmdlet gets the failover relationships configured on the Dynamic Host Configuration Protocol (DHCP) server service for the specific failover relationship name. -If the **Name** parameter is not specified, then this cmdlet returns all failover relationships defined on the DHCP server service. -If the **Name** parameter does not match a failover relationship, then a non-terminating error will be returned for the specific **Name** parameter value. - -If the **ScopeId** parameter is specified, then the failover relationships of which the specified scopes are included are returned. -The **ScopeId** parameter values should be failover scopes. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -``` - -This example gets the failover relationship information for relationship named SFO-SIN-Failover on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\> Get-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -``` - -This example gets the failover relationship information for all of the failover relationships on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 3 -``` -PS C:\> Get-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example gets the failover relationship information for the failover relationship of which the scope 10.10.10.0 is a part, on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies one or more names of failover relationships for which the properties are returned. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies one or more scope identifiers (IDs), in IPv4 address format. -The properties of the failover relationships on the DHCP server service to which these scopes are associated are returned. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) - -[Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) - -[Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) - -[Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) - -[Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) - -[Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Filter.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Filter.md deleted file mode 100644 index e60f071547..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Filter.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4filter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Filter - -## SYNOPSIS -Gets the list of all MAC addresses from the allow list or the deny list on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv4Filter [[-List] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Filter** cmdlet gets the list of all MAC addresses from the allow list or the deny list on the Dynamic Host Configuration Protocol (DHCP) server service. - -If the **List** parameter is not specified, both allow and deny filters are returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4Filter -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the MAC addresses in the allowed and denied lists configured on the DHCP server service on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -List -Specifies the list from which one or more MAC addresses are to be retrieved. -The acceptable values for this parameter are: Allow or Deny. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Filter](./Add-DhcpServerv4Filter.md) - -[Get-DhcpServerv4FilterList](./Get-DhcpServerv4FilterList.md) - -[Remove-DhcpServerv4Filter](./Remove-DhcpServerv4Filter.md) - -[Set-DhcpServerv4FilterList](./Set-DhcpServerv4FilterList.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4FilterList.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4FilterList.md deleted file mode 100644 index 36ea49b21f..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4FilterList.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4filterlist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4FilterList - -## SYNOPSIS -Gets the enabled state of the allow filter list and deny filter list set on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv4FilterList [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4FilterList** cmdlet gets the enabled state of the allow filter list and deny filter list set on the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4FilterList -ComputerName dhcpserver.contoso.com -``` - -This example gets the enabled state of the allow and deny filter lists set on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4FilterList -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerv4FilterList](./Set-DhcpServerv4FilterList.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4FreeIPAddress.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4FreeIPAddress.md deleted file mode 100644 index 1c5211554c..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4FreeIPAddress.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4freeipaddress?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4FreeIPAddress - -## SYNOPSIS -Gets one or more free, or unassigned, IPv4 Addresses from the specified scope. - -## SYNTAX - -``` -Get-DhcpServerv4FreeIPAddress [-ScopeId] [[-NumAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-EndAddress ] [-StartAddress ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -This **Get-DhcpServerv4FreeIPAddress** cmdlet gets one or more free IP Addresses from the specified scope. - -If the *NumAddress* parameter is specified, then the requested number of free IPv4 addresses is returned. -If the *NumAddress* parameter is not specified, then a single free IP address will be returned. -The maximum number of free IP addresses returned is capped at `1024`. - -If the *StartAddress* parameter is specified and the *EndAddress* parameter is not specified, then the free IP addresses starting from the specified *StartAddress* parameter value through the end of the IP address range of the scope are returned. - -If the *EndAddress* parameter is specified and the *StartAddress* parameter is not specified, then the free IP addresses starting from the beginning of the IP address range of the scope through the specified *EndAddress* parameter value are returned. - -If both the *StartAddress** and *EndAddress* parameters are specified, then the free IP addresses between the specified *StartAddress* and *EndAddress* parameter values are returned. - -The exclusion address ranges, reservations, active, offered, and bad, or declined, leases are excluded while returning the free IP addresses. - -The IP address ranges associated with a policy will be included while returning the free IP addresses. - -The IP addresses which are in expired, or doomed, state will be included while returning the free IP addresses. - -If the requested number of free IP addresses could not be found, then a warning is displayed. - -## EXAMPLES - -### Example 1: Get a free address -``` -PS C:\>Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example gets a free IPv4 addresses from the specified scope. - -### Example 2: Get ten free addresses -``` -PS C:\>Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -NumAddress 10 -``` - -This example gets a list of 10 free IPv4 addresses from the specified scope. - -### Example 3: Get a free address from a range -``` -PS C:\>Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -StartAddress 10.10.10.10 -EndAddress 10.10.10.50 -``` - -This example gets a free IPv4 address from the specified scope within the IP address range from 10.10.10.10 through 10.10.10.50. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndAddress -Specifies the ending IP address of the range from which the free IP addresses are to be returned. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumAddress -Specifies the number of free IP addresses requested. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, from which one or more free IP addresses are requested. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartAddress -Specifies the starting IP address of the range from which the free IP addresses are to be returned. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### System.String[] - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6FreeIPAddress](./Get-DhcpServerv6FreeIPAddress.md) diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Lease.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Lease.md deleted file mode 100644 index c155f4ceb9..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Lease.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4lease?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Lease - -## SYNOPSIS -Gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### ScopeId (Default) -``` -Get-DhcpServerv4Lease [-ScopeId] [-AllLeases] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -### IPAddress -``` -Get-DhcpServerv4Lease [[-ScopeId] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] [-BadLeases] -``` - -### ClientId -``` -Get-DhcpServerv4Lease [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] - -IPAddress -``` - -### BadLeases -``` -Get-DhcpServerv4Lease [-ScopeId] [-ClientId] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Lease** cmdlet gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -If you specify the *ScopeId* parameter, the active leases from the specified scope are returned. -To get all kinds of leases including Active, Offered, Declined, and Expired, the *AllLeases* parameter must be specified. - -If you specify the *IPAddress* parameter, the lease records for the specified IP address are returned. - -If you specify the *ClientId* and *ScopeId* parameters, the leases for the specified *ClientId* parameter values in the specified scope are returned. - -If you specify the *BadLeases* and *ScopeId* parameters, all of the bad lease records for the specified scope are returned. - -If you specify the *BadLeases* parameter without the *ScopeId* parameter, all of the bad lease records from the DHCP server service are returned. - -## EXAMPLES - -### Example 1: Get all active leases in a scope -```powershell -PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -``` - -This example gets all the active IPv4 address leases from the DHCPv4 scope 10.10.10.0. - -### Example 2: Get leases for specified addresses -```powershell -PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -IPAddress 10.10.10.10,10.20.20.20 -``` - -This example gets the IP address lease information for the IPv4 addresses 10.10.10.10 and 10.20.20.20. - -### Example 3: Get declined leases -```powershell -PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -BadLeases -``` - -This example gets all the bad, or declined, IPv4 address leases from the DHCPv4 scope 10.10.10.0. - -### Example 4: Get leases for specified clients -```powershell -PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -ClientId "F0-DE-F1-7A-00-5E", "00-24-D7-C5-25-B0" -``` - -This example gets the IPv4 address leases from the DHCPv4 scope 10.10.10.0 for the clients identified by the client IDs F0-DE-F1-7A-00-5E and 00-24-D7-C5-25-B0. - -### Example 5: Get all leases in a scope -```powershell -PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -AllLeases -``` - -This example gets all of the types of IPv4 address leases including Active, Declined, and Expired from the DHCPv4 scope 10.10.10.0. - -### Example 6: Get active leases from all scopes on a computer -```powershell -PS C:\> Get-DhcpServerv4Scope -ComputerName "dhcpserver.contoso.com" | Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -``` - -This example gets all of the active IP address leases from all of the scopes on the DHCP server service that runs on the computer named dhcpserver.contoso.com. -The **Get-DhcpServerv4Scope** cmdlet returns the scope objects and pipes the objects into this cmdlet which returns the active address lease objects from all the scopes. - -## PARAMETERS - -### -AllLeases -Specifies that all of the IPv4 address leases regardless of address state are returned. - -If not specified, then only active leases are returned. - -```yaml -Type: SwitchParameter -Parameter Sets: ScopeId (Default) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadLeases -Specifies that only bad leases are returned. -If an IP address lease is declined by the client because of a conflict with another client, then the lease record is marked as bad, or declined, by the DHCP server service. - -An IP address lease in this state is not offered to any client until expiry of a timer, which is 10 minutes. - -```yaml -Type: SwitchParameter -Parameter Sets: IPAddress -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies the client identifier (ID) for which the IP address lease record is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: BadLeases -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IP address for which the lease record is to be retrieved. - -```yaml -Type: IPAddress[] -Parameter Sets: ClientId -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format from which the IPv4 address leases are being retrieved. - -```yaml -Type: IPAddress -Parameter Sets: ScopeId (Default), BadLeases -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: IPAddress -Parameter Sets: IPAddress -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Lease](./Add-DhcpServerv4Lease.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Remove-DhcpServerv4Lease](./Remove-DhcpServerv4Lease.md) diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4OptionDefinition.md deleted file mode 100644 index df8957bee1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4OptionDefinition.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4OptionDefinition - -## SYNOPSIS -Gets the DHCPv4 option definition for the specified option identifiers (IDs). - -## SYNTAX - -``` -Get-DhcpServerv4OptionDefinition [[-OptionId] ] [[-VendorClass] ] [-All] [-AsJob] - [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4OptionDefinition** cmdlet gets the DHCPv4 option definitions for the specified option identifiers (IDs). - -If the **OptionId** parameter is not specified, then all of the option definitions, which are not vendor specific, are returned. -The **VendorClass** parameter acts as a filter for option definitions for the specified vendor class only. - -If the **All** parameter is specified, then all of the option definitions including the vendor class specific option definitions will be returned. - -If the **All** and **OptionId** parameters are specified, then all of the option definitions including the vendor class specific option definitions with the specified option ID will be returned. - -If the **All** and the **VendorClass** parameters are specified, then the **All** parameter is ignored. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -``` - -This example gets the standard, or non-vendor specific, DHCPv4 option definitions on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -All -``` - -This example gets all of the DHCPv4 option definitions including vendor specific option definition present on the DHCP server service. - -### EXAMPLE 3 -``` -PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -OptionId 23 -``` - -This example gets the DHCPv4 option definition for the specified option. - -### EXAMPLE 4 -``` -PS C:\> Get-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -VendorClass "Microsoft Windows Options" -``` - -This example gets all the DHCPv4 option definitions for the specified vendor class. - -## PARAMETERS - -### -All -Gets all of the option definitions on the DHCP server service including vendor specific option definitions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numerical identifiers of the options for which the option definitions are requested. -If nothing is specified, then all of the DHCPv4 option definitions are returned. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorClass -Returns the option definitions only for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4OptionDefinition](./Add-DhcpServerv4OptionDefinition.md) - -[Remove-DhcpServerv4OptionDefinition](./Remove-DhcpServerv4OptionDefinition.md) - -[Set-DhcpServerv4OptionDefinition](./Set-DhcpServerv4OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4OptionValue.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4OptionValue.md deleted file mode 100644 index 83a4e5ad5c..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4OptionValue.md +++ /dev/null @@ -1,346 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4optionvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4OptionValue - -## SYNOPSIS -Returns the IPv4 option Values for one or more IPv4 options at the server, scope or reservation level. - -## SYNTAX - -``` -Get-DhcpServerv4OptionValue [[-OptionId] ] [[-ScopeId] ] [-All] [-AsJob] [-Brief] - [-CimSession ] [-ComputerName ] [-PolicyName ] [-ReservedIP ] - [-ThrottleLimit ] [-UserClass ] [-VendorClass ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4OptionValue** cmdlet returns the IPv4 option values for one or more IPv4 options at the server, scope or reservation level. -Use the **VendorClass** and **UserClass** parameters to get option values for a specific vendor class or for a specific user class. -If the **OptionId** parameter is not specified, then this cmdlet returns the option values for all the options configured at the specified level either the server, the scope, or the reservation level. - -If only the **ReservedIP** parameter is specified, then the option values set at the rReservation level are returned. -If only the **ScopeId** parameter is specified, then the option values set at the scope level are returned. -If neither the **ScopeId** nor the **ReservedIP** parameter are specified, then option values set at the server level are returned. -The **ScopeId** and **ReservedIP** parameters cannot both be specified. - -If neither the **VendorClass** nor **UserClass** parameter is specified, then this cmdlet gets the standard option values set. - -The **PolicyName** and **UserClass** parameters cannot both be specified. - -The **PolicyName** parameter cannot be specified if the **ReservedIP** parameter is specified. - -Note: The option values for policies only exist for DHCP server services running on Windows Server® 2012. -For older versions, only user class based option values exist. - -To get legacy user class options, the **UserClass** parameter must be specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -``` - -This example gets all the standard DHCPv4 option values, or non-class specific, configured at the server level. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example gets all the standard DHCPv4 option values, or non-class specific, configured for the specified scope. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 10.10.10.5 -``` - -This example gets all of the standard DHCPv4 option values, or non-class specific, configured for the specified reservation. - -### EXAMPLE 4 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -VendorClass MSUCClient -``` - -This example gets all of the vendor class specific DHCPv4 option values configured on the specified scope for the specified vendor class. - -### EXAMPLE 5 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -OptionId 23 -``` - -This example gets the DHCPv4 option value configured on the specified scope for the specified option ID. - -### EXAMPLE 6 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -All -``` - -This example gets all of the DHCPv4 option values, including standard as well as vendor class or user class specific, configured on the specified scope. - -### EXAMPLE 7 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Brief -``` - -This example gets all of the standard DHCPv4 option values configured on the specified scope. -The object that is returned does not contain the name of the option. -The **Brief** parameter increase the performance by removing the delay required to get the name of the option from the DHCP server service. - -### EXAMPLE 8 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -UserClass LabComputer -``` - -This example gets all of the user class specific DHCPv4 option values configured on the specified scope for the specified user class. - -### EXAMPLE 9 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Policy SmartPhonePolicy -``` - -This example gets all of the standard DHCPv4 option values configured on the specified scope for the specified policy. - -### EXAMPLE 10 -``` -PS C:\>Get-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Policy SmartPhonePolicy -VendorClass "HTC Phone" -``` - -This example gets all of the standard, or non-class specific, DHCPv4 option values configured on the specified scope for the specified policy and vendor class. - -## PARAMETERS - -### -All -Gets the option values for a scope, server, or reservation. -Option values can include vendor class, user class, and policy specific. - -If only this parameter is specified, then this cmdlet will get all of the option values for a scope, server, or reservation. - -If the **OptionId** parameter and this parameter are specified, then option values for the specified option identifier (ID) for all of the vendor classes, user classes and policies will be returned. - -If the **VendorClass** parameter and this parameter are specified, then all of the option values for the specified vendor class including those for any user class or policy would be returned. - -If the **UserClass** parameter and this parameter are specified, then all of the option values for the specified user class including any vendor specific options would be returned. - -If the **PolicyName** parameter and this parameter are specified, then all of the option values for the specified policy including any vendor specific options would be returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Brief -Specifies that the name of the option is not returned in the option value object. -This parameter improves the performance of this cmdlet by not requesting the name of the option from the DHCP server service. -For repeatedly fetching a large number of option values with this cmdlet use of the **Brief** parameter is recommended. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numerical IDs of the options being requested. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy for which one or more option values are requested. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservedIP -Specifies the IPv4 address of the reservation for which the option values are requested. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the ID of the scope, in IP address format, for which one or more option values are requested. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Gets the option values for that user class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Gets the option values for that vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstanceroot/Microsoft/Windows/DHCP/DhcpServerv4OptionValue[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Remove-DhcpServerv4OptionValue](./Remove-DhcpServerv4OptionValue.md) - -[Set-DhcpServerv4OptionValue](./Set-DhcpServerv4OptionValue.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Policy.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Policy.md deleted file mode 100644 index ecead28788..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Policy.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4policy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Policy - -## SYNOPSIS -Gets one or more policies at the server level or the scope level. - -## SYNTAX - -``` -Get-DhcpServerv4Policy [[-Name] ] [[-ScopeId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Policy** cmdlet gets one or more policies at the server level or the scope level. - -If the **Name** and **ScopeId** parameters are specified, then the policy from the specified scope is retrieved. - -If only the **ScopeId** parameter is specified, then all of the policies in the specified scope are retrieved. - -If only the **Name** parameter is specified, then that specific server level policy is retrieved. - -If neither the **Name** nor the **ScopeId** parameter is specified, then all of the server level policies are retrieved. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name PrinterPolicy -``` - -This example gets the policy properties for the policy named PrinterPolicy that is defined as a server level, or server-wide, policy. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name HyperVPolicy -ScopeId 10.10.10.0 -``` - -This example gets the policy properties for the policy named HyperVPolicy that is defined inside the scope 10.10.10.0. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies one or more names of the policies to be returned. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier, in IPv4 address format, from which the policies are to be retrieved. - -If this parameter is not specified, then the server level policies are retrieved. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Policy](./Add-DhcpServerv4Policy.md) - -[Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) - -[Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) - -[Remove-DhcpServerv4Policy](./Remove-DhcpServerv4Policy.md) - -[Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) - -[Set-DhcpServerv4Policy](./Set-DhcpServerv4Policy.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4PolicyIPRange.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4PolicyIPRange.md deleted file mode 100644 index 47b203f06e..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4PolicyIPRange.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4policyiprange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4PolicyIPRange - -## SYNOPSIS -Gets one or more IP ranges from a policy in the specified scope. - -## SYNTAX - -``` -Get-DhcpServerv4PolicyIPRange [-ScopeId] [[-Name] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4PolicyIPRange** cmdlet gets one or more IP ranges from a policy in the specified scope. -If the **Name** parameter is not specified, then this cmdlet gets the IP ranges for all policies in the specified scope. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4PolicyIPRange -ScopeId 10.10.10.0 -Name HyperVPolicy -``` - -This example gets the IP address ranges associated with policy named HyperVPolicy that is defined inside the scope 10.10.10.0. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4PolicyIPRange -ScopeId 10.10.10.0 -``` - -This example gets all of the IP address ranges associated with any policy defined inside the scope 10.10.10.0. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy for which the associated IP ranges are to be returned. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier, in IPv4 address format, which contains the specified policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4PolicyIPRange[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) - -[Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Reservation.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Reservation.md deleted file mode 100644 index 21f4ca972c..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Reservation.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Reservation - -## SYNOPSIS -Gets one or more IPv4 reservations for the specified IP addresses or client identifiers (IDs). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-DhcpServerv4Reservation [-ScopeId] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-DhcpServerv4Reservation [-ScopeId] [-ClientId] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-DhcpServerv4Reservation [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -IPAddress -``` - -## DESCRIPTION -The **Get-DhcpServerv4Reservation** cmdlet gets one or more IPv4 reservations for the specified IP addresses or client identifiers (IDs). -If only the **ScopeId** parameter is specified, then all of the IPv4 reservations from the specified scope are returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0. -``` - -This cmdlet gets all of the reservations present in the specified scope on the specified DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -ClientId F0-DE-F1-7A-00-5E -``` - -This cmdlet gets the reservation present in the specified scope for specified client ID. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.5 -``` - -This cmdlet gets the reservation information for specified IP address. - -### EXAMPLE 4 -``` -PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Get-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -``` - -This cmdlet gets all the reserved IP addresses from all of the scopes on the server dhcpserver.contoso.com. -The Get-DhcpServerv4Scope cmdlet returns all of the scope objects and pipes the objects into this cmdlet, which returns the reservations from all the scopes. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies one or more client IDs of the reservations which need to be retrieved. -For Windows clients, the MAC address is the client ID. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies one or more IPv4 addresses of the reservations which are to be retrieved. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format, from which the reservations are to be retrieved. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Reservation](./Add-DhcpServerv4Reservation.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Remove-DhcpServerv4Reservation](./Remove-DhcpServerv4Reservation.md) - -[Set-DhcpServerv4Reservation](./Set-DhcpServerv4Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Scope.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Scope.md deleted file mode 100644 index 09a25f27cf..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Scope.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Scope - -## SYNOPSIS -Returns the IPv4 scope configuration of the specified scopes. - -## SYNTAX - -``` -Get-DhcpServerv4Scope [[-ScopeId] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Scope** cmdlet returns the IPv4 scope configuration of the specified scopes. -If the **ScopeId** parameter is not specified, then all of the scopes configured on the Dynamic Host Configuration Protocol (DHCP) server service are returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the scopes present on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example gets the specified scope present on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies one or more scope identifiers (IDs), in IPv4 address format, from which the configuration is to be retrieved. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Scope](./Add-DhcpServerv4Scope.md) - -[Get-DhcpServerv4ScopeStatistics](./Get-DhcpServerv4ScopeStatistics.md) - -[Remove-DhcpServerv4Scope](./Remove-DhcpServerv4Scope.md) - -[Set-DhcpServerv4Scope](./Set-DhcpServerv4Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4ScopeStatistics.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4ScopeStatistics.md deleted file mode 100644 index 3a0b676dbd..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4ScopeStatistics.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4scopestatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4ScopeStatistics - -## SYNOPSIS -Gets the IPv4 scope statistics corresponding to the IPv4 scope identifiers (IDs) specified for a Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv4ScopeStatistics [[-ScopeId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-Failover] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4ScopeStatistics** cmdlet gets the scope statistics corresponding to the IPv4 scope identifiers (IDs) specified for a Dynamic Host Configuration Protocol (DHCP) server service. -If the **ScopeId** parameter is not specified, then this cmdlet gets the statistics for all of the IPv4 scopes. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4ScopeStatistics -ComputerName dhcpServer.contoso.com -``` - -This example gets the scope statistics for all the scopes present on the specified DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4ScopeStatistics -ComputerName dhcpServer.contoso.com -ScopeId 10.10.10.0 -``` - -This example gets the scope statistics for the specified scope on the specified DHCP server service. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv4ScopeStatistics -ComputerName dhcpServer.contoso.com -ScopeId 10.10.10.0 -Failover -``` - -This example gets the scope statistics including those related to failover, if the scope is part of a failover relationship, for the specified scope on the specified DHCP server service. - -### EXAMPLE 4 -``` -PS C:\>Get-DhcpServerv4ScopeStatistics -ComputerName dhcpServer.contoso.com -Failover -``` - -This example gets the scope statistics including those related to failover, if the scope is part of a failover relationship, for all of the scopes present on the specified DHCP server service. - -### EXAMPLE 5 -``` -PS C:\>Get-DhcpServerv4ScopeStatistics -ComputerName dhcpServer.contoso.com | Where-Object -FilterScript { $_.PercentageInUse -Gt 80 } -``` - -This example gets the scope statistics for the scopes present on the specified DHCP server service, which have more than 80% of their IP address range exhausted. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Failover -Specifies that, if the scope is configured for failover, the failover related scope statistics are returned as part of the scope statistics. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope IDs, in IPv4 address format, for which the statistics are returned. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ScopeStatistics[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkId=113423) - -[Add-DhcpServerv4Scope](./Add-DhcpServerv4Scope.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Remove-DhcpServerv4Scope](./Remove-DhcpServerv4Scope.md) - -[Set-DhcpServerv4Scope](./Set-DhcpServerv4Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Statistics.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Statistics.md deleted file mode 100644 index 9b5b68c9db..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Statistics.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4statistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Statistics - -## SYNOPSIS -Gets Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv4. - -## SYNTAX - -``` -Get-DhcpServerv4Statistics [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4Statistics** cmdlet gets Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv4. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4Statistics -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the DHCPv4 server service statistics for the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Statistics -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4ScopeStatistics](./Get-DhcpServerv4ScopeStatistics.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Superscope.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Superscope.md deleted file mode 100644 index 1691bc401c..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv4Superscope.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv4superscope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv4Superscope - -## SYNOPSIS -Gets the configuration for the specified superscope. - -## SYNTAX - -``` -Get-DhcpServerv4Superscope [[-SuperscopeName] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv4SuperScope** cmdlet gets the configuration for the specified superscope. -If the **SuperscopeName** parameter is not specified, then all of the superscopes present on the Dynamic Host Configuration Protocol (DHCP) server service are returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv4SuperScope -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the superscopes and the associated scopes on the specified DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv4SuperScope -ComputerName dhcpserver.contoso.com -SuperscopeName ExtendedLabNet -``` - -This example gets the configuration for the superscope named ExtendedLabNet and the associated scopes on the specified DHCP server service on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuperscopeName -Specifies the name of the superscopes whose configuration needs to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Superscope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Superscope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Superscope](./Add-DhcpServerv4Superscope.md) - -[Remove-DhcpServerv4Superscope](./Remove-DhcpServerv4Superscope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Binding.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Binding.md deleted file mode 100644 index 7d0e764d92..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Binding.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6binding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6Binding - -## SYNOPSIS -Returns the IPv6 interfaces to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. - -## SYNTAX - -``` -Get-DhcpServerv6Binding [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6Binding** cmdlet returns the IPv6 interfaces to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6Binding -ComputerName dhcpserver.contoso.com -``` - -This example gets the IPv6 interface to which the DHCP server service is bound. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Binding[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerv6Binding](./Set-DhcpServerv6Binding.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Class.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Class.md deleted file mode 100644 index 1b01096e06..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Class.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6Class - -## SYNOPSIS -Gets the IPv6 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv6Class [[-Name] ] [[-Type] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6Class** cmdlet gets the IPv6 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. - -If only the **Type** parameter is specified, then all of the classes of the specified class type on the DHCP server service are retrieved. - -If neither the **Name** nor the **Type** parameter is specified, then all of the user and vendor classes on the DHCP server service are retrieved. - -If only the **Name** parameter is specified, then the class for that **Name** parameter value will be returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6Class -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the DHCPv6 class definitions, both vendor and user, which are present on the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6Class -ComputerName dhcpserver.contoso.com -Type Vendor -``` - -This example gets all of the DHCPv6 vendor class definitions which are present on the DHCP server service. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv6Class -ComputerName dhcpserver.contoso.com -Name MSUCClient -``` - -This example gets the DHCPv6 vendor class definition for the vendor class named MSUCClient. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the vendor or user class which is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class. -The acceptable values for this parameter are: Vendor or User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Class](./Add-DhcpServerv6Class.md) - -[Remove-DhcpServerv6Class](./Remove-DhcpServerv6Class.md) - -[Set-DhcpServerv6Class](./Set-DhcpServerv6Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6DnsSetting.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6DnsSetting.md deleted file mode 100644 index 985455e9a3..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6DnsSetting.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6dnssetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6DnsSetting - -## SYNOPSIS -Gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server-wide. - -## SYNTAX - -``` -Get-DhcpServerv6DnsSetting [[-Prefix] ] [[-IPAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6DnsSetting** cmdlet gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server-wide. - -If neither the **Prefix** nor **IPAddress** parameter is specified, then the DNS settings at the server level are retrieved. -The **Prefix** and **IPAddress** parameters cannot both be specified. -If the **Prefix** or **IPAddress** parameter is specified, then this cmdlet gets the effective DNS setting at the specified level such as reservation, scope, or server. -If the DNS setting value is not configured at the specified level, then the DNS settings from the level above will be retrieved if configured. -If the DNS setting is not specified at the server level, then the default behavior of the DHCP server service such as DNS update is returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -``` - -This example gets the DHCPv6 server-level or server-wide DNS registration setting. - -### EXAMPLE 2 -``` -PS C:\> Get-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets the DNS registration setting configured for the scope 2001:4898:7020:1020::. - -### EXAMPLE 3 -``` -PS C:\> Get-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::10 -``` - -This example gets the DNS registration setting configured for the reserved IP address 2001:4898:7020:1020:10. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv6 address of the reservation for which the DNS settings are to be retrieved. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Prefix -Specifies the subnet prefix of the IPv6 scope for which the DNS settings are to be retrieved. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6DnsSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerv6DnsSetting](./Set-DhcpServerv6DnsSetting.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6ExclusionRange.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6ExclusionRange.md deleted file mode 100644 index 8cd273de15..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6ExclusionRange.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6exclusionrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6ExclusionRange - -## SYNOPSIS -Gets the IPv6 address ranges excluded from the specified IPv6 subnet prefix. - -## SYNTAX - -``` -Get-DhcpServerv6ExclusionRange [[-Prefix] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6ExclusionRange** cmdlet gets the IPv6 address ranges excluded from the specified IPv6 subnet prefix. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6ExclusionRange -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the IPv6 address ranges which have been excluded from all of the DHCPv6 scopes on the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6ExclusionRange -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets all of the IPv6 address ranges which have been excluded from the specified DHCPv6 scope. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefixes of the scopes for which the exclusion ranges are requested. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6ExclusionRange[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6ExclusionRange](./Add-DhcpServerv6ExclusionRange.md) - -[Remove-DhcpServerv6ExclusionRange](./Remove-DhcpServerv6ExclusionRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6FreeIPAddress.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6FreeIPAddress.md deleted file mode 100644 index 0be14e41bb..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6FreeIPAddress.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6freeipaddress?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6FreeIPAddress - -## SYNOPSIS -Gets one or more free, or unassigned, IPv6 addresses from the specified scope. - -## SYNTAX - -``` -Get-DhcpServerv6FreeIPAddress [-Prefix] [[-NumAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-EndAddress ] [-StartAddress ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6FreeIPAddress** cmdlet gets one or more free IPv6 addresses from the specified scope. - -If the *NumAddress* parameter is specified, then the requested number of free IPv6 addresses is returned. -If the *NumAddress* parameter is not specified, then a single free IPv6 address will be returned. -The maximum number of free IPv6 addresses returned is capped at `1024`. - -If the *StartAddress* parameter is specified and the *EndAddress* parameter is not specified, then the free IPv6 addresses starting from the specified *StartAddress* parameter value through the ending of the IPv6 address range of the scope are returned. - -If the *EndAddress* parameter is specified and the *StartAddress* parameter is not specified, then the free IPv6 addresses starting from the beginning of the IPv6 address range of the scope through the specified *EndAddress* parameter value are returned. - -If both of the *StartAddress* and *EndAddress* parameters are specified, then the free IPv6 addresses between the specified *StartAddress* and *EndAddress* parameter values are returned. - -The exclusion address ranges, reservations, active, offered and bad, or declined, leases are excluded while returning free IPv6 addresses. - -The IPv6 address ranges associated with a policy will be included while returning free IPv6 addresses. - -The IPv6 addresses which are in expired, or doomed, state will be included while returning free IPv6 addresses. - -If the requested number of free IPv6 addresses could not be found, then a warning is displayed. - -## EXAMPLES - -### Example 1: Get a free address -``` -PS C:\>Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets a free IPv6 address from the specified scope. - -### Example 2: Get ten free addresses -``` -PS C:\>Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -NumAddress 10 -``` - -This example gets a list of 10 free IPv6 addresses from the specified scope. - -### Example 3: Get a free address from a range -``` -PS C:\>Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -StartAddress 2001:4898:7020:1020::10 -EndAddress 2001:4898:7020:1020::50 -``` - -This example gets a free IPv6 address from the specified scope within the IP address range from 2001:4898:7020:1020::10 through 2001:4898:7020:1020::50. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndAddress -Specifies the ending IPv6 address of the range from which the free IPv6 addresses are to be returned. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumAddress -Specifies the number of free IPv6 addresses requested. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: 1 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope from which one or more free IPv6 addresses are requested. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartAddress -Specifies the starting IPv6 address of the range from which the free IPv6 addresses are to be returned. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### System.String[] - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4FreeIPAddress](./Get-DhcpServerv4FreeIPAddress.md) diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Lease.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Lease.md deleted file mode 100644 index 28e50a8bfc..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Lease.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6lease?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6Lease - -## SYNOPSIS -Gets one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-DhcpServerv6Lease [-Prefix] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-DhcpServerv6Lease [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] - -IPAddress -``` - -## DESCRIPTION -The **Get-DhcpServerv6Lease** cmdlet gets one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -If the **Prefix** parameter is specified, then the leases in the specified scope are retrieved. - -If the **IPAddress** parameter is specified, then the lease for the specified IPv6 address is retrieved. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets all of the IP address lease from the DHCPv6 scope 2001:4898:7020:1020::. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::10 -``` - -This example gets the IP address lease information for the IPv6 address 2001:4898:7020:1020::10. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies one or more IPv6 addresses for which the lease records are to be retrieved. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Prefix -Specifies the subnet prefix of the scope from which the lease records are to be retrieved. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Lease[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Lease](./Add-DhcpServerv6Lease.md) - -[Remove-DhcpServerv6Lease](./Remove-DhcpServerv6Lease.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6OptionDefinition.md deleted file mode 100644 index 701716b239..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6OptionDefinition.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6OptionDefinition - -## SYNOPSIS -Gets the option definition for the option identified by the option identifier (ID). - -## SYNTAX - -``` -Get-DhcpServerv6OptionDefinition [[-OptionId] ] [[-VendorClass] ] [-All] [-AsJob] - [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6OptionDefintion** cmdlet gets the option definition for the option identified by the option identifier (ID). -If the **OptionId** parameter is not specified, then all of the option definitions will be returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-DhcpServerv6OptionDefinition -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the DHCPv6 option definitions present on the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\> Get-DhcpServerv6OptionDefinition -ComputerName dhcpserver.contoso.com -OptionId 21,24 -``` - -This example gets the DHCPv6 option definitions for the specified option IDs. - -### EXAMPLE 3 -``` -PS C:\> Get-DhcpServerv6OptionDefinition -ComputerName dhcpserver.contoso.com -VendorClass MyVendorClass -``` - -This example gets all of the DHCPv6 option definitions for the specified vendor class. - -## PARAMETERS - -### -All -Gets all of the option definitions on the DHCPv6 server service. -Option definitions which are vendor class specific will also be returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numeric ID of the option. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorClass -Returns the option definitions only for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/Dhcpv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/Dhcpv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6OptionDefinition](./Add-DhcpServerv6OptionDefinition.md) - -[Remove-DhcpServerv6OptionDefinition](./Remove-DhcpServerv6OptionDefinition.md) - -[Set-DhcpServerv6OptionDefinition](./Set-DhcpServerv6OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6OptionValue.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6OptionValue.md deleted file mode 100644 index c64ff8436e..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6OptionValue.md +++ /dev/null @@ -1,308 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6optionvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6OptionValue - -## SYNOPSIS -Returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope or, server level. - -## SYNTAX - -``` -Get-DhcpServerv6OptionValue [[-OptionId] ] [[-Prefix] ] [-All] [-AsJob] [-Brief] - [-CimSession ] [-ComputerName ] [-ReservedIP ] [-ThrottleLimit ] - [-UserClass ] [-VendorClass ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6OptionValue** cmdlet returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope, or server level. -The option identifier (ID) can be a standard option or for a specified vendor class. -If the **OptionId** parameter is not specified, then all option values at the requested level, such as reservation, scope, server, are returned. - -If the **ReservedIP** parameter is specified, then the option values set at the reservation level are returned. -If the **Prefix** parameter is specified, then the option values set at the specified scope level are returned. -If neither the **Prefix** nor the **ReservedIP** parameter is specified, then the option values set at the server level are returned. -The **Prefix** and **ReservedIP** parameters cannot both be specified. - -If neither the **VendorClass** nor the **UserClass** parameter is specified, then this cmdlet returns the standard option values. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the standard DHCPv6 option values, non-class specific, configured at the server level. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets all of the standard DHCPv6 option values, non-class specific, configured for the specified scope. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 2001:4898:7020:1020::5 -``` - -This example gets all of the standard DHCPv6 option values, non-class specific, configured for the specified reservation. - -### EXAMPLE 4 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -VendorClass MSUCClient -``` - -This example gets all of the vendor class specific DHCPv6 option values configured on the specified scope for the specified vendor class. - -### EXAMPLE 5 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -OptionId 23 -``` - -This example gets the DHCPv6 option value configured on the specified scope for the specified option identifier. - -### EXAMPLE 6 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -All -``` - -This example gets all of the DHCPv6 option values configured on the specified scope. -The DHCPv6 option values that are returned include the standard as well as vendor class or user class specific options. - -### EXAMPLE 7 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Brief -``` - -This example gets all of the standard DHCPv6 option values configured on the specified scope. -The object that is returned does not contain the name of the option. -The **Brief** parameter improves the performance of this cmdlet by not requesting the name of the option from the DHCP server service. - -### EXAMPLE 8 -``` -PS C:\>Get-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -UserClass LabComputer -``` - -This example gets all of the user class specific DHCPv6 option values configured on the specified scope for the specified user class. - -## PARAMETERS - -### -All -Gets the option values for a scope, server, or reservation. -Option values can include vendor class and user class specific. - -If only this parameter is specified, then this cmdlet will get all of the option values for the specified scope, reservation, or server. - -If the **OptionId** parameter and this parameter are specified, then option values for the specified option ID for all of the vendor classes and user classes will be returned. - -If the **VendorClass** parameter and this parameter are specified, then all of the option values for the specified vendor class including those for any user class would be returned. - -If the **UserClass** parameter and this parameter are specified, then all of the option values for the specified user class including any vendor specific options would be returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Brief -Specifies that the name of the option is not returned in the option value object. -This parameter improves the performance of this cmdlet by not requesting the name of the option from the Dynamic Host Configuration Protocol (DHCP) server service. -For repeatedly fetching a large number of option values with this cmdlet, use of this parameter is recommended. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numerical identifier of the options for which one or more values are being requested. -If this parameter is not specified, then all option values configured are returned. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope for which the option values are being requested. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservedIP -Specifies the reserved IPv6 address for which the option values are being requested. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Specifies that the option values for the specified user class are returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Specifies that the option values for the specified vendor class are returned. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Remove-DhcpServerv6OptionValue](./Remove-DhcpServerv6OptionValue.md) - -[Set-DhcpServerv6OptionValue](./Set-DhcpServerv6OptionValue.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Reservation.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Reservation.md deleted file mode 100644 index 87184ea7b5..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Reservation.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6Reservation - -## SYNOPSIS -Returns the reserved IPv6 addresses on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-DhcpServerv6Reservation [-Prefix] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-DhcpServerv6Reservation [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -IPAddress -``` - -## DESCRIPTION -The **Get-DhcpServerv6Reservation** cmdlet returns the reserved IPv6 addresses and associated client information (DUID, IAID) from the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets the information for all of the reserved IPv6 addresses in the specified DHCPv6 scope. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::5 -``` - -This example gets the information for a specified reserved IPv6 address on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com | Get-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -``` - -This example gets all of the reserved IP addresses from all of the DHCPv6 scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. -The Get-DhcpServerv6Scope cmdlet returns all of the scope objects and pipes the objects into this cmdlet, which gets the reservations from each of the scopes passed through the pipeline. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv6 addresses for which the reservation information is requested. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefix of the DHCP server service from which the reservations are requested. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Reservation](./Add-DhcpServerv6Reservation.md) - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - -[Remove-DhcpServerv6Reservation](./Remove-DhcpServerv6Reservation.md) - -[Set-DhcpServerv6Reservation](./Set-DhcpServerv6Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Scope.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Scope.md deleted file mode 100644 index f6151503c3..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Scope.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6Scope - -## SYNOPSIS -Gets the scope information for the specified IPv6 prefixes on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv6Scope [[-Prefix] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6Scope** cmdlet gets the scope information for the specified IPv6 prefixes on the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -``` - -This example gets the information for all of the DHCPv6 scopes on the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets the information for the specified DHCPv6 scope on the DHCP server service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefixes for which the scope information is being requested. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Scope](./Add-DhcpServerv6Scope.md) - -[Get-DhcpServerv6ScopeStatistics](./Get-DhcpServerv6ScopeStatistics.md) - -[Remove-DhcpServerv6Scope](./Remove-DhcpServerv6Scope.md) - -[Set-DhcpServerv6Scope](./Set-DhcpServerv6Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6ScopeStatistics.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6ScopeStatistics.md deleted file mode 100644 index 5ccb9a696b..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6ScopeStatistics.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6scopestatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6ScopeStatistics - -## SYNOPSIS -Gets the IPv6 prefix statistics that correspond to the IPv6 prefix specified for a Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Get-DhcpServerv6ScopeStatistics [[-Prefix] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6ScopeStatistics** cmdlet gets the scope statistics that correspond to the specified IPv6 prefix present on a Dynamic Host Configuration Protocol (DHCP) server service. -If the **Prefix** parameter is not specified, then this cmdlet returns statistics for all of the IPv6 prefixes. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6ScopeStatistics -ComputerName dhcpserver.contoso.com -``` - -This example gets the scope statistics for all of the DHCPv6 scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6ScopeStatistics -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets the scope statistics for specified DHCPv6 scope. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 prefixes of the scopes for which the statistics are requested. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6ScopeStatistics[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Scope](./Add-DhcpServerv6Scope.md) - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - -[Remove-DhcpServerv6Scope](./Remove-DhcpServerv6Scope.md) - -[Set-DhcpServerv6Scope](./Set-DhcpServerv6Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6StatelessStatistics.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6StatelessStatistics.md deleted file mode 100644 index e34d8eae0e..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6StatelessStatistics.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6statelessstatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6StatelessStatistics - -## SYNOPSIS -Gets a list of IPv6 subnet prefixes which have stateless clients and the number of addresses in use in each of the subnets. - -## SYNTAX - -``` -Get-DhcpServerv6StatelessStatistics [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6StatelessStatistics** cmdlet gets a list of IPv6 subnet prefixes which have stateless clients and the number of addresses in use in each of the subnets. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6StatelessStatistics -ComputerName dhcpserver.contoso.com -``` - -This example gets the DHCPv6 server service IPv6 statistics from the DHCP server service running on the computer named dhcpserver.contoso.com for all of the IPv6 prefixes on the network. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6StatelessStatistics[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6StatelessStore](./Get-DhcpServerv6StatelessStore.md) - -[Set-DhcpServerv6StatelessStore](./Set-DhcpServerv6StatelessStore.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6StatelessStore.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6StatelessStore.md deleted file mode 100644 index 8c402f16c5..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6StatelessStore.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6statelessstore?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6StatelessStore - -## SYNOPSIS -Gets the properties of IPv6 stateless store for the specified IPv6 subnet. - -## SYNTAX - -``` -Get-DhcpServerv6StatelessStore [[-Prefix] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6StatelessStore** cmdlet gets the properties of IPv6 stateless store for the specified IPv6 subnet prefix. -If the **Prefix** parameter is not specified, then the properties of IPv6 stateless store at the server level are returned. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DhcpServerv6StatelessStore -ComputerName dhcpserver.contoso.com -``` - -This example gets the server level configuration for DHCPv6 stateless client store. - -### EXAMPLE 2 -``` -PS C:\>Get-DhcpServerv6StatelessStore -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example gets the configuration for DHCPv6 stateless client store for the scope 2001:4898:7020:1020:. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies one or more IPv6 subnet prefixes for one or more scopes for which the stateless store properties are to be returned. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6StatelessStore[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DhcpServerv6StatelessStore](./Set-DhcpServerv6StatelessStore.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Statistics.md b/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Statistics.md deleted file mode 100644 index 1d2f3d46f7..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Get-DhcpServerv6Statistics.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/get-dhcpserverv6statistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DhcpServerv6Statistics - -## SYNOPSIS -Gets the Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv6. - -## SYNTAX - -``` -Get-DhcpServerv6Statistics [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DhcpServerv6Statistics** cmdlet gets the Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv6. - -## EXAMPLES - -### Example 1: Get statistics for a DHCP server service -``` -PS C:\>Get-DhcpServerv6Statistics -ComputerName "dhcpserver.contoso.com" -``` - -This example gets all of the DHCPv6 server service statistics for the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Statistics -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6ScopeStatistics](./Get-DhcpServerv6ScopeStatistics.md) diff --git a/docset/winserver2012-ps/dhcpserver/Import-DhcpServer.md b/docset/winserver2012-ps/dhcpserver/Import-DhcpServer.md deleted file mode 100644 index ac48d49966..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Import-DhcpServer.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/import-dhcpserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-DhcpServer - -## SYNOPSIS -Imports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, from the specified file. - -## SYNTAX - -``` -Import-DhcpServer [-File] [-BackupPath] [-CimSession ] [-ComputerName ] - [-Force] [-Leases] [-Prefix ] [-ScopeId ] [-ScopeOverwrite] [-ServerConfigOnly] -``` - -## DESCRIPTION -The **Import-DhcpServer** cmdlet imports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, from the specified file. - -If you specify either the *ScopeId* or the *Prefix* parameter, or both, only the specified scopes or prefixes are imported. - -If you specify neither the *ScopeId* nor the *Prefix* parameter, all of the configurations that is contained in the file, and optionally any lease data, is imported. - -If you specify the *Leases* parameter, the lease data in the specified file is imported in addition to configuration data. - -If you specify the *ScopeOverWrite* parameter and the scope being imported exists on the destination server, the scope on the target DHCP server service is overwritten. -If this parameter is not specified and the scope being imported exists on the destination DHCP server service, a warning message is displayed and the import proceeds to process the next scope being imported. - -If you specify the *ServerConfigOnly* parameter, only the server level configuration is imported on the destination DHCP server service. -If the file specified contains any scope information, the same information is not imported on the destination DHCP server service. - -## EXAMPLES - -### Example 1: Import configuration data -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -``` - -This example imports the configuration data in the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -The file can contain DHCPv4 and DHCPv6 configuration data. - -### Example 2: Import configuration and lease data -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -Leases -``` - -This example imports the configuration and lease data in the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -The file can contain DHCPv4 and DHCPv6 configuration data. - -### Example 3: Import configuration data for specified scopes -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -ScopeId 10.10.10.0,10.20.20.0 -``` - -This example imports the configuration data for scopes 10.10.10.0 and 10.20.20.0 from the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -If the export file contains scopes besides 10.10.10.0 and 10.20.20.0, those scopes are ignored. -The DHCPv4 server level configuration data, if present in the export file, is also imported onto the DHCP server service. - -### Example 4: Import configuration and lease data for specified scopes -```powershell -PS C:\> Import-DhcpServer -ComputerName dhcpserver.contoso.com -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -ScopeId 10.10.10.0,10.20.20.0 -Leases -``` - -This example imports the configuration and lease data for scopes 10.10.10.0 and 10.20.20.0 from the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -If the export file contains scopes besides 10.10.10.0 and 10.20.20.0, those scopes are ignored. -The DHCPv4 server level configuration data, if present in the export file, is also imported onto the DHCP server service. - -### Example 5: Import configuration and lease data for specified scopes with overwrite -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -ScopeId 10.10.10.0,10.20.20.0 -Leases -ScopeOverwrite -``` - -This example imports the configuration and lease data for scopes 10.10.10.0 and 10.20.20.0 from the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -If the export file contains scopes besides 10.10.10.0 and 10.20.20.0, those scopes are ignored. -The DHCPv4 server level configuration data, if present in the export file, is also imported onto the server. -If the scopes 10.10.10.0 and 10.20.20.0 are already present on the DHCP server service that runs one the computer named dhcpserver.contoso.com, the scopes are deleted and recreated from the data in the export file. - -### Example 6: Import server level configuration data -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -ServerConfigOnly -``` - -This example imports only the server level configuration data in the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -Any scope configuration data, if present in the file, is ignored. - -### Example 7: Import configuration data for specified scopes for DHCPv6 -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -``` - -This example imports the configuration data for scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: from the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -If the export file contains scopes besides 2001:4898:7020:1020:: and 2001:4898:7020:1030::, those scopes are ignored. -The DHCPv6 server level configuration data, if present in the export file, is also imported onto the DHCP server service. - -### Example 8: Import configuration and lease data for specified scopes for DHCPv6 -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -Leases -``` - -This example imports the configuration and lease data for scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: from the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -If the export file contains scopes besides 2001:4898:7020:1020:: and 2001:4898:7020:1030::, those scopes are ignored. -The DHCPv6 server level configuration data, if present in the export file, is also imported onto the DHCP server service. - -### Example 9: Import configuration and lease data for specified scopes for DHCPv6 with overwrite -```powershell -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exports\dhcpexport.xml" -BackupPath "C:\dhcpbackup\" -Prefix 2001:4898:7020:1020::,2001:4898:7020:1030:: -Leases -ScopeOverwrite -``` - -This example imports the configuration and lease data for scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: from the specified file onto the DHCP server service that runs on the computer named dhcpserver.contoso.com. -If the export file contains scopes besides 2001:4898:7020:1020:: and 2001:4898:7020:1030::, those scopes are ignored. -The DHCPv6 server level configuration data, if present in the export file, is also imported onto the DHCP server service. -If the scopes 2001:4898:7020:1020:: and 2001:4898:7020:1030:: are already present on the DHCP server service that runs on the computer named dhcpserver.contoso.com, the scopes are deleted and recreated from the data in the export file. - -### Example 10: Import scopes specified in a file -```powershell -PS C:\> $ScopeIdList = Import-Csv -Path ".\ScopeList.txt" - -PS C:\> Import-DhcpServer -ComputerName "dhcpserver.contoso.com" -File "C:\exportdir\dhcpexport.xml" -Leases -ScopeId $ScopeIdList.ScopeId -BackupPath "C:\dhcpbackup\" -``` - -This example imports a list of scopes specified in file named _ScopeList.txt_ to the DHCP server service that runs on the computer named dhcpserver.contoso.com. - -The **Import-Csv** cmdlet gets the list of scopes to import and returns it in the variable named _$ScopeIdList_. The second line imports the scopes using the variable named _$ScopeIdList_ as input for the _ScopeId_ parameter. - -The file named _ScopeList.txt_ should contain the following format: - -ScopeID \ -10.10.10.0 \ -10.20.20.0 \ -10.30.30.0 - -## PARAMETERS - -### -BackupPath -Specifies the path where DHCP server database is backed up before making any configuration changes as part of the import operation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -File -Specifies the name of the file from which the data will be imported. -If a complete file path is not specified, then the file will be read from the current working directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Leases -Specifies that the lease data will also be imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the subnet prefixes of IPv6 scopes which are to be imported. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifiers (IDs), in IPv4 address format, which need to be imported. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeOverwrite -Specifies that, if the scope being imported exists on the target server, the scope on the destination DHCP server service will be overwritten. - -If this parameter is not specified and the scope being imported exists on the destination DHCP server service, then a warning message is displayed and import will proceed to process the next scope being imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerConfigOnly -Specifies that only server level configuration is imported on the destination DHCP server service. -If the file specified contains any scope information, the same is not imported on the destination DHCP server service. - -Both DHCPv4 and DHCPv6 server level configurations is imported. - -The server level configuration includes of (both v4 and v6): - -- Class definitions. -- Option definitions. -- Option values. -- Server level Policies (DHCPv4). -- MAC address filters (DHCPv4). -- Other Server Properties (ConflictDetectionAttempts, DHCPv6 stateless store). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Import-Csv](https://go.microsoft.com/fwlink/p/?LinkId=113341) - -[Backup-DhcpServer](./Backup-DhcpServer.md) - -[Export-DhcpServer](./Export-DhcpServer.md) - -[Restore-DhcpServer](./Restore-DhcpServer.md) diff --git a/docset/winserver2012-ps/dhcpserver/Invoke-DhcpServerv4FailoverReplication.md b/docset/winserver2012-ps/dhcpserver/Invoke-DhcpServerv4FailoverReplication.md deleted file mode 100644 index 8f2e452a0d..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Invoke-DhcpServerv4FailoverReplication.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/invoke-dhcpserverv4failoverreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-DhcpServerv4FailoverReplication - -## SYNOPSIS -Replicates scope configuration between failover partner Dynamic Host Configuration Protocol (DHCP) server services. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Invoke-DhcpServerv4FailoverReplication [[-Name] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Invoke-DhcpServerv4FailoverReplication [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-ThrottleLimit ] -ScopeId [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Invoke-DhcpServerv4FailoverReplication** cmdlet replicates scope configuration between failover partner Dynamic Host Configuration Protocol (DHCP) server services. - -If the **ScopeId** parameter is specified, then, if the scope is part of a failover relationship, the scope configuration for the specified scopes is replicated to the failover partner DHCP server service. -The scope configuration includes all scope properties, reservations, scope option values, and policies. - -If the **Name** parameter is specified, then the configuration for all of the scopes which are part of the failover relationship is replicated to the partner DHCP server service. -If no parameters are specified, then the configuration for all of the failover scopes on the DHCP server service will be replicated to the respective partner DHCP server services. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Invoke-DhcpServerv4FailoverReplication -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -``` - -This example replicates the configuration of all scopes which are part of the failover relationship named SFO-SIN-Failover on the DHCP server service running on the computer named dhcpserver.contoso.com to the partner DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Invoke-DhcpServerv4FailoverReplication -ComputerName dhcpserver.contoso.com -``` - -This example replicates all of the failover scopes on the DHCP server service running on the computer named dhcpserver.contoso.com to one or more respective partner DHCP server services based on one or more failover relationships in which the DHCP server services are included. - -### EXAMPLE 3 -``` -PS C:\>Invoke-DhcpServerv4FailoverReplication -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0,20.20.20.0 -``` - -This example replicates the configuration of the scopes 10.10.10.0 and 20.20.20.0 to the respective partner computers running the DHCP server services of the failover relationships in which the scopes are included. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the failover relationship. -All scopes for one or more specified relationships are replicated to the partner DHCP server service. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, whose configuration needs to be replicated. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### System.String[] - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) - -[Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) - -[Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) - -[Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) - -[Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) - -[Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerInDC.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerInDC.md deleted file mode 100644 index b874b41349..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerInDC.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverindc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerInDC - -## SYNOPSIS -Deletes the specified Dynamic Host Configuration Protocol (DHCP) server service from the list of authorized DHCP server services in Active Directory (AD). - -## SYNTAX - -``` -Remove-DhcpServerInDC [[-DnsName] ] [[-IPAddress] ] [-AsJob] [-CimSession ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerInDC** cmdlet deletes the specified Dynamic Host Configuration Protocol (DHCP) server service from the list of authorized DHCP server services in Active Directory (AD). - -When neither the **DnsName** nor the **IPAddress** parameter is specified, then the local DHCP server service will be removed from the list of authorized DHCP server services in AD. - -If only the **DnsName** parameter is specified, then the DHCP server service running on the computer with the specified DNS name will be removed from the list of authorized DHCP server services in AD. - -If the **DnsName** and the **IPAddress** parameters are specified, then the DHCP server service running on the computer with specified values will be removed from the list of authorized DHCP server services in AD. - -If only the **IPAddress** parameter is specified, then an error is returned. - -In addition to removing the computer running the DHCP server service in DC, this cmdlet also triggers the DHCP server service to perform an authorization check. - -The trigger for authorization check will be done even if the removal of computer running the DHCP server service fails with an object already exists error. - -The following warning will be displayed if the computer running the DHCP server service does not exist in AD and the trigger for the server authorization check succeeded: - - - `The DHCP server is already de-authorized in Active Directory. -The authorization check on the DHCP server has been initiated.` - -The following warning will be displayed if the computer running the DHCP server service does not exist in AD, but the trigger for the server authorization check failed: - - - `The DHCP server is already de-authorized in Active Directory. -Failed to initiate the authorization check on the DHCP server. -Error code: %d` - -The following warning will be displayed if the deletion of the computer running the DHCP server service in AD succeeded, but the trigger for the server authorization check failed: - - - `The DHCP server has been successfully de-authorized in Active Directory. -Failed to initiate the authorization check on the DHCP server. -Error code: %d` - -If the deletion of computer running the DHCP server service to AD fails with an error other than object_does not already_exists_error, then an error is returned and authorization check on the server is not triggered. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerInDC -DnsName dhcpserver.contoso.com -IPAddress 10.10.10.2 -``` - -This example deletes the object in the AD domain for the DHCP server service running on the computer with the DNS name dhcpserver.contoso.com and the IP address 10.10.10.2, thereby de-authorizing the DHCP server service for clients on the network. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerInDC -DnsName dhcpserver.contoso.com -``` - -This example deletes an object in the AD domain for the DHCP server service running on the computer with the DNS name dhcpserver.contoso.com, thereby de-authorizing the DHCP server service for the clients on the network. -The IP address for computer running the DHCP server service object in AD will be obtained by looking up dhcpserver.contoso.com in DNS. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerInDC -``` - -This example deletes an object in the AD domain for the DHCP server service running on the local computer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsName -Specifies the DNS name of the computer, on which the DHCP server service is running, to de-authorize. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IP address of the computer, on which the DHCP server service is running, to de-authorize. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerInDC -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerInDC -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerInDC](./Add-DhcpServerInDC.md) - -[Get-DhcpServerInDC](./Get-DhcpServerInDC.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Class.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Class.md deleted file mode 100644 index 74bece311b..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Class.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Class - -## SYNOPSIS -Deletes the IPv4 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Remove-DhcpServerv4Class [-Name] [-Type] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Class** cmdlet deletes the IPv4 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4Class -Name "User Class for Lab Computers" -Type User -``` - -This example deletes the DHCPv4 user class for the lab computers on the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4Class -Name "MSUCClient" -Type Vendor -``` - -This example deletes the DHCPv4 vendor class for the Microsoft Unified Communication clients on the DHCP server service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies one or more names for the class or classes to be deleted. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class being deleted. -The acceptable values for this parameter are: Vendor and User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Class[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Class](./Add-DhcpServerv4Class.md) - -[Get-DhcpServerv4Class](./Get-DhcpServerv4Class.md) - -[Set-DhcpServerv4Class](./Set-DhcpServerv4Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4ExclusionRange.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4ExclusionRange.md deleted file mode 100644 index e94117b398..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4ExclusionRange.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4exclusionrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4ExclusionRange - -## SYNOPSIS -Deletes a range of IPv4 addresses that were previously excluded from an IPv4 scope. - -## SYNTAX - -``` -Remove-DhcpServerv4ExclusionRange [-ScopeId] [[-StartRange] ] [[-EndRange] ] - [-AsJob] [-CimSession ] [-ComputerName ] [-Passthru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4ExclusionRange** cmdlet deletes a range of IPv4 addresses that were previously excluded from an IPv4 scope. -If the **StartRange** and **EndRange** parameters are specified, then the exclusion range with the specified starting range and ending range is deleted. -If only the **StartRange** parameter is specified, then the exclusion range with specified starting range is deleted. -If only the **EndRange** parameter is specified, then the exclusion range with specified ending range is deleted. -If neither the **StartRange** nor the **EndRange** parameter is specified, then all exclusion ranges present in the specified scope are deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4ExclusionRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example deletes all of the excluded IPv4 address ranges on the specified DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4ExclusionRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -StartRange 10.10.10.1 -EndRange 10.10.10.10 -``` - -This example deletes the excluded IPv4 address range from 10.10.10.1 through 10.10.10.10 from the specified scope on the specified DHCP server service. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerv4ExclusionRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -StartRange 10.10.10.1 -``` - -This example deletes the excluded IPv4 address range starting with IPv4 address 10.10.10.1 from the specified scope on the specified DHCP server service. - -### EXAMPLE 4 -``` -PS C:\>Remove-DhcpServerv4ExclusionRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -EndRange 10.10.10.10 -``` - -This example deletes the excluded IPv4 address range ending with IPv4 address 10.10.10.10 from the specified scope on the specified DHCP server service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending IPv4 address of the excluded IP range which is to be deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, from which the exclusion ranges are to be deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IPv4 address of the excluded IP range which is to be deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ExclusionRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4ExclusionRange[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4ExclusionRange](./Add-DhcpServerv4ExclusionRange.md) - -[Get-DhcpServerv4ExclusionRange](./Get-DhcpServerv4ExclusionRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Failover.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Failover.md deleted file mode 100644 index b0d3951992..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Failover.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4failover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Failover - -## SYNOPSIS -Removes one or more specified failover relationships. - -## SYNTAX - -``` -Remove-DhcpServerv4Failover [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Failover** cmdlet removes one or more specified failover relationships. -The failover relationship will be removed from both of the computers running Dynamic Host Configuration Protocol (DHCP) server services which are part of this failover relationship. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -``` - -This example deletes the failover relationship named SFO-SIN-Failover from the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes the failover relationship even if the partner server is unreachable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies one or more names of the failover relationships to be removed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) - -[Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) - -[Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) - -[Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) - -[Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) - -[Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4FailoverScope.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4FailoverScope.md deleted file mode 100644 index bba1dc822c..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4FailoverScope.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4failoverscope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4FailoverScope - -## SYNOPSIS -Removes the specified scopes from the failover relationship. - -## SYNTAX - -``` -Remove-DhcpServerv4FailoverScope [-Name] [-ScopeId] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4FailoverScope** cmdlet removes the specified scopes from the failover relationship. -If any specified scope that is not part of the specified failover relationship or which does not exist, then a non-terminating error will be returned. -This processing will be done before adding the valid scopes to the failover relationship. -This cmdlet also deletes the scopes from the partner Dynamic Host Configuration Protocol (DHCP) server service. -The scopes are retained on the DHCP server service running on the computer specified in the **ComputerName** parameter or the local computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4FailoverScope -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -ScopeId 10.10.10.0,20.20.20.0 -``` - -This example removes the scopes 10.10.10.0 and 20.20.20.0 from the failover relationship named SFO-SIN-Failover. -The specified scopes are deleted from the partner DHCP server service of the failover relationship and retained only on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a scope from a failover relationship even if the partner server is unreachable. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of one or more failover relationships from which the scopes are to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, which are removed from the failover relationship. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) - -[Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) - -[Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) - -[Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) - -[Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) - -[Set-DhcpServerv4Failover](./Set-DhcpServerv4Failover.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Filter.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Filter.md deleted file mode 100644 index c888648ee1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Filter.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4filter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Filter - -## SYNOPSIS -Deletes the specified MAC address or MAC address pattern from the allow list or the deny list of the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Remove-DhcpServerv4Filter [-MacAddress] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Filter** cmdlet deletes the specified MAC address or MAC address pattern from the allow list or the deny list of the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4Filter -MacAddress F0-DE-F1-7A-00-5E,F0-DE-F1-7A-00-5E -``` - -This example deletes the specified clients identified by their MAC addresses from the MAC address filter list. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacAddress -Specifies one or more MAC addresses which are to be deleted from the allow filter or the deny filter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Filter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Filter](./Add-DhcpServerv4Filter.md) - -[Get-DhcpServerv4Filter](./Get-DhcpServerv4Filter.md) - -[Get-DhcpServerv4FilterList](./Get-DhcpServerv4FilterList.md) - -[Set-DhcpServerv4FilterList](./Set-DhcpServerv4FilterList.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Lease.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Lease.md deleted file mode 100644 index 644ec16bac..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Lease.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4lease?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Lease - -## SYNOPSIS -Deletes the specified IPv4 address lease record from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DhcpServerv4Lease [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -IPAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DhcpServerv4Lease [-ScopeId] [-AsJob] [-CimSession ] [-ComputerName ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-DhcpServerv4Lease [-ScopeId] [-ClientId] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Remove-DhcpServerv4Lease [[-ScopeId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-BadLeases] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Lease** cmdlet deletes one or more IPv4 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -If the **ScopeId** parameter is specified, then all of the leases for the specified scope are deleted. - -If the **IPAddress** parameter is specified, then the leases for clients identified by one or more specified IP addresses are deleted. -If the **ClientId** and the **ScopeId** parameter is specified, then the lease for the specified client identifier (ID) from the specified scope is deleted. - -If the **BadLeases** and the **ScopeId** parameters are specified, then this cmdlet removes all of the bad lease records for the specified scope. - -If the **BadLeases** parameter is specified without the **ScopeId** parameter, then this cmdlet removes all of the bad leases from all of the scopes on the DHCP server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example deletes all of the IPv4 address leases inside of the scope 10.10.10.0 from the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.10,20.20.20.20 -``` - -This example deletes the IPv4 address leases for 10.10.10.10 and 20.20.20.20 from the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -ClientId F0-DE-F1-7A-00-5E,00-24-D7-C5-25-B0 -``` - -This example deletes the IPv4 address leases from the DHCPv4 scope 10.10.10.0 for the clients identified by the client IDs F0-DE-F1-7A-00-5E and 00-24-D7-C5-25-B0. - -### EXAMPLE 4 -``` -PS C:\>Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -BadLeases -``` - -This example deletes all of the bad, or declined, IPv4 address leases inside of the scope 10.10.10.0 from the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 5 -``` -PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -BadLeases | Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -BadLeases -``` - -This example deletes all of the bad, or declined, IPv4 address leases from all of the scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. -The Get-DhcpServerv4Scope cmdlet returns all of the scope objects and the scope objects are piped into the Get-DhcpServerv4Lease cmdlet. -The Get-DhcpServerv4Lease cmdlet returns the bad address lease objects from all the scopes and the bad address lease objects are piped into this cmdlet, which deletes all of the bad address leases. - -### EXAMPLE 6 -``` -PS C:\>Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -AllLeases | Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -``` - -This example deletes all IPv4 address leases from the scope 10.10.10.0. -The command works by pipelining from the first cmdlet Get-DhcpServerv4Lease cmdlet returns the IPv4 address lease objects and the IPv4 address lease objects are piped into this cmdlet, which deletes the bad address leases. - -### EXAMPLE 7 -``` -PS C:\>Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Remove-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -``` - -This example deletes all of the IPv4 address leases from all of the DHCPv4 scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. -The Get-DhcpServerv4Scope cmdlet returns the DHCPv4 scope objects and the DHCPv4 scope objects are piped into this cmdlet, which deletes each of the address leases. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BadLeases -Specifies that all of the bad IP address leases are deleted. -An IPv4 address lease which is declined by a client because of an IPv4 address conflict is marked as bad by the DHCP server service. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies the client ID whose IPv4 address lease is to be deleted. -Windows clients use the MAC address as the client ID. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies one or more IP addresses for which the lease records are deleted. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format, from which the IP address leases are deleted. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Lease](./Add-DhcpServerv4Lease.md) - -[Get-DhcpServerv4Lease](./Get-DhcpServerv4Lease.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4OptionDefinition.md deleted file mode 100644 index a2f157c423..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4OptionDefinition.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4OptionDefinition - -## SYNOPSIS -Deletes one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Remove-DhcpServerv4OptionDefinition [-OptionId] [[-VendorClass] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Passthru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Get-DhcpServerv4OptionDefinition** cmdlet deletes one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service. -If the **VendorClass** parameter is specified, then only option definitions for that vendor class are removed. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -OptionId 23 -``` - -This example deletes the DHCPv4 option definition for the specified option. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -VendorClass "MSUCClient" -OptionId 5 -``` - -This example deletes the DHCPv4 option definitions for the specified vendor-specific option. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies one or more numeric identifiers (IDs) for the options which are to be deleted. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorClass -Deletes the option definitions only for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4OptionDefinition](./Add-DhcpServerv4OptionDefinition.md) - -[Get-DhcpServerv4OptionDefinition](./Get-DhcpServerv4OptionDefinition.md) - -[Set-DhcpServerv4OptionDefinition](./Set-DhcpServerv4OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4OptionValue.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4OptionValue.md deleted file mode 100644 index 1c160a1a07..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4OptionValue.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4optionvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4OptionValue - -## SYNOPSIS -Deletes one or more IPv4 option values at the server, scope or reservation level, either for the standard IPv4 options or for the specified vendor or user class. - -## SYNTAX - -``` -Remove-DhcpServerv4OptionValue [-OptionId] [[-ScopeId] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-PolicyName ] - [-ReservedIP ] [-ThrottleLimit ] [-UserClass ] [-VendorClass ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4OptionValue** cmdlet deletes one or more IPv4 option values at the server, scope or reservation level, either for the standard IPv4 options or for the specified vendor or user class. - -If only the **ReservedIP** parameter is specified, then the option values set at the reservation level are deleted. -If only the **ScopeId** parameter is specified, then the option values set at the scope level are deleted. -If neither the **ScopeId** nor the **ReservedIP** parameter is specified, then the option values set at the server level are deleted. -The **ScopeId** and the **ReservedIP** parameters cannot both be specified. - -The **UserClass** and **PolicyName** parameters cannot both be specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -OptionId 23 -``` - -This example deletes DHCPv4 option value configured on the specified scope for the specified option ID. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -VendorClass MSUCClient -OptionId 5 -``` - -This example deletes DHCPv4 option value configured on the specified scope for the specified vendor class named MSUCClient with the specific option 5. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -PolicyName SmartPhonePolicy -OptionId 252 -``` - -This example deletes DHCPv4 option value with the option ID 252 configured for the specified policy in the scope 10.10.10.0. - -### EXAMPLE 4 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -UserClass LabComputer -OptionId 252 -``` - -This example deletes DHCPv4 option value with the option ID 252 configured for the specified user class in the scope 10.10.10.0. - -### EXAMPLE 5 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -OptionId 23 -``` - -This example deletes DHCPv4 option value configured at the server level, or server-wide, for the specified option ID. - -### EXAMPLE 6 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -VendorClass MSUCClient -OptionId 5 -``` - -This example deletes DHCPv4 option value configured at the server level, or server-wide, for the specified vendor class named MSUCClient with the specific option 5. - -### EXAMPLE 7 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -PolicyName SmartPhonePolicy -OptionId 252 -``` - -This example deletes DHCPv4 option value with the option ID 252 configured for the specified policy at the server level, or server-wide. - -### EXAMPLE 8 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -UserClass LabComputer -OptionId 252 -``` - -This example deletes DHCPv4 option value with the option ID 252 configured for the specified user class at the server level, or server-wide. - -### EXAMPLE 9 -``` -PS C:\>Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 10.10.10.5 -OptionId 23 -``` - -This example deletes DHCPv4 option value configured on the specified reservation for the specified option ID. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies one or more numeric identifiers (IDs) for the options which are to be deleted. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy from which the option values are deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservedIP -Specifies the IPv4 address of the reservation from which the option values are deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format, from which the option values are deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Specifies that the option values for the specified user class are deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Specifies that the option values for the specified vendor class are deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4OptionValue](./Get-DhcpServerv4OptionValue.md) - -[Set-DhcpServerv4OptionValue](./Set-DhcpServerv4OptionValue.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Policy.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Policy.md deleted file mode 100644 index 235175ee05..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Policy.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4policy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Policy - -## SYNOPSIS -Deletes one or more specified IPv4 policies either at the server level or the specified scope level. - -## SYNTAX - -``` -Remove-DhcpServerv4Policy [-Name] [[-ScopeId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Policy** cmdlet deletes one or more specified IPv4 policies either at the server level or the specified scope level. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name IPPhonePolicy,PrinterPolicy -``` - -This example deletes the server level, or server-wide, policies named IPPhonePolicy and PrinterPolicy from the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name HyperVPolicy -ScopeId 10.10.10.0 -``` - -This example deletes the policy named HyperVPolicy inside the scope 10.10.10.0 from the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 orIPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies one or more names of the policies to be deleted. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, from which the policies are to be deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Policy](./Add-DhcpServerv4Policy.md) - -[Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) - -[Get-DhcpServerv4Policy](./Get-DhcpServerv4Policy.md) - -[Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) - -[Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) - -[Set-DhcpServerv4Policy](./Set-DhcpServerv4Policy.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4PolicyIPRange.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4PolicyIPRange.md deleted file mode 100644 index c0b3710f54..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4PolicyIPRange.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4policyiprange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4PolicyIPRange - -## SYNOPSIS -Deletes an IP range from an existing policy at the scope level. - -## SYNTAX - -``` -Remove-DhcpServerv4PolicyIPRange [-Name] [-ScopeId] [[-StartRange] ] - [[-EndRange] ] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4PolicyIPRange** cmdlet deletes an IP range from an existing policy at the scope level. - -If neither the **StartRange** nor the **EndRange** parameter is specified, then all of the IP address ranges associated with the policy are deleted. - -If only the **StartRange** parameter is specified, then the policy IP address range which has the specified starting address is deleted. - -If only the **EndRange** parameter is specified, then the policy IP address range which has the specified ending address is deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4PolicyIPRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name HyperVPolicy -StartRange 10.10.10.10 -EndRange 10.10.10.20 -``` - -This example deletes the IP address range from 10.10.10.10 through 10.10.10.20 that is associated with the policy named HyperVPolicy in the scope 10.10.10.0. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4PolicyIPRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name HyperVPolicy -``` - -This example deletes all of the IP address ranges associated with the policy named HyperVPolicy in the scope 10.10.10.0. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerv4PolicyIPRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name HyperVPolicy -StartRange 10.10.10.10 -``` - -This example deletes the IP address range starting from 10.10.10.10 that is associated with the policy named HyperVPolicy in the scope 10.10.10.0. - -### EXAMPLE 4 -``` -PS C:\>Remove-DhcpServerv4PolicyIPRange -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name HyperVPolicy -EndRange 10.10.10.20 -``` - -This example deletes the IP address range ending at 10.10.10.10 that is associated with the policy named HyperVPolicy in the scope 10.10.10.0. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending IP address of the IP address range to delete from the policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy for which one or more associated IP address ranges are deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, which contains the specified policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IP address of the IP address range to delete from the policy. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4PolicyIPRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4PolicyIPRange[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) - -[Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Reservation.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Reservation.md deleted file mode 100644 index bd6b9ed933..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Reservation.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Reservation - -## SYNOPSIS -Deletes the IPv4 Reservation from the specified scope. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DhcpServerv4Reservation [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -IPAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DhcpServerv4Reservation [-ScopeId] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-DhcpServerv4Reservation [-ScopeId] [-ClientId] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Reservation** cmdlet deletes the IPv4 reservation from the specified scope. -If the **ScopeId** parameter is specified, then all of the reservations from the scope are deleted. -If the **IPAddress** or **ClientId** parameter is specified, then one or more specific reservations identified by IP addresses or client identifiers (IDs) are deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -``` - -This example deletes all of the reservations in the specified scope. - -### EXAMPLE 2 -``` -PS C:\> Remove-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.5, 10.10.10.6 -``` - -This example deletes the specified reservations from the DHCP server service. - -### EXAMPLE 3 -``` -PS C:\> Remove-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -ClientId F0-DE-F1-7A-00-5E -``` - -This example deletes the specified reservation identified by client ID from the DHCP server service. -For Windows computers, the MAC address is used as a client identifier. - -### EXAMPLE 4 -``` -PS C:\> Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Remove-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -``` - -This example deletes all of the reserved IP addresses from all of the scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. -The Get-DhcpServerv4Scope cmdlet returns all of the scope objects and pipes the objects into this cmdlet, which deletes the reservations from each of the scopes passed in through the pipeline. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies one or more client IDs for one of more reservations which are to be deleted. -For Windows clients, the MAC address is used as a client identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies one or more IPv4 addresses for one or more reservations which are to be deleted. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format, from which the reservations are to be deleted. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Reservation](./Add-DhcpServerv4Reservation.md) - -[Get-DhcpServerv4Reservation](./Get-DhcpServerv4Reservation.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Set-DhcpServerv4Reservation](./Set-DhcpServerv4Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Scope.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Scope.md deleted file mode 100644 index 6a709fbdb8..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Scope.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Scope - -## SYNOPSIS -Deletes the specified IPv4 scopes from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Remove-DhcpServerv4Scope [-ScopeId] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-Passthru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Scope** cmdlet deletes the specified IPv4 scopes from the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0, 20.20.20.0 -``` - -This example deletes the specified scopes from the DHCP server service. - -### EXAMPLE 2 -``` -PS C:\> Remove-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0, 20.20.20.0 -Force -``` - -This example deletes the specified scopes from the DHCP server service. -This cmdlet does not prompt the user for confirmation even if the scopes are active or contain active client leases. - -### EXAMPLE 3 -``` -PS C:\> Get-DhcpServerV4Scope | Where-Object -FilterScript { $_.State -Eq "Inactive" } | Remove-DhcpServerv4Scope -Force -Passthru -``` - -This example deletes all of the disabled scopes on the DHCP server service. -The Get-DhcpServerv4Scope cmdlet returns the scope objects and pipes the scope objects into the Where-Objecthttp://go.microsoft.com/fwlink/p/?LinkId=113423 cmdlet. -The Where-Objecthttp://go.microsoft.com/fwlink/p/?LinkId=113423 cmdlet returns the scope objects which are filtered for the state being InActive, or disabled, and pipes the filtered scope objects into this cmdlet, which deletes the disabled scopes passed through the pipeline. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Deletes the scope even if active leases exist in the scope. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies one or more scope identifiers (IDs), in IPv4 address format, to be deleted. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkId=113423) - -[Add-DhcpServerv4Scope](./Add-DhcpServerv4Scope.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Get-DhcpServerv4ScopeStatistics](./Get-DhcpServerv4ScopeStatistics.md) - -[Set-DhcpServerv4Scope](./Set-DhcpServerv4Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Superscope.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Superscope.md deleted file mode 100644 index 0914568bc1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv4Superscope.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv4superscope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv4Superscope - -## SYNOPSIS -Removes one or more specified scopes from a superscope. - -## SYNTAX - -``` -Remove-DhcpServerv4Superscope [-SuperscopeName] [[-ScopeId] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Passthru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv4Superscope** cmdlet removes one or more specified scopes from a superscope. -The scopes which are removed from the superscope remain otherwise unchanged. -If the **ScopeId** parameter is not specified, then all of the scopes will be removed from the specified superscope and the superscope is also removed. -If The **ScopeId** parameter is specified and the **ScopeId** parameter values are part of the superscopes, then the scopes are removed from the superscope. -If no other scopes in the superscope, then the superscope is also removed. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv4Superscope -SuperscopeName "Expanded Lab-4 Network" -ScopeId 10.1.1.0, 10.1.2.0 -``` - -This example removes the scopes 10.1.1.0 and 10.1.2.0 from the superscope named "Expanded Lab-4 Network" on the DHCP server service running on the local computer. -The superscope will continue to exist if there are other scopes associated with it. -If the superscope has no scope associations after this operation, then the superscope is deleted. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv4Superscope -SuperscopeName "Expanded Lab-5 Network" -``` - -This example deletes the superscope named "Expanded Lab-5 Network" on the DHCP server service running on the local computer. -All of scopes associated with the specified superscope are removed from the superscope. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies one of more scope identifiers (IDs), in IPv4 address format, to be removed from a superscope. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuperscopeName -Specifies the name of the superscope from which the scopes are to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Superscope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Superscope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Superscope](./Add-DhcpServerv4Superscope.md) - -[Get-DhcpServerv4Superscope](./Get-DhcpServerv4Superscope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Class.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Class.md deleted file mode 100644 index 3a333ae3b7..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Class.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6Class - -## SYNOPSIS -Deletes the specified IPv6 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Remove-DhcpServerv6Class [-Name] [-Type] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv6Class** cmdlet deletes the specified IPv6 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv6Class -Name "User Class for Lab Computers" -Type User -``` - -This example deletes the DHCPv6 user class for lab computers. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv6Class -Name "Vendor Class for Printers" -Type Vendor -``` - -This example deletes the DHCPv6 vendor class defined for printers. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the vendor or user class being deleted. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class being deleted. -The acceptable values for this parameter are: Vendor or User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Class](./Add-DhcpServerv6Class.md) - -[Get-DhcpServerv6Class](./Get-DhcpServerv6Class.md) - -[Set-DhcpServerv6Class](./Set-DhcpServerv6Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6ExclusionRange.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6ExclusionRange.md deleted file mode 100644 index b1fe081d80..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6ExclusionRange.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6exclusionrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6ExclusionRange - -## SYNOPSIS -Deletes a range of IPv6 addresses previously excluded from an IPv6 scope. - -## SYNTAX - -``` -Remove-DhcpServerv6ExclusionRange [-Prefix] [[-StartRange] ] [[-EndRange] ] - [-AsJob] [-CimSession ] [-ComputerName ] [-Passthru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -Deletes a range of IPv6 addresses previously excluded from an IPv6 scope. -If the **StartRange** and **EndRange** parameters are specified, then the exclusion range with the specified starting range and ending range values is deleted. -If only the **StartRange** parameter is specified, then the exclusion range with specified starting range is deleted. -If only the **EndRange** parameter is specified, then the exclusion range with specified ending range is deleted. -If neither the **StartRange** nor **EndRange** parameter is specified, then all of the excluded IP address ranges present in the specified scope are removed. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv6ExclusionRange -Prefix 2001:4898:7020:1020:: -StartRange 2001:4898:7020:1020::1 -EndRange 2001:4898:7020:1020::10 -``` - -This example deletes the excluded IPv6 address range from 2001:4898:7020:1020::1 to 2001:4898:7020:1020::10 from DHCPv6 scope 2001:4898:7020:1020:: on the DHCP server service running on the local computer. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv6ExclusionRange -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -StartRange 2001:4898:7020:1020::1 -``` - -This example deletes the IPv6 address range starting from 2001:4898:7020:1020::1 from DHCPv6 scope 2001:4898:7020:1020:: on the DHCP server service running on computer named dhcpserver.contoso.com. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerv6ExclusionRange -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -EndRange 2001:4898:7020:1020::10 -``` - -This example deletes the IPv6 address range with ending IP address of 2001:4898:7020:1020::10 from DHCPv6 scope 2001:4898:7020:1020:: on the DHCP server service running on computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending IPv6 address of the excluded IP range being deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope from which the excluded IP ranges is deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting IPv6 address of the excluded IPv6 range being deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6ExclusionRange -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6ExclusionRange[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6ExclusionRange](./Add-DhcpServerv6ExclusionRange.md) - -[Get-DhcpServerv6ExclusionRange](./Get-DhcpServerv6ExclusionRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Lease.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Lease.md deleted file mode 100644 index 0ff41cb993..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Lease.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6lease?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6Lease - -## SYNOPSIS -Deletes one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DhcpServerv6Lease [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -IPAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DhcpServerv6Lease [-Prefix] [-AsJob] [-CimSession ] [-ComputerName ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -Deletes one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. -If the **Prefix** parameter is specified, then this cmdelt removes all of the leases for the specified prefix. -If the **IPAddress** parameter is specified, then this cmdlet deletes the specified leases. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example deletes all of the IP address leases inside the scope 2001:4898:7020:1020:: from the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::10,2001:4898:7020:1030::20 -``` - -This example deletes the IP address leases for 2001:4898:7020:1020::10 and 2001:4898:7020:1030::20 from the DHCP server service running on the computer named dhcpserver.contoso.com. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: | Remove-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -``` - -This example deletes all of the IPv6 address leases from the scope 2001:4898:7020:1020::. -The Get-DhcpServerv6Lease cmdlet returns the IP address lease objects and pipes the objects into this cmdlet, which deletes each of the address leases. - -### EXAMPLE 4 -``` -PS C:\>Get-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com | Remove-DhcpServerv6Lease -ComputerName dhcpserver.contoso.com -``` - -The above command deletes all IPv6 address leases from all the DHCPv6 scopes. -The cmdlet Get-DhcpServerv6Scope cmdlet returns the DHCPv6 scope objects and pipe the objects into this cmdlet, which deletes each of the address leases passed through the pipeline. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies one or more IPv6 addresses for which the lease records are deleted from the DHCP server service. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope from which the leases are deleted. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Lease -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Lease[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Lease](./Add-DhcpServerv6Lease.md) - -[Get-DhcpServerv6Lease](./Get-DhcpServerv6Lease.md) - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6OptionDefinition.md deleted file mode 100644 index d112d2fc63..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6OptionDefinition.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6OptionDefinition - -## SYNOPSIS -Deletes one or more IPv6 option definitions from the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Remove-DhcpServerv6OptionDefinition [-OptionId] [[-VendorClass] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Passthru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv6OptionDefintion** cmdlet deletes one or more IPv6 option definitions from the Dynamic Host Configuration Protocol (DHCP) server service. -If the **VendorClass** parameter is specified, then only the option definitions for the specified vendor class are deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-DhcpServerv6OptionDefinition -ComputerName dhcpserver.contoso.com -OptionId 21,24 -``` - -This example deletes the DHCPv6 option definitions for the specified option IDs. - -### EXAMPLE 2 -``` -PS C:\> Remove-DhcpServerv6OptionDefinition -ComputerName dhcpserver.contoso.com -VendorClass MyVendorClass -OptionId 10 -``` - -This example deletes the DHCPv6 option definitions for the specified vendor-class-specific option. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies one or more numeric identifiers (IDs) for one or more options for which the definition is being deleted. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorClass -Removes option definitions only for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6OptionDefinition](./Add-DhcpServerv6OptionDefinition.md) - -[Get-DhcpServerv6OptionDefinition](./Get-DhcpServerv6OptionDefinition.md) - -[Set-DhcpServerv6OptionDefinition](./Set-DhcpServerv6OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6OptionValue.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6OptionValue.md deleted file mode 100644 index 116816a033..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6OptionValue.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6optionvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6OptionValue - -## SYNOPSIS -Deletes one or more DHCPv6 option values set at the reservation level, scope level, or server level, either for the standard IPv6 options or for a specified vendor class. - -## SYNTAX - -``` -Remove-DhcpServerv6OptionValue [-OptionId] [[-Prefix] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ReservedIP ] - [-ThrottleLimit ] [-UserClass ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv6OptionValue** cmdlet deletes one or more DHCPv6 option values set at the reservation level, scope level, or server level, either for the standard IPv6 options or for a specified vendor class. - -If only the **ReservedIP** parameter is specified, then the option values set at the reservation level are deleted. -If only the **Prefix** parameter is specified, then the option values set at the specified IPv6 scope are deleted. -If neither the **ScopeId** nor **ReservedIP** parameter is specified, then the option values set at the server level are deleted. -The **ScopeId** and **ReservedIP** parameters cannot both be specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -OptionId 23 -``` - -This cmdlet deletes the DHCPv6 option value configured on the specified scope for the specified option ID. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -VendorClass MyVendorClass -OptionId 10 -``` - -This cmdlet deletes the specified vendor class specific option from the specified prefix. - -### EXAMPLE 3 -``` -PS C:\>Remove-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -OptionId 23 -``` - -This cmdlet deletes the DHCPv6 option value configured on the specified scope for the specified option identifier. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies one or more numeric identifiers (IDs) for the options being deleted. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope from which one or more option values are deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservedIP -Specifies the IPv6 address of the reservation from which one or more option values are deleted. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Specifies that only the option values for the specified user class is deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Specifies that only the option values for the specified vendor class is deleted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6OptionValue](./Get-DhcpServerv6OptionValue.md) - -[Set-DhcpServerv6OptionValue](./Set-DhcpServerv6OptionValue.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Reservation.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Reservation.md deleted file mode 100644 index a61e0a24c9..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Reservation.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6Reservation - -## SYNOPSIS -Deletes one or more IPv6 reservations from the specified scope. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DhcpServerv6Reservation [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -IPAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DhcpServerv6Reservation [-Prefix] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv6Reservation** cmdlet deletes one or more IPv6 reservations from the specified scope. -If the **Prefix** parameter is specified, then all of the reservations from the scope will be removed. -If the **IPAddress** parameter is specified, then one or more specified reservations are deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::1,2001:4898:7020:1020::2 -``` - -This example deletes the reservation for the specified IPv6 addresses. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example deletes all of the reservations from the specified IPv6 scope. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com | Remove-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -``` - -This example deletes all of the reserved IP addresses from all of the DHCPv6 scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. -The Get-DhcpServerv6Scope cmdlet returns all of the scope objects and pipes the objects into this cmdlet, which deletes the reservations from each of the scopes passed through the pipeline. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies one or more IPv6 addresses of the reservations being deleted. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope from which one or more reservations are being deleted. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Reservation](./Add-DhcpServerv6Reservation.md) - -[Get-DhcpServerv6Reservation](./Get-DhcpServerv6Reservation.md) - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - -[Set-DhcpServerv6Reservation](./Set-DhcpServerv6Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Scope.md b/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Scope.md deleted file mode 100644 index 15ccafe0db..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Remove-DhcpServerv6Scope.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/remove-dhcpserverv6scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DhcpServerv6Scope - -## SYNOPSIS -Deletes the IPv6 Scopes from the Dynamic Host Configuration Protocol (DHCP) server service corresponding to the specified prefixes. - -## SYNTAX - -``` -Remove-DhcpServerv6Scope [-Prefix] [-AsJob] [-CimSession ] [-ComputerName ] - [-Force] [-Passthru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DhcpServerv6Scope** cmdlet deletes the IPv6 Scopes from the Dynamic Host Configuration Protocol (DHCP) server service corresponding to the specified prefixes. -Deleting a scope deletes all of the associated settings and leases, if any are present in the scope. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -``` - -This example deletes the specified DHCPv6 scope from the specified DHCP server service. - -### EXAMPLE 2 -``` -PS C:\>Remove-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Force -``` - -This example deletes the specified DHCPv6 scope from the specified DHCP server service without requesting user confirmation even if the scope is active or contains active client leases. - -### EXAMPLE 3 -``` -PS C:\>Get-DhcpServerv6Scope | Where-Object -FilterScript { $_.State -Eq "Inactive" } | Remove-DhcpServerv6Scope -Force -Passthru -``` - -This example deletes all of the disabled scopes on the DHCP server service. -The Get-DhcpServerv6Scope cmdlet returns the scope objects and pipes the objects into the Where-Objecthttp://go.microsoft.com/fwlink/p/?LinkID=113423 cmdlet. -The Where-Objecthttp://go.microsoft.com/fwlink/p/?LinkID=113423 cmdlet filters the scope objects for the state being InActive (or disabled) and pipes the objects into this cmdlet, which deletes the disabled scopes passed through the pipeline. -If non-empty scopes are deleted without the **Force** parameter, then the cmdlet displays an error. -This cmdlet does not prompt for user confirmation. -Active scopes that are empty get deleted without the **Force** parameter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that the scope will be deleted even if there are active leases in the scope. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies one or more IPv6 subnet prefixes of the scopes being deleted. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Add-DhcpServerv6Scope](./Add-DhcpServerv6Scope.md) - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - -[Get-DhcpServerv6ScopeStatistics](./Get-DhcpServerv6ScopeStatistics.md) - -[Set-DhcpServerv6Scope](./Set-DhcpServerv6Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Restore-DhcpServer.md b/docset/winserver2012-ps/dhcpserver/Restore-DhcpServer.md deleted file mode 100644 index 714c553fc1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Restore-DhcpServer.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/restore-dhcpserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-DhcpServer - -## SYNOPSIS -Restores the database of the Dynamic Host Configuration Protocol (DHCP) server service from the specified location. - -## SYNTAX - -``` -Restore-DhcpServer [-Path] [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Restore-DhcpServer** cmdlet restores the database of the Dynamic Host Configuration Protocol (DHCP) server service from the specified location. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Restore-DhcpServer -ComputerName dhcpserver.contoso.com -Path C:\Windows\system32\dhcp\backup -``` - -This example restores the DHCP server service database from the specified location. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the location where the backup database is stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Backup-DhcpServer](./Backup-DhcpServer.md) - -[Export-DhcpServer](./Export-DhcpServer.md) - -[Import-DhcpServer](./Import-DhcpServer.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerAuditLog.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerAuditLog.md deleted file mode 100644 index 3fec7484f6..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerAuditLog.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverauditlog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerAuditLog - -## SYNOPSIS -Sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer. - -## SYNTAX - -``` -Set-DhcpServerAuditLog [[-Enable] ] [[-Path] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-DiskCheckInterval ] [-MaxMBFileSize ] [-MinMBDiskSpace ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerAuditLog** cmdlet sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer This cmdlet also sets the enabled state for the DHCP server service audit log. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerAuditLog -ComputerName dhcpserver.contoso.com -Enable True -Path D:\dhcpauditlog\ -MaxMBFileSize 100 -``` - -This example enables the audit log of the DHCP server service and sets the path for the audit log to D:\dhcpauditlog\ directory. -This cmdlet also sets the maximum size for the audit log file to 100 MB. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskCheckInterval -Specifies the number of audit log events after which the DHCP server service will check the available disk space as specifies in the **MinMBDiskSpace** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enable -Specifies the enabled state of the DHCP server service audit log. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxMBFileSize -Specifies the maximum size of the audit log, in megabytes (MB). - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinMBDiskSpace -Specifies the minimum required disk space, in megabytes (MB), for audit log storage. - -Before logging a new audit log message, the DHCP server service checks if the minimum disk space specified by this parameter is available on the disk. - -If minimum disk space is not available, then the DHCP server service stops audit logging until the required minimum disk space is available. - -If this parameter value is set to `0` or left as default, then the minimum disk space is set to `20` MB. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the directory where the audit log files are created by the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerAuditLog -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerAuditLog -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerAuditLog](./Get-DhcpServerAuditLog.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerDatabase.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerDatabase.md deleted file mode 100644 index fbdef7d45f..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerDatabase.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverdatabase?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerDatabase - -## SYNOPSIS -Modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Set-DhcpServerDatabase [[-FileName] ] [[-BackupPath] ] [-AsJob] [-BackupInterval ] - [-CimSession ] [-CleanupInterval ] [-ComputerName ] [-PassThru] - [-RestoreFromBackup ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerDatabase** cmdlet modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerDatabase -ComputerName dhcpserver.contoso.com -FileName D:\NewDhcpPath\dhcp.mdb -BackupPath D:\NewDhcpPath\backup -BackupInterval 30 -CleanupInterval 120 -``` - -This example sets the file name to D:\NewDhcpPath\dhcp.mdb and the backup path to D:\NewDhcpPath\backup. -This cmdlet also sets the periodicity of the database backup to 30 minutes and the periodic cleanup of the database to 120 minutes. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupInterval -Specifies the interval of time between automatic database backups, in minutes. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -BackupPath -Specifies the path of the directory where the database should be backed up. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CleanupInterval -Specifies the interval of time for database cleanup, in minutes. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileName -Specifies the name of the database backup file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RestoreFromBackup -Indicates that database has to be restored from backup. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerDatabase - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerDatabase -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerDatabase](./Get-DhcpServerDatabase.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerSetting.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerSetting.md deleted file mode 100644 index cf9716e1d3..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerSetting.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserversetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerSetting - -## SYNOPSIS -Sets one or more server level configuration parameters for the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Set-DhcpServerSetting [-ActivatePolicies ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ConflictDetectionAttempts ] [-NapEnabled ] - [-NpsUnreachableAction ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerSetting** cmdlet sets one or more server level configuration parameters for the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerSetting -ComputerName dhcpserver.contoso.com -NapEnabled True -ConflictDetectionAttempts 1 -ActivatePolicies False -``` - -This example enables the NAP check, sets the number of conflict detection attempts to 1, and disables policy enforcement on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -ActivatePolicies -Specifies the enabled state for enforcement of policies. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConflictDetectionAttempts -Specifies the number of times that the DHCP server service should attempt conflict detection before leasing an IP address. -The acceptable values for this parameter are: 0 through 5. -The default value is 0. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapEnabled -Specifies the enabled state for the Network Access Policy (NAP) check on the DHCP server service. - -If this parameter is set to True, then NAP is enabled and the DHCP server service uses the Network Policy Server (NPS) to perform a NAP check before leasing an IP address. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NpsUnreachableAction -Specifies that, if the **NapEnabled** parameter is set to True and the NPS server is unreachable, the default action that the DHCP server service performs. -The acceptable values for this parameter are: Full, Restricted, or NoAccess. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerSetting](./Get-DhcpServerSetting.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Binding.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Binding.md deleted file mode 100644 index 65b4f3dc89..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Binding.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4binding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4Binding - -## SYNOPSIS -Sets the binding state of specified IPv4 interface for the Dynamic Host Configuration Protocol (DHCP) server service running on the specified computer. - -## SYNTAX - -``` -Set-DhcpServerv4Binding [-InterfaceAlias] [-BindingState] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4Binding** cmdlet sets the binding state of the specified IPv4 interface for the Dynamic Host Configuration Protocol (DHCP) server service running on the specified computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4Binding -BindingState $True -InterfaceAlias "Wired Ethernet Connection" -``` - -This example binds the DHCPv4 server service to the network interface named Wired Ethernet Connection. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BindingState -Specifies the binding state of the interface. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies one or more names of the interface on the computer. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Binding[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Binding[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4Binding](./Get-DhcpServerv4Binding.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Class.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Class.md deleted file mode 100644 index 5b6bacbb4f..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Class.md +++ /dev/null @@ -1,236 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4Class - -## SYNOPSIS -Modifies an IPv4 vendor class or user class on the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -## SYNTAX - -``` -Set-DhcpServerv4Class [-Name] [-Type] [[-Data] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Description ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4Class** cmdlet modifies an IPv4 vendor class or user class on the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. - -The **Description** or **Data** parameter must be specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4Class -Name "User Class for Lab Computers" -Type User -Data "LabComputers" -``` - -This example sets the data for a DHCPv4 user class for lab computers to LabComputers. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv4Class -Name "MSUCClient" -Type Vendor -Data "MS-UC-Client" -``` - -This example sets the data for the DHCPv4 vendor class for Microsoft Unified Communication clients on the DHCP server service to MS-UC-Client. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Data -Specifies the data for the specified vendor or user class. -This parameter value is expected in the request from the client belonging to the specified vendor or user class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description string to set on the vendor or user class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the user or vendor class being modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class being modified. -The acceptable values for this parameter are: Vendor or User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Class](./Add-DhcpServerv4Class.md) - -[Get-DhcpServerv4Class](./Get-DhcpServerv4Class.md) - -[Remove-DhcpServerv4Class](./Remove-DhcpServerv4Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4DnsSetting.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4DnsSetting.md deleted file mode 100644 index 52c7e02cd2..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4DnsSetting.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4dnssetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4DnsSetting - -## SYNOPSIS -Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. - -## SYNTAX - -``` -Set-DhcpServerv4DnsSetting [[-ScopeId] ] [[-IPAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-DeleteDnsRROnLeaseExpiry ] - [-DynamicUpdates ] [-NameProtection ] [-PassThru] [-ThrottleLimit ] - [-UpdateDnsRRForOlderClients ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4DnsSetting** cmdlet configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. -The **ScopeId** or **IPAddress** parameter must be specified with at least one of the optional parameters. - -The **ScopeId** and **IPAddress** parameters cannot both be specified. - -If neither the **ScopeId** nor **IPAddress** parameter is specified, then the specified DNS update settings are set to the server level. - -This cmdlet modifies the effective DNS update setting and sets the setting on the specified reservation, scope or server. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4DnsSetting -ComputerName dhcpserver.contoso.com -DynamicUpdates Always -DeleteDnsRRonLeaseExpiry True -``` - -This example sets the server level, or server-wide, DNS update configuration settings to always update DNS with leases entries and deletes the client entry from DNS when the lease expires. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv4DnsSetting -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -DynamicUpdates OnClientRequest -NameProtection True -``` - -This example sets the DNS update configuration settings for scope 10.10.10.0 to update the DNS with leases entries based on client request, indicated in the FQDN option (option ID 81), and enables name protection by creating dynamic host configuration identifier (DHCID) resource records. - -### EXAMPLE 3 -``` -PS C:\>Set-DhcpServerv4DnsSetting -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.5 -DynamicUpdates Never -``` - -This example sets the DNS update configuration settings for the reserved IP address 10.10.10.5 to never update the DNS for client lease entries. -This cmdlet clears all of the properties other than the property that is specified. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteDnsRROnLeaseExpiry -Specifies that the DHCP server service should delete the DNS resource records for the client after the lease expires. -The acceptable values for this parameter are: True or False. -This parameter can only be set if the **DynamicUpdate** parameter is set to Always or OnClientRequest. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DynamicUpdates -Specifies the conditions under which to perform dynamic updates on the DNS server. -The acceptable values for this parameter are: Always, Never, or OnClientRequest. - - - Always: The DHCP server service will always perform dynamic DNS registration of A and PTR records for the clients. - - - Never: The DHCP server service will not perform any dynamic DNS registration - - - OnClientRequest: The DHCP server service will perform dynamic DNS registration of A and PTR records if the client has requested the same in the DHCP client message. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv4 address of the reservation for which the specified DNS update settings are being set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameProtection -Specifies the enabled state for the DNS name protection on the DHCP server service. - -If this parameter is set to True, then DNS name protection is enabled. -If this parameter is set to True and there is an existing DNS record matching the name, then the DNS update for the client will fail instead of being overwritten. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier, in IPv4 address format, for which the DNS update settings are being set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDnsRRForOlderClients -Specifies the enabled state for the DNS registration of A and PTR records for older clients which do not request DNS updates. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4DnsSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4DnsSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4DnsSetting](./Get-DhcpServerv4DnsSetting.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Failover.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Failover.md deleted file mode 100644 index 18353bb1a2..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Failover.md +++ /dev/null @@ -1,338 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4failover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4Failover - -## SYNOPSIS -Modifies the properties of an existing failover relationship. - -## SYNTAX - -``` -Set-DhcpServerv4Failover [-Name] [-AsJob] [-AutoStateTransition ] - [-CimSession ] [-ComputerName ] [-Force] [-LoadBalancePercent ] - [-MaxClientLeadTime ] [-PartnerDown] [-PassThru] [-ReservePercent ] [-SharedSecret ] - [-StateSwitchInterval ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4Failover** cmdlet modifies the properties of an existing failover relationship. - -If the failover mode of relation is Load Balance mode, then the **LoadBalancePercent**, **MaxClientLeadTime**, **StateSwitchInterval**, **AutoStateTransition**, **SharedSecret**, and **PartnerDown** parameters can be specified. - -If the failover mode of relation is Hot Standby mode, then the **ReservePercent**, **MaxClientLeadTime**, **StateSwitchInterval**, **AutoStateTransition**, **SharedSecret**, and **PartnerDown** parameters can be specified. - -If the **SharedSecret** parameter is specified, then the message digest authentication is enabled for the failover relationship. - -If the **SharedSecret** parameter value is specified as Null, then enableauth will be set to False in the data structure. - -If the **SharedSecret** parameter is specified, then confirmation will be sought from the user to transport the shared secret in the clear text on the network. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -LoadBalancePercent 70 -MaxClientLeadTime 2:00:00 -AutoStateTransition True -StateSwitchInterval 2:00:00 -``` - -This example modifies the parameters of the Load Balance failover relationship named SFO-SIN-Failover on the computer named dhcpserver.contoso.com as follows: 70% of the client requests will be served by the DHCP server service running on the computer named dhcpserver.contoso.com and 30% of the client requests will be served by the DHCP server service running on the computer named dhcpserver2.contoso.com. -The maximum client lead time for the failover relationship is set to 2 hours. -The automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state is enabled and the timer for automatic state transition is set to 2 hours. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv4Failover -ComputerName dhcpserver.contoso.com -Name SFO-SIN-Failover -ReservePercent 10 -MaxClientLeadTime 2:00:00 -AutoStateTransition True -StateSwitchInterval 2:00:00 -``` - -This example modifies the parameters of the Hot Standby failover relationship named SFO-SIN-Failover on computer named dhcpserver.contoso.com as follows: 10% of the free IP addresses in the scopes will be reserved for the standby DHCP server service. -The maximum client lead time for the failover relationship is set to 2 hours. -The automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state is enabled and the timer for automatic state transition is set to 2 hours. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoStateTransition -Specifies the enabled state for automatic state transition from the COMMUNICATION INTERRUPTED state to the PARTNER DOWN state based on expiration of the timer, using the **StateSwitchInterval** parameter, while in the COMMUNICATION INTERRUPTED state. -The acceptable values for this parameter are: True or False. -The default value is False. -Note: This parameter value is set to True, if the **StateSwitchInterval** parameter is specified. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies, if the **SharedSecret** parameter is specified, that user confirmation is required since the **SharedSecret** parameter value may be transferred in plain text transport in the case of remote management. -Specifying this parameter turns off the user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancePercent -Specifies the percentage of DHCP client requests which should be served by the local DHCP server service or the DHCP server service running on the computer specified in the **ComputerName** parameter. -The remaining DHCP client requests would be served by the partner DHCP server service. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxClientLeadTime -Specifies the maximum client lead time for the failover relationship. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of failover relationship for which the properties are modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PartnerDown -Changes the state of the DHCP server service from COMMUNICATION INTERRUPTED to PARTNER DOWN. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReservePercent -Specifies the percentage of the free IPv4 address pool for the scope which should be reserved on the standby DHCP server service. - -In the case of a failover, the IPv4 addresses from this reserved pool on the standby DHCP server service will be leased to new DHCP clients. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SharedSecret -Specifies the shared secret to be used for message authentication. -To turn off message authentication, set this parameter value to Null. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StateSwitchInterval -Specifies the time interval for which the DHCP server service should continue to operate in the COMMUNICATION INTERRUPTED state before transitioning to the PARTNER DOWN state. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Failover -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Failover](./Add-DhcpServerv4Failover.md) - -[Add-DhcpServerv4FailoverScope](./Add-DhcpServerv4FailoverScope.md) - -[Get-DhcpServerv4Failover](./Get-DhcpServerv4Failover.md) - -[Invoke-DhcpServerv4FailoverReplication](./Invoke-DhcpServerv4FailoverReplication.md) - -[Remove-DhcpServerv4Failover](./Remove-DhcpServerv4Failover.md) - -[Remove-DhcpServerv4FailoverScope](./Remove-DhcpServerv4FailoverScope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4FilterList.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4FilterList.md deleted file mode 100644 index 60b598e561..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4FilterList.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4filterlist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4FilterList - -## SYNOPSIS -Sets the enabled state for the allow and the deny MAC address filter lists on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Set-DhcpServerv4FilterList [[-Allow] ] [[-Deny] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -Sets the enabled state for the allow and the deny MAC address filter lists on the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4FilterList -ComputerName dhcpserver.contoso.com -Allow True -Deny True -``` - -This example enables the allow filter and the deny filter lists on the DHCP server service running on the computer named dhcpserver.contoso.com. - -## PARAMETERS - -### -Allow -Specifies the enabled state for the MAC address filter allow list. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Deny -Specifies the enabled state for the MAC address filter deny list. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4FilterList -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4FilterList -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4FilterList](./Get-DhcpServerv4FilterList.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4OptionDefinition.md deleted file mode 100644 index 8396622b22..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4OptionDefinition.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4OptionDefinition - -## SYNOPSIS -Modifies the properties of an existing IPv4 option definition. - -## SYNTAX - -``` -Set-DhcpServerv4OptionDefinition [-OptionId] [-AsJob] [-CimSession ] - [-ComputerName ] [-DefaultValue ] [-Description ] [-Name ] [-PassThru] - [-ThrottleLimit ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4OptionDefinition** cmdlet modifies the properties of an existing IPv4 option definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4OptionDefinition -OptionId 3 -Name "Default Gateway" -Description "router set for the subnet" -``` - -This example sets the name and description for option definition matching the ID 3. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultValue -Specifies the default value to set for the option definition. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set for the option definition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the new name to set for the option definition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numeric identifier (ID) of the option definition being modified. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorClass -Modifies the properties of the option definition for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4OptionDefinition](./Add-DhcpServerv4OptionDefinition.md) - -[Get-DhcpServerv4OptionDefinition](./Get-DhcpServerv4OptionDefinition.md) - -[Remove-DhcpServerv4OptionDefinition](./Remove-DhcpServerv4OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4OptionValue.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4OptionValue.md deleted file mode 100644 index 784286615d..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4OptionValue.md +++ /dev/null @@ -1,466 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4optionvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4OptionValue - -## SYNOPSIS -Sets an IPv4 option value at the server, scope, or reservation level. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DhcpServerv4OptionValue [-OptionId] [-Value] [[-ScopeId] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-PolicyName ] - [-ReservedIP ] [-ThrottleLimit ] [-UserClass ] [-VendorClass ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DhcpServerv4OptionValue [[-ScopeId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-DnsDomain ] [-DnsServer ] [-Force] [-PassThru] - [-PolicyName ] [-ReservedIP ] [-Router ] [-ThrottleLimit ] - [-UserClass ] [-WinsServer ] [-Wpad ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4OptionValue** cmdlet sets an IPv4 option value at the server, scope, or reservation level. -The definition for the option must already exist. -This cmdlet will fail if the option definition does not exist in the Dynamic Host Configuration Protocol (DHCP) server service. -If only the **ReservedIP** parameter is specified, then the option values are set at the reservation level. -If only the **ScopeId** parameter is specified, then the option values are set at the scope level. -If neither the **ScopeId** nor **ReservedIP** parameter is specified, then the option values are set at the server level. -If the **VendorClass** parameter is specified, then the option value is set for that vendor class. -If the **UserClass** parameter is specified, then the option value is set for that user class. -If the **PolicyName** parameter is specified, then the option values are set for that policy. -The **UserClass** and **PolicyName** parameters cannot both be specified. -The **ScopeId** and **ReservedIP** parameters cannot both be specified. - -The **PolicyName** and **ReservedIP** parameters cannot both be specified. - -Note: The option values for policies can only be set for a DHCP server service running on Windows Server® 2012. -Setting user class options for a DHCP server service running on Windows Server 2012 creates of a policy with the policy name set to the name of the user class. -For a DHCP server service running on firstref_server_7 or earlier, only option values based upon the user class can be set. - -To set options based upon legacy user classes, then the **UserClass** parameter must be specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -DnsServer 192.168.1.2 -WinsServer 192.168.1.3 -DnsDomain contoso.com -Router 192.168.1.1 -Wpad http://proxy.contoso.com/wpad.dat -``` - -This example sets the server level option values for DNS server, WINS server, DNS domain, router, and WPAD. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -DnsServer 192.168.1.2 -WinsServer 192.168.1.3 -DnsDomain contoso.com -Router 192.168.1.1 -Wpad http://proxy.contoso.com/wpad.dat -``` - -This example sets the option values for DNS server, WINS server, DNS domain, router, and WPAD for scope 10.10.10.0. - -### EXAMPLE 3 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 10.10.10.5 -DnsServer 192.168.1.2 -WinsServer 192.168.1.3 -DnsDomain contoso.com -Router 192.168.1.1 -Wpad http://proxy.contoso.com/wpad.dat -``` - -This example sets the option values for DNS server, WINS server, DNS domain, router, and WPAD for reserved IP address 10.10.10.5. - -### EXAMPLE 4 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -PolicyName LabComputers -DnsServer 192.168.1.2 -WinsServer 192.168.1.3 -DnsDomain contoso.com -Router 192.168.1.1 -Wpad http://proxy.contoso.com/wpad.dat -``` - -This example sets the option values for DNS server, WINS server, DNS domain, router, and WPAD for policy named LabComputers in the scope 10.10.10.0. - -### EXAMPLE 5 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -OptionId 6 -Value 192.168.1.1 -``` - -This example sets the server-wide DHCPv4 option value for option ID 6, or DNS server. - -### EXAMPLE 6 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -OptionId 6 -Value 192.168.1.1 -``` - -This example sets the DHCPv4 option value for option ID 6, or DNS server, for the scope 10.10.10.0. - -### EXAMPLE 7 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 10.10.10.5 -OptionId 6 -Value 192.168.1.1 -``` - -This example sets the DHCPv4 option value for option ID 6, or DNS server, for the specified reservation. - -### EXAMPLE 8 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -VendorClass MSUCClient -OptionId 5 -Value 6874747073 -``` - -This example sets the vendor-class-specific DHCPv4 option value for option ID 5 on the specified scope for the specified vendor class named MSUCClient. - -### EXAMPLE 9 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -PolicyName PrinterPolicy -OptionId 6 -Value 192.168.1.10 -``` - -This example sets the DHCPv4 option value for option ID 6, or DNS server, on the specified scope for the specified policy. - -### EXAMPLE 10 -``` -PS C:\>Set-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -UserClass LabComputer -OptionId 6 -Value 192.168.1.10 -``` - -This example sets the user-class-specific DHCPv4 option value for option ID 6, or DNS server, on the specified scope for the specified user class. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsDomain -Specifies the value for the DNS domain option. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsServer -Specifies one or more values for the DNS server option, in the IPv4 address format. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Specifies that the DNS server validation will be skipped. -This parameter is only applicable if the **DnsServer** parameter is specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numeric identifier (ID) of the option for which one or more values are set. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyName -Specifies the name of the policy for which one or more option values are set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservedIP -Specifies the IPv4 address of the reservation for which one or more option values are set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Router -Specifies one or more values for the router or default gateway option, in IPv4 address format. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format for which one or more option values are set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Sets the option value for the specified user class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies one or more values to be set for the option. -The format that the values need to be specified is specified per the data type of the options as follows: - - -- Byte, Word, DWord, DWordDword: The values need to be specified as decimal or hexadecimal strings - - -- IPAddress, IPv6Address: The values will need to be specified as strings - - -- String: The values will need to be specified as strings - - -- BinaryData, EncapsulatedData: The values will need to be specified as hexadecimal strings - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Sets the option value for the specified vendor class. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WinsServer -Specifies the values for the WINS server option, in IPv4 address format. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Wpad -Specifies the value for the web proxy auto detection option. -The value for this option is specified as a URL. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv4OptionValue](./Get-DhcpServerv4OptionValue.md) - -[Remove-DhcpServerv4OptionValue](./Remove-DhcpServerv4OptionValue.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Policy.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Policy.md deleted file mode 100644 index 692848743e..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Policy.md +++ /dev/null @@ -1,508 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4policy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4Policy - -## SYNOPSIS -Sets the properties of an existing policy either at the server level or at the specified scope level. - -## SYNTAX - -``` -Set-DhcpServerv4Policy [-Name] [[-ScopeId] ] [-AsJob] [-CimSession ] - [-CircuitId ] [-ClientId ] [-ComputerName ] [-Condition ] - [-Description ] [-Enabled ] [-MacAddress ] [-NewName ] [-PassThru] - [-ProcessingOrder ] [-RelayAgent ] [-RemoteId ] [-SubscriberId ] - [-ThrottleLimit ] [-UserClass ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4Policy** cmdlet sets the properties of an existing policy either at the server level or at the specified scope level. -If the **VendorClass**, **UserClass**, **MacAddress**, **ClientId**, **RelayAgent**, **CircuitId**, **RemoteId** or **SubscriberId** parameter are specified, then the conditions of the policy are being changed and this cmdlet will behave as follows: - -If the **VendorClass** parameter is specified and the policy being modified already has conditions for the **VendorClass** parameter value, then the existing **VendorCass** parameter value is removed and the new **VendorClass** parameter value will be added. - -However, if the policy being modified has conditions for the **MacAddress** parameter value, then the **MacAddress** parameter value is not altered and is logically combined (ORꞌd) or differenced (ANDꞌd) with the vendor class based conditions. - -The same applies to any of the **VendorClass**, **UserClass**, **MacAddress**, **ClientId**, **RelayAgent**, **CircuitId**, **RemoteId** and **SubscriberId** parameters used in the conditions. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name DevicesPolicy -NewName TabletPolicy -Description "policy for tablet devices" -ProcessingOrder 4 -Enabled False -``` - -This example renames the server level policy named DevicesPolicy to TabletPolicy, sets a description string, disables the policy, and sets the processing order to 4. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv4Policy -Name PhysicalMachinesPolicy -Condition OR -MacAddress NE,00155D*,000569* -``` - -This example modifies the conditions of the server level policy for non-Hyper-V clients. -If the policy had an existing MAC address based condition, then the same condition is replaced with the condition specified in this cmdlet. -However, if the policy had conditions based on other fields, such as the **VendorClass**, **UserClass**, **ClientId**, or **RelayAgent** parameters, then those will be retained and logically combined (ORꞌd) with the newly added MAC address based condition. - -### EXAMPLE 3 -``` -PS C:\>Set-DhcpServerv4Policy -Name PhysicalMachinesPolicy -Condition OR -MacAddress NE,00155D*,000569* -VendorClass "" -``` - -This example modifies the conditions of the server level policy for non-Hyper-V clients. -If the policy had an existing MAC address based condition, a vendor class based policy, or both, then the conditions are replaced with the condition specified in this cmdlet. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CircuitId -Specifies the comparator to use and the values with which to compare the circuit identifier (ID) sub-option. -The first element is the comparator, EQ or NE, followed by a single value. -No wildcards characters are allowed. - -The value can be followed by another comparator, EQ or NE, which is followed by another value. - -The input format for the value is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ClientId -Specifies the comparator to use and the values with which to compare the client identifier. -The first element is the comparator, EQ or NE, followed by a set of values. -If the last character in a value is an asterisk (`*`), then the following characters are treated as wildcard characters for the comparison. - -The values can be followed by another comparator, EQ or NE, which is followed by another set of values. - -The input format is a hexadecimal string with or without hyphen separation. -The output format is a hexadecimal string with hyphen separation. - -The values following the EQ operator will be treated as multiple assertions which are logically combined (ORꞌd). - -The values following the NE operator will be treated as multiple assertions which are logically differenced (ANDꞌd). - -An example of the format is: `EQ, 00-11-22-33-44-55, AA-BB-CC-DD-EE*`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -Specifies the logical operator between the conditions when multiple conditions are specified. -The acceptable values for this parameter are: AND or OR. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set on the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enabled -Specifies the enabled state for the policy. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MacAddress -Specifies the comparator to use and the values with which to compare the MAC Address in the client request. -The first element is the comparator, EQ or NE, followed by a set of values. -If the last character in the value is an asterisk (`*`), then the following characters are treated as wildcard characters for the comparison. - -The values can be followed by another comparator, EQ or NE, which is followed by another set of values. - -The input format is a hexadecimal string with or without hyphen separation. -A trailing wildcard character can be used to indicate partial match. -The output format is a hexadecimal string with hyphen separation. - -The values following the EQ operator will be treated as multiple assertions which are logically combined (ORꞌd). - -The values following the NE operator will be treated as multiple assertions which are logically differenced (ANDꞌd). - -An example of the format is: `00-1F-3B-7C-B7-89, 00-1F-3B-7C-B7-*, 001F3B7CB789`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the policy being modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name to set for the policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessingOrder -Specifies the order for this policy with respect to other policies in the scope or DHCP server service. -The DHCP server service will process the policies in the specified order while evaluating client requests using the configured policies. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RelayAgent -Specifies the comparator to use and the values with which to compare the relay agent information. -The first element is the comparator, EQ or NE, followed by a set of values. -No wildcard characters are allowed. - -The values can be followed by another comparator, EQ or NE, which is followed by another set of values. - -The input format is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemoteId -Specifies the comparator to use and the values with which to compare the remote ID suboption. -The first element is the comparator, EQ or NE, followed by a single value. -No wildcard characters are allowed. - -The value can again be followed by another comparator, EQ or NE, which is followed by another value. - -The input format for the value is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope ID, in IPv4 address format, of the scope which contains the policy. -If this parameter is not specified, then the server level policy is modified. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SubscriberId -Specifies the comparator to use and the values with which to compare the subscriber ID suboption. -The first element is the comparator, EQ or NE, and followed by a single value. -No wildcard characters are allowed. - -The value can again be followed by another comparator, EQ or NE, which is followed by another value. - -The input format is a hexadecimal string with or without hyphen separation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Specifies the comparator to use and the user class values with which to compare the user class field in the client request. -The first element to be specified is the comparator, EQ or NE, and followed by a set values. -If the last character in the value is an asterisk (`*`), then the subsequent characters are treated as wildcard characters for the comparison. - -The values can be followed by another comparator, EQ or NE, which is followed by another set of values. - -The values to be specified must be the user class names that already exist on the DHCP server service. - -The format of the value should be a hexadecimal string starting with `0x`. - -The values following the EQ operator are treated as multiple assertions which are logically combined (ORꞌd). - -The values following the NE operator are treated as multiple assertions which are logically differenced (ANDꞌd). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Specifies the comparator to use and the vendor class values with which to compare the vendor class field in the client request. -The first element is the comparator, EQ or NE, followed by a set of values. -If the last character in a value is an asterisk (`*`), then the subsequent characters are treated as wildcard characters for the comparison. - -The values can be followed by another comparator. -EQ or NE, which is followed by another set of values. - -The values to be specified must be the vendor class names that already exist on the DHCP server service. - -The format of the value should be a hexadecimal string starting with `0x`. - -The values following the EQ operator are treated as multiple assertions which are logically combined (ORꞌd). - -The values following the NE operator are treated as multiple assertions which are logically differenced (ANDꞌd). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Policy](./Add-DhcpServerv4Policy.md) - -[Add-DhcpServerv4PolicyIPRange](./Add-DhcpServerv4PolicyIPRange.md) - -[Get-DhcpServerv4Policy](./Get-DhcpServerv4Policy.md) - -[Get-DhcpServerv4PolicyIPRange](./Get-DhcpServerv4PolicyIPRange.md) - -[Remove-DhcpServerv4Policy](./Remove-DhcpServerv4Policy.md) - -[Remove-DhcpServerv4PolicyIPRange](./Remove-DhcpServerv4PolicyIPRange.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Reservation.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Reservation.md deleted file mode 100644 index 320efd917b..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Reservation.md +++ /dev/null @@ -1,244 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4Reservation - -## SYNOPSIS -Modifies the properties of an IPv4 reservation. - -## SYNTAX - -``` -Set-DhcpServerv4Reservation [-IPAddress] [-AsJob] [-CimSession ] [-ClientId ] - [-ComputerName ] [-Description ] [-Name ] [-PassThru] [-ThrottleLimit ] - [-Type ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4Reservation** cmdlet modifies the properties of an IPv4 reservation. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4Reservation -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.5 -Description "Fourth Floor Printer" -Name printer.contoso.com -``` - -This example sets the name and description for an existing DHCPv4 reservation for IP address 10.10.10.5. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientId -Specifies the value of the client identifier (ID) to set on the reservation. -For Windows clients, the MAC address is used as the client ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set for the reservation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv4 address of the reservation for which the properties are modified. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name to set for the reservation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of client that can be leased the reserved IPv4 address. -The acceptable values for this parameter are: Dhcp, BootP, or Both. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Reservation](./Add-DhcpServerv4Reservation.md) - -[Get-DhcpServerv4Reservation](./Get-DhcpServerv4Reservation.md) - -[Remove-DhcpServerv4Reservation](./Remove-DhcpServerv4Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Scope.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Scope.md deleted file mode 100644 index ce82927595..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv4Scope.md +++ /dev/null @@ -1,402 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv4scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv4Scope - -## SYNOPSIS -Sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DhcpServerv4Scope [-ScopeId] [-ActivatePolicies ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Delay ] [-Description ] - [-LeaseDuration ] [-MaxBootpClients ] [-Name ] [-NapEnable ] - [-NapProfile ] [-PassThru] [-State ] [-SuperscopeName ] [-ThrottleLimit ] - [-Type ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DhcpServerv4Scope [-ScopeId] [-ActivatePolicies ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Delay ] [-Description ] - [-LeaseDuration ] [-MaxBootpClients ] [-Name ] [-NapEnable ] - [-NapProfile ] [-PassThru] [-State ] [-SuperscopeName ] [-ThrottleLimit ] - [-Type ] -EndRange -StartRange [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv4Scope** cmdlet sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -Name "Ext Lab Net VLAN100" -State Active -LeaseDuration 4.00:00:00 -``` - -This example sets the name of the specified DHCPv4 scope to Ext Lab Net VLAN100, activates the scope, and sets the lease duration to 4 days. - -## PARAMETERS - -### -ActivatePolicies -Specifies the enabled state for the policy enforcement on the scope. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delay -Specifies the time, in milliseconds, by which the DHCP server service should delay sending a response to the clients. -This parameter should be used on the secondary DHCP server service in a split scope configuration. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set for the scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndRange -Specifies the ending address of the IPv4 range to set for the scope. -If a new IPv4 range is being set, then the previously set IPv4 range of the scope is discarded. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LeaseDuration -Specifies the duration of the IPv4 address lease to give for the clients of the scope. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxBootpClients -Specifies the maximum number of Bootp clients permitted to get an IP address lease from the scope. -This parameter can only be used if the **Type** parameter value is set to Both. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name to set for the scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapEnable -Specifies the enabled state for network access protection (NAP) for the scope. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NapProfile -Specifies the name of the NAP profile for clients in the scope. -The NAP profile refers to the Microsoft Service Class which is a condition used in network policies on the network policy server (NPS). -This parameter can only be used if the **NapEnable** parameter value is set to True. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScopeId -Specifies the scope identifier (ID), in IPv4 address format, for which the properties are being set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartRange -Specifies the starting address of the IPv4 range to set for the scope. -If a new IP range is being set, then the previously set IP range of the scope is discarded. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the scope. -The acceptable values for this parameter are: Active and InActive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SuperscopeName -Specifies the name of the superscope to which this scope is added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the scope. -The acceptable values for this parameter are: DHCP, BootP, and Both. -The type of the scope determines if the DHCP server service responds to only DHCP client requests, only BootP client requests, or Both types of clients. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv4Scope](./Add-DhcpServerv4Scope.md) - -[Get-DhcpServerv4Scope](./Get-DhcpServerv4Scope.md) - -[Get-DhcpServerv4ScopeStatistics](./Get-DhcpServerv4ScopeStatistics.md) - -[Remove-DhcpServerv4Scope](./Remove-DhcpServerv4Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Binding.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Binding.md deleted file mode 100644 index d0a49e7cf8..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Binding.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6binding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6Binding - -## SYNOPSIS -Sets the binding state for the specified IPv6 interface of the Dynamic Host Configuration Protocol (DHCP) server service on the computer. - -## SYNTAX - -``` -Set-DhcpServerv6Binding [-InterfaceAlias] [-BindingState] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6Binding** cmdlet sets the binding state for the specified IPv6 interface of the Dynamic Host Configuration Protocol (DHCP) server service on the computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv6Binding -BindingState True -InterfaceAlias "Wired Ethernet Connection" -``` - -This example binds the DHCPv6 server service to the network interface named Wired Ethernet Connection. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv6Binding -BindingState False -InterfaceAlias "Wired Ethernet Connection" -``` - -This example un-binds the DHCPv6 server service to the network interface named Wired Ethernet Connection. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BindingState -Specifies the binding state of the IPv6 interface. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies the interface name of the computer. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Binding -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Binding[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6Binding](./Get-DhcpServerv6Binding.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Class.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Class.md deleted file mode 100644 index 91c5bf9492..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Class.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6class?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6Class - -## SYNOPSIS -Modifies the properties of an IPv6 vendor or user class on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Set-DhcpServerv6Class [-Name] [-Type] [[-Data] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Description ] [-PassThru] - [-ThrottleLimit ] [-VendorId ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6Class** cmdlet modifies the properties of an IPv6 vendor or user class on the Dynamic Host Configuration Protocol (DHCP) server. -At least one of the **Description**, **VendorId**, and **Data** parameter must be specified. -The **VendorId** parameter must not be specified if a user class is being modified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv6Class -Name "User Class for Lab Computers" -Data "LabComputers" -Type User -``` - -This example sets the data for the DHCPv6 user class for lab computers. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv6Class -Name "Vendor Class for Printers" -Data "JetPrinters" -VendorId 100 -Type Vendor -``` - -This example sets the data and vendor identifier (ID) for the DHCPv6 vendor class for printers. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Data -Specifies the data for the specified vendor or user class. -This parameter value is expected to be present in the request from the client belonging to the vendor class. -The format for this parameter can be given as ANSI or hexadecimal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set on the class being modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of vendor or user class being modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the class. -The acceptable values for this parameter are: Vendor or User. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorId -Specifies the enterprise number of the vendor class. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Class -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Class](./Add-DhcpServerv6Class.md) - -[Get-DhcpServerv6Class](./Get-DhcpServerv6Class.md) - -[Remove-DhcpServerv6Class](./Remove-DhcpServerv6Class.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6DnsSetting.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6DnsSetting.md deleted file mode 100644 index 47ef48945a..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6DnsSetting.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6dnssetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6DnsSetting - -## SYNOPSIS -Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. - -## SYNTAX - -``` -Set-DhcpServerv6DnsSetting [[-Prefix] ] [[-IPAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-DeleteDnsRROnLeaseExpiry ] - [-DynamicUpdates ] [-NameProtection ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6DnsSetting** cmdlet configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. -The **Prefix** or **IPAddress** parameter must be specified with at least one of the optional parameters. -The **Prefix** and **IPAddress** cannot both be specified. -If neither the **Prefix** nor **IPAddress** parameter is specified, then this cmdlet sets DNS update setting at the server level. - -This cmdlet modifies the effective DNS update setting and sets it on the specified reservation, scope, or server level. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -DynamicUpdates Always -DeleteDnsRRonLeaseExpiry $true -``` - -This example sets the DHCPv6 server level, or server-wide, DNS update configuration settings to always update DNS with leases entries, enables NAP protection by creating dynamic host configuration identifier (DHCID) resource records, and deletes the client entry from the DNS server when the lease expires. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -DynamicUpdates OnClientRequest -NameProtection $true -``` - -This example sets the DNS update configuration settings for scope 2001:4898:7020:1020:: to update the DNS server with lease entries based on client request using the fully qualified domain name (FQDN) option (ID `81`), and enables name protection by creating dynamic host configuration identifier (DHCID) resource records. - -### EXAMPLE 3 -``` -PS C:\>Set-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::5 -DynamicUpdates Never -``` - -This example sets the DNS update configuration settings for the reserved IP address 2001:4898:7020:1020::5 to never update the DNS server for client lease entries. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteDnsRROnLeaseExpiry -Specifies that the DHCP server service should delete the DNS resource records for the DHCP client after the lease expires. -The acceptable values for this parameter are: $true or $false. -This parameter can only be set if the **DynamicUpdate** parameter is set to Always or OnClientRequest. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DynamicUpdates -Specifies the conditions under which to perform dynamic updates on the DNS server. -The acceptable values for this parameter are: Always, Never, or OnClientRequest. - - -- Always: The DHCP server service will always perform dynamic DNS registration of A and PTR records for the DHCP clients. - - -- Never: The DHCP server service will not perform any dynamic DNS registration. - - -- OnClientRequest: The DHCP server service will perform dynamic DNS registration of A and PTR records if the DHCP client has requested for the same in the DHCP client message. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv6 address of the reservation on which the DNS update behavior is being configured. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameProtection -Sets the enabled state for the name protection on the DHCP server service. - -If this parameter is specified and there is an existing DNS record already by the same name, then the DNS update for the client will fail instead of being overwritten. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the subnet prefix of the IPv6 scope on which the DNS update behavior is being configured. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6DnsSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6DnsSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6DnsSetting](./Get-DhcpServerv6DnsSetting.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6OptionDefinition.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6OptionDefinition.md deleted file mode 100644 index ad456d5244..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6OptionDefinition.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6optiondefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6OptionDefinition - -## SYNOPSIS -Modifies the properties of an existing DHCPv6 option definition. - -## SYNTAX - -``` -Set-DhcpServerv6OptionDefinition [-OptionId] [-AsJob] [-CimSession ] - [-ComputerName ] [-DefaultValue ] [-Description ] [-Name ] [-PassThru] - [-ThrottleLimit ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6OptionDefinition** cmdlet modifies the properties of an existing DHCPv6 option definition. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv6OptionDefinition -OptionId 36 -Description "Broadcast and Multicast Service Controller for IPv6 Address" -``` - -This example sets the description for option ID 36 on the DHCPv6 server service. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultValue -Specifies the default value for the option. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the option definition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the new name for the option. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numeric identifier (ID) of the option for which the definition is being modified. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorClass -Modifies the option definition only for the specified vendor class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6OptionDefinition](./Add-DhcpServerv6OptionDefinition.md) - -[Get-DhcpServerv6OptionDefinition](./Get-DhcpServerv6OptionDefinition.md) - -[Remove-DhcpServerv6OptionDefinition](./Remove-DhcpServerv6OptionDefinition.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6OptionValue.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6OptionValue.md deleted file mode 100644 index fe771f3959..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6OptionValue.md +++ /dev/null @@ -1,389 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6optionvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6OptionValue - -## SYNOPSIS -Sets an IPv6 option value at the server, scope, or reservation level. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DhcpServerv6OptionValue [-OptionId] [-Value] [[-Prefix] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-ReservedIP ] - [-ThrottleLimit ] [-UserClass ] [-VendorClass ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DhcpServerv6OptionValue [[-Prefix] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-DnsServer ] [-DomainSearchList ] [-Force] - [-InfoRefreshTime ] [-PassThru] [-ReservedIP ] [-ThrottleLimit ] - [-UserClass ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6OptionValue** cmdlet sets an IPv6 option value at the server, scope, or reservation level. -The definition for the option must already exist on the Dynamic Host Configuration Protocol (DHCP) server service. -If the **ReservedIP** parameter is specified, then the option values are set at the reservation level. -If only the **Prefix** parameter is specified, then the option values are set at the scope level. -If neither the **Prefix** nor **ReservedIP** parameter is specified, then the option values are set at the server level. -The **Prefix** and **ReservedIP** parameters cannot both be specified. - -If the **VendorClass** parameter is specified, then this cmdlet sets the option value for the specified vendor class. -If the **UserClass** parameter is specified, then this cmdlet sets the option value for the specified user class. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -DnsServer 2001:4898:7020:1020::2 -DomainSearchList contoso.com -``` - -This example sets the DHCPv6 server level option values for DNS server and domain search list options. - -### EXAMPLE 2 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -DnsServer 2001:4898:7020:1020::2 -DomainSearchList contoso.com -``` - -This example sets the DHCPv6 option values for DNS server and domain search list options on the scope 2001:4898:7020:1020::. - -### EXAMPLE 3 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -OptionId 23 -Value 2001:4898:7020:1020::2 -``` - -This example sets server-wide DHCPv6 option value for option ID 23, or the DNS server. - -### EXAMPLE 4 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -OptionId 23 -Value 2001:4898:7020:1020::2 -``` - -This example sets the DHCPv6 option value for option ID 23, or the DNS server, for the specified DHCPv6 scope. - -### EXAMPLE 5 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 2001:4898:7020:1020::5 -OptionId 23 -Value 2001:4898:7020:1020::2 -``` - -This example sets the DHCPv6 option value for option ID 23, or the DNS server, for the specified reservation. - -### EXAMPLE 6 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -VendorClass MSUCClient -OptionId 5 -Value 6874747073 -``` - -This example sets the vendor-class-specific DHCPv6 option value configured on the specified scope for the specified vendor class named MSUCClient. - -### EXAMPLE 7 -``` -PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -UserClass LabComputer -OptionId 23 -Value 2001:4898:7020:1020::20 -``` - -This example sets the user-class-specific DHCPv6 option value for option ID 23, or the DNS server, on the specified scope for the specified user class. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsServer -Specifies one or more values for the DNS server option. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DomainSearchList -Specifies one or more values for the domain search list option. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Specifies that the DNS server validation should not be performed. -This parameter is applicable only if the **DNSServer** parameter or option ID 23 is specified. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InfoRefreshTime -Specifies the value for the information refresh option. -This parameter value specifies an upper bound for how long a client should wait before refreshing information retrieved from DHCPv6 server. -This parameter is used with stateless DHCPv6 as there are no addresses or other entities with lifetimes that can tell the client when to contact the DHCPv6 server to refresh its configuration. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OptionId -Specifies the numeric identifier (ID) of the option for which a value is being set. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope on which the option value is being set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReservedIP -Specifies the IPv6 address of the reservation for which the option value is being set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserClass -Specifies the option value for the specified user class. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value being set for the option. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VendorClass -Specifies the option value for the specified vendor class. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6OptionValue](./Get-DhcpServerv6OptionValue.md) - -[Remove-DhcpServerv6OptionValue](./Remove-DhcpServerv6OptionValue.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Reservation.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Reservation.md deleted file mode 100644 index c28bcea185..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Reservation.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6reservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6Reservation - -## SYNOPSIS -Modifies the properties of the specified IPv6 reservation. - -## SYNTAX - -``` -Set-DhcpServerv6Reservation [-IPAddress] [-AsJob] [-CimSession ] - [-ClientDuid ] [-ComputerName ] [-Description ] [-Iaid ] [-Name ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6Reservation** cmdlet modifies the properties of the specified IPv6 reservation. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-DhcpServerv6Reservation -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::5 -Description "Fourth Floor Printer" -Name printer.contoso.com -``` - -This example sets the name and description for an existing DHCPv6 reservation for IP address 2001:4898:7020:1020::5. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientDuid -Specifies the DHCPv6 unique identifier (ID) to set for the reservation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set for the reservation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Iaid -Specifies the DHCPv6 interface ID (IAID) to set for the reservation. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies the IPv6 address of the reservation being modified. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name to set for the reservation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Reservation](./Add-DhcpServerv6Reservation.md) - -[Get-DhcpServerv6Reservation](./Get-DhcpServerv6Reservation.md) - -[Remove-DhcpServerv6Reservation](./Remove-DhcpServerv6Reservation.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Scope.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Scope.md deleted file mode 100644 index 596f40f306..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6Scope.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6scope?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6Scope - -## SYNOPSIS -Modifies the properties of the IPv6 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -## SYNTAX - -``` -Set-DhcpServerv6Scope [-Prefix] [-AsJob] [-CimSession ] [-ComputerName ] - [-Description ] [-Name ] [-PassThru] [-Preference ] [-PreferredLifeTime ] - [-State ] [-T1 ] [-T2 ] [-ThrottleLimit ] [-ValidLifeTime ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6Scope** cmdlet modifies the properties of the IPv6 scope on the Dynamic Host Configuration Protocol (DHCP) server service. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Name "Ext Lab Net VLAN100" -State Active -``` - -This example changes the name of the specified DHCPv6 scope to Ext Lab Net VLAN100 and activates the scope. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies the description to set on the scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the new name to set for the scope. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preference -Specifies the preference value of the DHCP server service. -The DHCP server service with the lowest preference value is selected by the DHCP client in case the client gets responses from more than one DHCP server service. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreferredLifeTime -Specifies the preferred life time of the IPv6 address leased by the DHCP server service. - -This parameter value should be same or less than the **ValidLifeTime** parameter value. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope for which the properties are modified. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -Specifies the state of the scope. -The acceptable values for this parameter are: Active or Inactive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -T1 -Specifies the lease renewal time. -The DHCP client is expected to use a unicast message to renew the lease at the time specifies by this parameter value from the same DHCP server service from which DHCP client had initially obtained the lease. -This parameter value should be less than the **T2** and **PreferredLifetime** parameter values for the scope. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -T2 -Specifies the lease rebind time. -The client is expected to use a multi-cast message to renew the lease at the time equal to this parameter value from any DHCP server service if the renewal attempt at time specified by the **T1** parameter fails. - -This parameter value should be greater than the **T1** parameter value and less than the **PreferredLifetime** parameter value. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValidLifeTime -Specifies the valid life time of the IPv6 address leased by the DHCP server service. - -This parameter value should be same or greater than the **PreferredLifetime** parameter value. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Add-DhcpServerv6Scope](./Add-DhcpServerv6Scope.md) - -[Get-DhcpServerv6Scope](./Get-DhcpServerv6Scope.md) - -[Get-DhcpServerv6ScopeStatistics](./Get-DhcpServerv6ScopeStatistics.md) - -[Remove-DhcpServerv6Scope](./Remove-DhcpServerv6Scope.md) - diff --git a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6StatelessStore.md b/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6StatelessStore.md deleted file mode 100644 index e691590fb1..0000000000 --- a/docset/winserver2012-ps/dhcpserver/Set-DhcpServerv6StatelessStore.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: DhcpServer_Cmdlets.xml -Module Name: DhcpServer -online version: https://learn.microsoft.com/powershell/module/dhcpserver/set-dhcpserverv6statelessstore?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DhcpServerv6StatelessStore - -## SYNOPSIS -Sets the properties of IPv6 stateless store for the specified IPv6 prefix. - -## SYNTAX - -``` -Set-DhcpServerv6StatelessStore [[-Prefix] ] [[-Enabled] ] [[-PurgeInterval] ] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DhcpServerv6StatelessStore** cmdlet sets the properties of IPv6 stateless store for the specified IPv6 prefix. -If the **Prefix** parameter is not specified, then the properties of the IPv6 stateless store at the server level are set. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-DhcpServerv6StatelessStore -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Enabled True -PurgeInterval 2.00:00:00 -``` - -This example enables the DHCPv6 stateless store for the scope 2001:4898:7020:1020:: and sets the purge interval for stateless client entries to 1 day. - -### EXAMPLE 2 -``` -PS C:\> Set-DhcpServerv6StatelessStore -ComputerName dhcpserver.contoso.com -Enabled True -PurgeInterval 1.00:00:00 -``` - -This example enables DHCPv6 stateless store at the server level and sets the purge interval for stateless client entries to 1 day. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies the enabled state for the stateless store. -The acceptable values for this parameter are: True or False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prefix -Specifies the IPv6 subnet prefix of the scope for which the stateless store properties are set. - -```yaml -Type: IPAddress -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PurgeInterval -Specifies the purge interval for the stateless store. -If the DHCP client does not send a DHCPv6 information request, or a request for options, in this interval, then the DHCP client is assumed to no longer exist on that subnet and the stateless store entry for the client is purged by the DHCP server service. - -This parameter value can be configured in the `dd.hh` format. -If minutes or seconds, using the `dd.hh:mm:ss` format, are specified, then the minutes and seconds will be ignored. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6StatelessStore -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6StatelessStore -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DhcpServerv6StatelessStore](./Get-DhcpServerv6StatelessStore.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/DirectAccessClientComponents.md b/docset/winserver2012-ps/directaccessclientcomponents/DirectAccessClientComponents.md deleted file mode 100644 index 9a9ab15f2e..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/DirectAccessClientComponents.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 244f8fc0-a410-4b87-8237-7496f557e6d4 -Module Name: DirectAccessClientComponents -ms.date: 12/20/2016 -title: DirectAccessClientComponents ---- - -# DirectAccessClientComponents Module - -## Description - -This reference provides cmdlet descriptions and syntax for all DirectAccess Client -Components-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the -beginning of the cmdlet. - -## DirectAccessClientComponents Cmdlets - -### [Disable-DAManualEntryPointSelection](./Disable-DAManualEntryPointSelection.md) -Disables a manually selected DirectAccess site, and reverts the selection to the default. - -### [Enable-DAManualEntryPointSelection](./Enable-DAManualEntryPointSelection.md) -Allows a user to manually choose which DirectAccess entry point to use for connectivity. - -### [Get-DAClientExperienceConfiguration](./Get-DAClientExperienceConfiguration.md) -Returns the configuration for the DirectAccess client user experience. - -### [Get-DAEntryPointTableItem](./Get-DAEntryPointTableItem.md) -Retrieves the list of entry points that have been configured for DirectAccess. - -### [New-DAEntryPointTableItem](./New-DAEntryPointTableItem.md) -Configures a new entry point for multisite DirectAccess. - -### [Remove-DAEntryPointTableItem](./Remove-DAEntryPointTableItem.md) -Removes a DirectAccess entry point from the specified configuration store. - -### [Rename-DAEntryPointTableItem](./Rename-DAEntryPointTableItem.md) -Renames a DirectAccess entry point. - -### [Reset-DAClientExperienceConfiguration](./Reset-DAClientExperienceConfiguration.md) -Restores the specified DirectAccess client configuration to the defaults. - -### [Reset-DAEntryPointTableItem](./Reset-DAEntryPointTableItem.md) -Resets the specified DirectAccess entry point configuration to the default configuration. - -### [Set-DAClientExperienceConfiguration](./Set-DAClientExperienceConfiguration.md) -Modifies the configuration of the specified DirectAccess client user experience. - -### [Set-DAEntryPointTableItem](./Set-DAEntryPointTableItem.md) -Modifies the configuration of a DirectAccess entry point stored in a Group Policy object. diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Disable-DAManualEntryPointSelection.md b/docset/winserver2012-ps/directaccessclientcomponents/Disable-DAManualEntryPointSelection.md deleted file mode 100644 index 31e3926d13..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Disable-DAManualEntryPointSelection.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/disable-damanualentrypointselection?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-DAManualEntryPointSelection - -## SYNOPSIS -Disables a manually selected DirectAccess site, and reverts the selection to the default. - -## SYNTAX - -``` -Disable-DAManualEntryPointSelection [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -**Disable-DAManualEntryPointSelection** disables a manually selected DirectAccess site and reverts the selection to the default. - -A client computer configured to use multiple DirectAccess sites automatically selects the best site. -A user can override the automatic selection behavior and select a specific DirectAccess site. -This cmdlet disables any manual site that was selected. - -You can prevent a user from overriding the automatic selection by using Group Policy. -For more information about using Group Policy to restrict automatic selection changes, see Get-DAClientExperienceConfiguration. - -## EXAMPLES - -### Example: Disable the manual DirectAccess site selection -``` -PS C:\> Disable-DAManualEntryPointSelection -``` - -This cmdlet disables any site that was manually selected, and reverts the DirectAccess entry point selection to automatic site selection. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet has no input objects. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry - -## NOTES - -## RELATED LINKS - -[Enable-DAManualEntryPointSelection](./Enable-DAManualEntryPointSelection.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Enable-DAManualEntryPointSelection.md b/docset/winserver2012-ps/directaccessclientcomponents/Enable-DAManualEntryPointSelection.md deleted file mode 100644 index f09c18f78b..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Enable-DAManualEntryPointSelection.md +++ /dev/null @@ -1,154 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/enable-damanualentrypointselection?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-DAManualEntryPointSelection - -## SYNOPSIS -Allows a user to manually choose which DirectAccess entry point to use for connectivity. - -## SYNTAX - -``` -Enable-DAManualEntryPointSelection -EntryPointName [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**Enable-DAManualEntryPointSelection** allows a user to manually choose which DirectAccess entry point to use for connectivity. -This cmdlet succeeds only when the client computer is outside of the corporate network perimeter, and DirectAccess is deployed. - -Computers configured for multisite DirectAccess automatically pick the best entry point to use for connectivity. -A user might want to override the entry point that is automatically selected; for example, to help troubleshoot network connectivity. -This cmdlet allows a user to manually choose a DirectAccess entry point. - -You can prevent a user from overriding the automatic selection by using Group Policy. -For more information about using Group Policy to restrict automatic selection changes, see Get-DAClientExperienceConfiguration. - -## EXAMPLES - -### Example: Enable manual DirectAccess site selection -``` -PS C:\> Enable-DAManualEntryPointSelection -EntryPointName "Redmond" -``` - -This cmdlet enables the entry point named **Redmond** - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the DirectAccess entry point to enable. -The specified entry point is used for DirectAccess connectivity until the computer joins a new network. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Disable-DAManualEntryPointSelection](./Disable-DAManualEntryPointSelection.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Get-DAClientExperienceConfiguration.md b/docset/winserver2012-ps/directaccessclientcomponents/Get-DAClientExperienceConfiguration.md deleted file mode 100644 index f86dd958eb..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Get-DAClientExperienceConfiguration.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: MSFT_DAClientExperienceConfiguration.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/get-daclientexperienceconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DAClientExperienceConfiguration - -## SYNOPSIS -Returns the configuration for the DirectAccess client user experience. - -## SYNTAX - -``` -Get-DAClientExperienceConfiguration [-PolicyStore ] [-GPOSession ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -**Get-DAClientExperienceConfiguration** returns the configuration for the DirectAccess client user experience. -The configuration returned controls the user interface behavior, as well as what configuration options are available to the user. - -All **DAClientExperienceConfiguration** cmdlets have an ADMX file that can also be used to configure the client experience settings. - -## EXAMPLES - -### Example: Retrieve the DirectAccess client experience configuration from the active store -``` -PS C:\> Get-DAClientExperienceConfiguration -PolicyStore ActiveStore -``` - -This cmdlet retrieves the DirectAccess client experience configuration from the active policy store. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session from which to read client experience configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store from which the cmdlet reads the client experience configuration information. - -To read the client experience configuration information from a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To read the client experience configuration information from a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -The default value for **PolicyStore** is ActiveStore. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DAClientExperienceConfiguration -This cmdlet returns a CIM object that contains the DA client experience configuration. - -## NOTES - -## RELATED LINKS - -[Reset-DAClientExperienceConfiguration](./Reset-DAClientExperienceConfiguration.md) - -[Set-DAClientExperienceConfiguration](./Set-DAClientExperienceConfiguration.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Get-DAEntryPointTableItem.md b/docset/winserver2012-ps/directaccessclientcomponents/Get-DAEntryPointTableItem.md deleted file mode 100644 index e5113a5a72..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Get-DAEntryPointTableItem.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/get-daentrypointtableitem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DAEntryPointTableItem - -## SYNOPSIS -Retrieves the list of entry points that have been configured for DirectAccess. - -## SYNTAX - -### ByPolicyStore (Default) -``` -Get-DAEntryPointTableItem [-EntryPointName ] [-State ] [-PolicyStore ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -### ByGpoSession -``` -Get-DAEntryPointTableItem [-EntryPointName ] [-State ] [-GPOSession ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -**Get-DAEntryPointTableItem** retrieves the list of entry points that have been configured for DirectAccess. -Entry points contain information about the IP addresses to use for connectivity, the IP-HTTPs profile, and other elements that enable connectivity for multisite DirectAccess. - -You can use **Get-DAEntryPointTableItem** to retrieve the list from Group Policy Objects or the local computer's active store. - -## EXAMPLES - -### Example: Retrieve a list of entry points that are not active -``` -PS C:\> Get-DAEntryPointTableItem -PolicyStore -ActiveStore -EntryPointName "Redmond" -State "NotSelected" -``` - -This cmdlet retrieves a list of entry points from the active store and filters the list to only display the entry points that are not active. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the entry point. -The entry point name is usually the friendly name of the location, such as "Redmond" or "Paris". - -Specify the name of the entry point by using double quotes ( " "). - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to send configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByGpoSession -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store into which the cmdlet adds the entry point. - -To add the entry point to a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To add the entry point information to a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -The default value for **PolicyStore** is ActiveStore. - -```yaml -Type: String -Parameter Sets: ByPolicyStore -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -State -This parameter is deprecated. - -```yaml -Type: State[] -Parameter Sets: (All) -Aliases: -Accepted values: NotSelected, AutomaticallySelected, ManuallySelected - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry -This cmdlet returns a CIM object that contains the DA entry point table item. - -## NOTES - -## RELATED LINKS - -[New-DAEntryPointTableItem](./New-DAEntryPointTableItem.md) - -[Set-DAEntryPointTableItem](./Set-DAEntryPointTableItem.md) - -[Reset-DAEntryPointTableItem](./Reset-DAEntryPointTableItem.md) - -[Rename-DAEntryPointTableItem](./Rename-DAEntryPointTableItem.md) - -[Remove-DAEntryPointTableItem](./Remove-DAEntryPointTableItem.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/New-DAEntryPointTableItem.md b/docset/winserver2012-ps/directaccessclientcomponents/New-DAEntryPointTableItem.md deleted file mode 100644 index 578b8ef225..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/New-DAEntryPointTableItem.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/new-daentrypointtableitem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DAEntryPointTableItem - -## SYNOPSIS -Configures a new entry point for multisite DirectAccess. - -## SYNTAX - -### ByPolicyStore (Default) -``` -New-DAEntryPointTableItem [-PolicyStore] -EntryPointName -ADSite - -EntryPointRange [-TeredoServerIP ] -EntryPointIPAddress [-GslbIP ] - [-IPHttpsProfile ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -### ByGpoSession -``` -New-DAEntryPointTableItem -EntryPointName -ADSite -EntryPointRange - [-TeredoServerIP ] -EntryPointIPAddress [-GslbIP ] [-IPHttpsProfile ] - [-GPOSession] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -**New-DAEntryPointTableItem** configures a new entry point for multisite DirectAccess. -The administrator distributes the new entry point to DirectAccess client computers by using Group Policy, and DirectAccess client computers use the new entry point when appropriate. - -## EXAMPLES - -### Example: Create a new entry point -``` -PS C:\> New-DAEntryPointTableItem -PolicyStore GPO:Localhost -ADSite "Paris" -EntryPointRange 2001::/16 -TeredoServerIP 131.107.1.1 -EntryPointIPAddress 200::1 -GslbIP 131.107.0.1 -EntryPointName "Paris" -``` - -This cmdlet creates a simple entry point named **Paris**. - -## PARAMETERS - -### -ADSite -Specifies the Active Directory Domain Services (AD DS) site name associated with the entry point. -When a client computer connects to an entry point, the computer becomes associated with the AD DS site specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointIPAddress -Specifies the IPv6 address of the entry point to use for connectivity. -The cmdlet fails if the IP address specified is not within the IP address range specified by **EntryPointRange**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the entry point. -The entry point name is usually the friendly name of the location, such as "Redmond" or "Paris". - -Specify the name of the entry point by using double quotes ( " "). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointRange -Specifies the IPv6 address range associated with computers connecting through this entry point. -Specify the IPv6 range in classless inter-domain routing (CIDR) notation. - -The following is an example of an **EntryPointRange** entry: -{2001:4898:e0:305d::100:1/128, 2001:4898:e0:305d::100:2/128, 2001:4898:e0:3084::/64} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to send configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByGpoSession -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GslbIP -Specifies the IP address associated with the new entry point, if using DirectAccess in conjunction with global server load balancing (GSLB) site balancing. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPHttpsProfile -Specifies the IPHTTPs profile name to be used for connectivity. -You specify the name of the profile in double quotes (" "). -**New-DAEntryPointTableItem** fails if the profile does not already exist in the GPO that contains the configuration. -For more information about IPHTTPs profiles, see the **NetIPHTTPsConfiguration** cmdlets in the **NetworkTransition** module. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store into which the cmdlet adds the entry point. - -To add the entry point to a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To add the entry point information to a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -```yaml -Type: String -Parameter Sets: ByPolicyStore -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeredoServerIP -Specifies the IP address of the Teredo server for the new entry point. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry -This cmdlet returns a CIM object which contains the new DA entry point table item. - -## NOTES - -## RELATED LINKS - -[Get-DAEntryPointTableItem](./Get-DAEntryPointTableItem.md) - -[Set-DAEntryPointTableItem](./Set-DAEntryPointTableItem.md) - -[Reset-DAEntryPointTableItem](./Reset-DAEntryPointTableItem.md) - -[Rename-DAEntryPointTableItem](./Rename-DAEntryPointTableItem.md) - -[Remove-DAEntryPointTableItem](./Remove-DAEntryPointTableItem.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Remove-DAEntryPointTableItem.md b/docset/winserver2012-ps/directaccessclientcomponents/Remove-DAEntryPointTableItem.md deleted file mode 100644 index 8ad7ac3ccb..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Remove-DAEntryPointTableItem.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/remove-daentrypointtableitem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DAEntryPointTableItem - -## SYNOPSIS -Removes a DirectAccess entry point from the specified configuration store. - -## SYNTAX - -### ByPolicyStore (Default) -``` -Remove-DAEntryPointTableItem [-EntryPointName ] -PolicyStore [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### ByGpoSession -``` -Remove-DAEntryPointTableItem [-EntryPointName ] -GPOSession [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Remove-DAEntryPointTableItem -InputObject [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**Remove-DAEntryPointTableItem** removes a DirectAccess entry point from the specified configuration store. -You must specify both the configuration store, by using either **GPOSession** or **PolicyStore**, and name of the entry point to remove. - -## EXAMPLES - -### Example 1: Remove an entry point by using the pipeline -``` -PS C:\> Get-DAEntryPointTableItem -EntryPointName "Redmond" -PolicyStore "Contoso\GPO1" | Remove-DAEntryPointTableItem -``` - -This cmdlet removes the entry point named **Redmond** by first getting the entry point information using **Get-DAEntryPointTableItem** and then passing the information to **Remove-DAEntryPointTableItem**. - -### Example 2: Remove an entry point directly -``` -PS C:\>Remove-DAEntryPointTableItem -EntryPointName "Redmond" -PolicyStore "Contoso\GPO1" -``` - -This cmdlet removes an entry point named **Redmond** by using specifying the **EntryPointName** and **PolicyStore**. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the entry point to remove. -This parameter supports wildcards. - -```yaml -Type: String[] -Parameter Sets: ByPolicyStore, ByGpoSession -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session from which to read configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByGpoSession -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Passes the object that contains the entry point to be deleted. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from an interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -However, to send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store from which the cmdlet retrieves the entry point information. - -To retrieve the entry point information from a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To retrieve the entry point information from a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -The default value for **PolicyStore** is ActiveStore. - -```yaml -Type: String -Parameter Sets: ByPolicyStore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry -This cmdlet accepts as input a CIM object which contains a DA site table entry. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[New-DAEntryPointTableItem](./New-DAEntryPointTableItem.md) - -[Get-DAEntryPointTableItem](./Get-DAEntryPointTableItem.md) - -[Set-DAEntryPointTableItem](./Set-DAEntryPointTableItem.md) - -[Reset-DAEntryPointTableItem](./Reset-DAEntryPointTableItem.md) - -[Rename-DAEntryPointTableItem](./Rename-DAEntryPointTableItem.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Rename-DAEntryPointTableItem.md b/docset/winserver2012-ps/directaccessclientcomponents/Rename-DAEntryPointTableItem.md deleted file mode 100644 index 9fce25841e..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Rename-DAEntryPointTableItem.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/rename-daentrypointtableitem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-DAEntryPointTableItem - -## SYNOPSIS -Renames a DirectAccess entry point. - -## SYNTAX - -### ByPolicyStore (Default) -``` -Rename-DAEntryPointTableItem [-EntryPointName ] -PolicyStore -NewName [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### ByGpoSession -``` -Rename-DAEntryPointTableItem [-EntryPointName ] -GPOSession -NewName [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Rename-DAEntryPointTableItem -InputObject -NewName [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**Rename-DAEntryPointTableItem** renames a DirectAccess entry point. - -## EXAMPLES - -### Example: Rename an entry point -``` -PS C:\> Rename-DAEntryPointTableItem -EntryPointName "Redmond" -NewName "Bellevue" -PolicyStore Contoso\GPO1 -``` - -This cmdlet renames a DirectAccess entry point from **Redmond** to **Bellevue**. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the entry point to rename. -The entry point name is usually the friendly name of the location, such as "Redmond" or "Paris". - -Specify the name of the entry point by using double quotes ( " "). - -```yaml -Type: String[] -Parameter Sets: ByPolicyStore, ByGpoSession -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to retrieve configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByGpoSession -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Specifies the object to rename. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name for the entry point. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Sends items from an interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -However, to send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store from which the cmdlet reads the entry point information. - -To retrieve the entry point from a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To retrieve the entry point information from a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -```yaml -Type: String -Parameter Sets: ByPolicyStore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry -This cmdlet accepts as input a CIM object that contains a DA site table entry. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[New-DAEntryPointTableItem](./New-DAEntryPointTableItem.md) - -[Get-DAEntryPointTableItem](./Get-DAEntryPointTableItem.md) - -[Set-DAEntryPointTableItem](./Set-DAEntryPointTableItem.md) - -[Reset-DAEntryPointTableItem](./Reset-DAEntryPointTableItem.md) - -[Remove-DAEntryPointTableItem](./Remove-DAEntryPointTableItem.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Reset-DAClientExperienceConfiguration.md b/docset/winserver2012-ps/directaccessclientcomponents/Reset-DAClientExperienceConfiguration.md deleted file mode 100644 index e6a87a4d91..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Reset-DAClientExperienceConfiguration.md +++ /dev/null @@ -1,383 +0,0 @@ ---- -external help file: MSFT_DAClientExperienceConfiguration.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/reset-daclientexperienceconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-DAClientExperienceConfiguration - -## SYNOPSIS -Restores the specified DirectAccess client configuration to the defaults. - -## SYNTAX - -### ByName (Default) -``` -Reset-DAClientExperienceConfiguration [-PolicyStore ] [-GPOSession ] [-CorporateResources] - [-IPsecTunnelEndpoints] [-PreferLocalNamesAllowed] [-UserInterface] [-SupportEmail] [-FriendlyName] - [-ManualEntryPointSelectionAllowed] [-GslbFqdn] [-ForceTunneling] [-CustomCommands] [-PassiveMode] [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Reset-DAClientExperienceConfiguration -InputObject [-CorporateResources] - [-IPsecTunnelEndpoints] [-PreferLocalNamesAllowed] [-UserInterface] [-SupportEmail] [-FriendlyName] - [-ManualEntryPointSelectionAllowed] [-GslbFqdn] [-ForceTunneling] [-CustomCommands] [-PassiveMode] [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**Reset-DAClientExperienceConfiguration** restores the specified DirectAccess client configuration to the defaults. - -All **DAClientExperienceConfiguration** cmdlets have an ADMX file which can also configure these settings. - -## EXAMPLES - -### Example: Reset the friendly name of a client experience configuration -``` -PS C:\>Reset-DAClientExperienceConfiguration -PolicyStore "Contoso\GPO1" -FriendlyName "Traveling Policy" -``` - -This cmdlet resets the friendly name of a client experience configuration. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CorporateResources -Resets the CorporateResources property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomCommands -Resets the CustomCommands property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceTunneling -Resets the ForceTunneling property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Resets the FriendlyName property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to send configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GslbFqdn -Resets the GslbFqdn property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPsecTunnelEndpoints -Resets the IPsecTunnelEndpoints property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the name of the object which contains the configuration to modify. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ManualEntryPointSelectionAllowed -Resets the ManualEntryPointSelectionAllowed property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Sends items from an interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -However, to send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassiveMode -Resets the PassiveMode property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store into which the cmdlet adds the reset configuration properties. - -To add the reset configuration properties to a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To add the reset configuration properties to a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferLocalNamesAllowed -Resets the PreferLocalNamesAllowed property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SupportEmail -Resets the SupportEmail property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserInterface -Resets the UserInterface property of the specified configuration to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DAClientExperienceConfiguration -This cmdlet accepts as input a CIM object that contains a DA client experience configuration. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-DAClientExperienceConfiguration](./Get-DAClientExperienceConfiguration.md) - -[Set-DAClientExperienceConfiguration](./Set-DAClientExperienceConfiguration.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Reset-DAEntryPointTableItem.md b/docset/winserver2012-ps/directaccessclientcomponents/Reset-DAEntryPointTableItem.md deleted file mode 100644 index e870ac2629..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Reset-DAEntryPointTableItem.md +++ /dev/null @@ -1,292 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/reset-daentrypointtableitem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-DAEntryPointTableItem - -## SYNOPSIS -Resets the specified DirectAccess entry point configuration to the default configuration. - -## SYNTAX - -### ByPolicyStore (Default) -``` -Reset-DAEntryPointTableItem [-EntryPointName ] -PolicyStore [-TeredoServerIP] - [-IPHttpsProfile] [-GslbIP] [-PassThru] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -### ByGpoSession -``` -Reset-DAEntryPointTableItem [-EntryPointName ] -GPOSession [-TeredoServerIP] - [-IPHttpsProfile] [-GslbIP] [-PassThru] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Reset-DAEntryPointTableItem -InputObject [-TeredoServerIP] [-IPHttpsProfile] [-GslbIP] - [-PassThru] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -**Reset-DAEntryPointTableItem** resets the configuration of the entry point specified by **EntryPointName** to the default configuration. -You can use the optional parameters to reset specific configuration settings to the default configuration. - -## EXAMPLES - -### Example: Reset an entry point property -``` -PS C:\> Reset-DAEntryPointTableItem -GslbIP -EntryPointName "Paris" -PolicyStore "Contoso\GPO1" -``` - -This cmdlet resets the **GslbIP** property to not-configured for the **Paris** entry point. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the entry point to modify. -The entry point name is usually the friendly name of the location, such as "Redmond" or "Paris". - -Specify the name of the entry point by using double quotes ( " "). - -```yaml -Type: String[] -Parameter Sets: ByPolicyStore, ByGpoSession -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to send configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByGpoSession -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GslbIP -Resets the global server load balancing (GSLB) IP of the specified sites to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPHttpsProfile -Resets the IpHTTPsProfile property of the specified sites to a non-configured state. -For more information about IPHTTPs profiles, see the **NetIPHTTPsConfiguration** cmdlets in the **NetworkTransition** module. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the name of the object to modify. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from an interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -However, to send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store into which the cmdlet adds the entry point. - -To add the entry point to a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To add the entry point information to a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -```yaml -Type: String -Parameter Sets: ByPolicyStore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeredoServerIP -Resets the TeredoServerIP property of the specified sites to a non-configured state. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry -This cmdlet accepts as input a CIM object which contains a DA site table entry. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[New-DAEntryPointTableItem](./New-DAEntryPointTableItem.md) - -[Get-DAEntryPointTableItem](./Get-DAEntryPointTableItem.md) - -[Set-DAEntryPointTableItem](./Set-DAEntryPointTableItem.md) - -[Rename-DAEntryPointTableItem](./Rename-DAEntryPointTableItem.md) - -[Remove-DAEntryPointTableItem](./Remove-DAEntryPointTableItem.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Set-DAClientExperienceConfiguration.md b/docset/winserver2012-ps/directaccessclientcomponents/Set-DAClientExperienceConfiguration.md deleted file mode 100644 index 664c2796a5..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Set-DAClientExperienceConfiguration.md +++ /dev/null @@ -1,434 +0,0 @@ ---- -external help file: MSFT_DAClientExperienceConfiguration.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/set-daclientexperienceconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DAClientExperienceConfiguration - -## SYNOPSIS -Modifies the configuration of the specified DirectAccess client user experience. - -## SYNTAX - -### ByName (Default) -``` -Set-DAClientExperienceConfiguration [-PolicyStore ] [-GPOSession ] - [[-CorporateResources] ] [[-IPsecTunnelEndpoints] ] [[-PreferLocalNamesAllowed] ] - [[-UserInterface] ] [[-SupportEmail] ] [[-FriendlyName] ] - [[-ManualEntryPointSelectionAllowed] ] [[-GslbFqdn] ] [[-ForceTunneling] ] - [[-CustomCommands] ] [[-PassiveMode] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Set-DAClientExperienceConfiguration -InputObject [[-CorporateResources] ] - [[-IPsecTunnelEndpoints] ] [[-PreferLocalNamesAllowed] ] [[-UserInterface] ] - [[-SupportEmail] ] [[-FriendlyName] ] [[-ManualEntryPointSelectionAllowed] ] - [[-GslbFqdn] ] [[-ForceTunneling] ] [[-CustomCommands] ] - [[-PassiveMode] ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -**Set-DAClientExperienceConfiguration** modifies the specified configuration properties of the DirectAccess client user experience. -The DirectAccess client configuration controls the user interface behavior, as well as what configuration options are available to the user. - -This cmdlet can be used to change configuration properties stored in Group Policy Objects. - -## EXAMPLES - -### Example: Disable the DirectAccess user interface -``` -PS C:\>Set-DAClientExperienceConfiguration -PolicyStore "Contoso\GPO1" -UserInterface "False" -``` - -This cmdlet disables the DirectAccess user interface. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CorporateResources -Configures the connectivity tests that DirectAccess client computers use to determine connectivity. -Enter the values for this parameter in the form of a string array, with each entry surrounded by double quotes (" ") and separated by commas. -Use the following formats for each test type: - -**HTTP test**: "HTTP:http://computername" - -**File test**: "FILE:\\\\fileserver\" - -**Ping test**: "PING:testURL" - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CustomCommands -Configures any custom commands required by the administrator. -The custom commands are incorporated into the logs that are generated when there are problems. -Commands run in an elevated Windows PowerShell console sequentially. - -Each item in the string array must be an individual command. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 10 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceTunneling -Configures the force tunneling setting on a DirectAccess client computer. -Valid values for **ForceTunneling** are "Enabled" or "Disabled". -By default, force tunneling is disabled. - -```yaml -Type: ForceTunneling -Parameter Sets: (All) -Aliases: -Accepted values: Default, Enabled, Disabled - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FriendlyName -Specifies the name of the DirectAccess deployment to be shown in the client computer user interface. -It is recommended that the name be 15 characters or less. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to send configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GslbFqdn -Specifies the fully-qualified domain name (FQDN) used for DirectAccess multisite client computers. -The client computer resolves the FQDN to an IP address, and compares the IP address to the list of entry points. -Client computers use the matching entry point for connectivity. - -Specify the value for **GslbFqdn** in double quotes (" "). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPsecTunnelEndpoints -Configures the IPsec tunnel endpoints to use for DirectAccess. -Client computers use this information to verify the availability of the DirectAccess servers and present that information to the user. - -Specify the values for **IPsecTunnelEndpoints** in double quotes (" "), separated by commas, in the following format: - -"Ping: ipaddress" - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the name of the object which contains the client experience configuration information to modify. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ManualEntryPointSelectionAllowed -Specifies if the user of a client computer can change the site used for DirectAccess connectivity. -If **ManualEntryPointSelectionAllowed** is set to **True**, then users can change the entry point configuration in the user interface. -If **ManualEntryPointSelectionAllowed** is set to **False**, then users cannot change the entry point configuration in the user interface. -By default, **ManualEntryPointSelectionAllowed** is set to **True**. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Sends items from an interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -However, to send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassiveMode -Controls the passive mode setting on DirectAccess client computers. -In order to report DirectAccess status to the user, DirectAccess performs a set of tests frequently. -When **PassiveMode** is set to **True**, those tests happen much less frequently. -However, enabling passive mode makes the client experience less responsive. - -Valid values for **PassiveMode** are "True" or "False". -By default, **PassiveMode** is set to **False**, which is the recommended setting. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 11 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store into which the cmdlet stores the configuration information. - -To store the configuration information in a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To store the configuration information in a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -```yaml -Type: String -Parameter Sets: ByName -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferLocalNamesAllowed -Controls if users can disconnect DirectAccess. -Disconnecting DirectAccess temporarily deactivates the name resolution policy table. - -Valid values for **PreferLocalNamesAllowed** are "True" or "False". -If set to **True**, users can disconnect DirectAccess. -The default value is **False**. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SupportEmail -Configures the email address displayed in the user interface for users to send logs and requests for assistance. -**SupportEmail** must be configured for logging to work. - -Specify **SupportEmail** in the format of a valid email address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserInterface -Enables or disables the user interface for DirectAccess on the client computers that receive the policy. - -Valid values for **UserInterface** are "True" or "False". -Setting **UserInterface** to **False**, removes the user interface. -By default, **UserInterface** is set to **True**. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DAClientExperienceConfiguration -This cmdlet accepts as input a CIM object that contains a DA client experience configuration. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-DAClientExperienceConfiguration](./Get-DAClientExperienceConfiguration.md) - -[Reset-DAClientExperienceConfiguration](./Reset-DAClientExperienceConfiguration.md) - diff --git a/docset/winserver2012-ps/directaccessclientcomponents/Set-DAEntryPointTableItem.md b/docset/winserver2012-ps/directaccessclientcomponents/Set-DAEntryPointTableItem.md deleted file mode 100644 index 119c5f0f24..0000000000 --- a/docset/winserver2012-ps/directaccessclientcomponents/Set-DAEntryPointTableItem.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: MSFT_DASiteTableEntry.cdxml-help.xml -Module Name: DirectAccessClientComponents -online version: https://learn.microsoft.com/powershell/module/directaccessclientcomponents/set-daentrypointtableitem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DAEntryPointTableItem - -## SYNOPSIS -Modifies the configuration of a DirectAccess entry point stored in a Group Policy object. - -## SYNTAX - -### ByPolicyStore (Default) -``` -Set-DAEntryPointTableItem [-EntryPointName ] -PolicyStore [-ADSite ] - [-EntryPointRange ] [-TeredoServerIP ] [-EntryPointIPAddress ] [-GslbIP ] - [-IPHttpsProfile ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### ByGpoSession -``` -Set-DAEntryPointTableItem [-EntryPointName ] -GPOSession [-ADSite ] - [-EntryPointRange ] [-TeredoServerIP ] [-EntryPointIPAddress ] [-GslbIP ] - [-IPHttpsProfile ] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Set-DAEntryPointTableItem -InputObject [-ADSite ] [-EntryPointRange ] - [-TeredoServerIP ] [-EntryPointIPAddress ] [-GslbIP ] [-IPHttpsProfile ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -**Set-DAEntryPointTableItem** modifies an entry point configuration that is stored in a Group Policy object (GPO). -You must specify the name of the GPO in which the DirectAccess entry point configuration is stored. - -## EXAMPLES - -### Example 1: Modify an entry point -``` -PS C:\> Set-DAEntryTableItem -EntryPointName "Paris" -GslbIP 131.107.0.1 -PolicyStore "Contoso\GPO1" -``` - -This cmdlet modifies the GSLB of the entry point named **Paris**. - -### Example 2: Modify an entry point using an input object -``` -PS C:\>$x = Set-DAEntryTableItem -EntryPointName "Paris" -PolicyStore "Contoso\GPO1" PS C:\>$x.GslbIP = 131.107.0.1 PS C:\>$x | Set-DAEntryTableItem -``` - -This cmdlet modifies an entry point named Paris by passing an input object on the pipeline. - -## PARAMETERS - -### -ADSite -Specifies the Active Directory Domain Services (AD DS) site name associated with the entry point. -When a client computer connects to an entry point, the computer becomes associated with the AD DS site specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointIPAddress -Specifies the IPv6 address of the entry point to use for connectivity. -The cmdlet fails if the IP address specified is not within the IP address range specified by **EntryPointRange**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EntryPointName -Specifies the name of the entry point to modify. -The entry point name is usually the friendly name of the location, such as "Redmond" or "Paris". - -Specify the name of the entry point by using double quotes ( " "). - -```yaml -Type: String[] -Parameter Sets: ByPolicyStore, ByGpoSession -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EntryPointRange -Specifies the IPv6 address range associated with computers connecting through this entry point. -Specify the IPv6 range in classless inter-domain routing (CIDR) notation. - -The following is an example of an **EntryPointRange** entry: -{2001:4898:e0:305d::100:1/128, 2001:4898:e0:305d::100:2/128, 2001:4898:e0:3084::/64} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOSession -Specifies the Group Policy session to send configuration information. -You can use **GPOSession** with the **NetGPO** cmdlets to aggregate multiple operations performed on a Group Policy Object. - -**GPOSession** cannot be used in conjunction with **PolicyStore**. - -```yaml -Type: String -Parameter Sets: ByGpoSession -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GslbIP -Specifies the IP address associated with the new entry point, if using DirectAccess in conjunction with global server load balancing (GSLB) site balancing. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPHttpsProfile -Specifies the IPHTTPs profile name to be used for connectivity. -You specify the name of the profile in double quotes (" "). -**New-DAEntryPointTableItem** fails if the profile does not already exist in the GPO that contains the configuration. -For more information about IPHTTPs profiles, see the **NetIPHTTPsConfiguration** cmdlets in the **NetworkTransition** module. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the name of the object which contains the entry point to modify. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from an interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. -However, to send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the policy store into which the cmdlet adds the entry point. - -To add the entry point to a Group Policy Object, specify the GPO name using the following format: "Domain\GPOName" - -To add the entry point information to a computer's local GPO, specify the computer's local GPO name in the following format: "GPO:\" - -**PolicyStore** cannot be used in conjunction with **GPOSession**. - -```yaml -Type: String -Parameter Sets: ByPolicyStore -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TeredoServerIP -Specifies the IP address of the Teredo server for the new entry point. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_DASiteTableEntry -This cmdlet returns a CIM object which contains the DA entry point table item. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[New-DAEntryPointTableItem](./New-DAEntryPointTableItem.md) - -[Get-DAEntryPointTableItem](./Get-DAEntryPointTableItem.md) - -[Reset-DAEntryPointTableItem](./Reset-DAEntryPointTableItem.md) - -[Rename-DAEntryPointTableItem](./Rename-DAEntryPointTableItem.md) - -[Remove-DAEntryPointTableItem](./Remove-DAEntryPointTableItem.md) - diff --git a/docset/winserver2012-ps/dism/Add-AppxProvisionedPackage.md b/docset/winserver2012-ps/dism/Add-AppxProvisionedPackage.md deleted file mode 100644 index 5a139aa888..0000000000 --- a/docset/winserver2012-ps/dism/Add-AppxProvisionedPackage.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/add-appxprovisionedpackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-AppxProvisionedPackage - -## SYNOPSIS -Adds an app package (.appx) that will install for each new user to a Windows image. - -## SYNTAX - -### Offline -``` -Add-AppxProvisionedPackage [-FolderPath ] [-PackagePath ] [-DependencyPackagePath ] - [-LicensePath ] [-SkipLicense] [-CustomDataPath ] -Path [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -### Online -``` -Add-AppxProvisionedPackage [-FolderPath ] [-PackagePath ] [-DependencyPackagePath ] - [-LicensePath ] [-SkipLicense] [-CustomDataPath ] [-Online] [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Add-AppxProvisionedPackage** cmdlet adds an app package (.appx) that will install for each new user to a Windows image. -If the package has dependencies that are architecture-specific, you must install the applicable architectures for the dependency on the target image. -For example, you must install the x86 dependency on the x86 image. - -You cannot install an app package (.appx) on an operating system that does not support Windows 8 apps. -Apps are not supported on Server Core installations of Windows Server 2012, Windows Preinstallation Environment (Windows PE) 4.0, or on any versions of Windows older than Windows 8 and Windows Server 2012. - -To install and run apps on Windows Server 2012, you must install the [Desktop Experience Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/dn609826(v=ws.11)). - -Use the *Online* parameter to specify the running operating system on your local computer, or use the *Path* parameter to specify the location of a mounted Windows image. - -Use the *PackagePath*, *DependencyPackagePath*, and *LicensePath* parameters to specify the location of all the files that are needed to add the provisioned app package (.appx). -Use these parameters to provision line-of-business apps. - -Use the *FolderPath* parameter to specify the location of a folder of unpacked app package (.appx) files that includes any dependency packages and a license file. - -To add an app package (.appx) for a particular user, or to test a package while developing your app, use the **Add-AppxPackage** cmdlet instead. - -For more information, including requirements for app package provisioning, see [Sideload Apps with DISM](/windows-hardware/manufacture/desktop/sideload-apps-with-dism-s14) and [How to develop an OEM app that uses a custom file](/windows/win32/appxpkg/how-to-develop-oem-app-with-custom-file) in MicrosoftDocs. - -## EXAMPLES - -### Example 1: Add an app package to the running operating system -```powershell -PS C:\> Add-AppxProvisionedPackage -Online -FolderPath "c:\Appx" -``` - -This command adds the app package, dependency packages, and license file from the c:\Appx folder to the running Windows operating system. -The package will be installed for the current user and any new user account created on the computer. - -### Example 2: Add an app package an operating system image -```powershell -PS C:\> Add-AppxProvisionedPackage -Path c:\offline -PackagePath c:\Appx\myPackage.appx -DependencyPackagePath c:\Appx\dependency1\dependencyPackage.appx -LicensePath c:\Appx\myLicense.xml -``` - -This command adds the app package, myPackage.appx, to the Windows image mounted to c:\offline. - -## PARAMETERS - -### -CustomDataPath -Specifies the location of a custom data file. -The custom data file will be renamed custom.data and saved in the app data store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DependencyPackagePath -Specifies the location of a dependency package. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FolderPath -Specifies a folder of unpacked app package files containing a main package and any dependency packages. -This folder must also contain your application license. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LicensePath -Specifies the location of the .xml file containing your application license. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: LL -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: WarningsInfo -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackagePath -Specifies the location of the app package (.appx) to add to the Windows image. -This package will be added for every new user account. -To add an app package (.appx) for a particular user or to test a package while developing your app, use the **Add-AppxPackage** cmdlet instead. - -The *PackagePath* parameter is only supported for offline servicing when the technician computer is running a version of Windows that supports Windows 8 apps. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, *WindowsDirectory* must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SkipLicense -Adds an app package without a license file. - -Only use *SkipLicense* with apps that do not require a license on Enterprise or Server versions of the operating system. -Using *SkipLicense* in other scenarios can compromise an image. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.AppxPackageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/dism/Add-WindowsDriver.md b/docset/winserver2012-ps/dism/Add-WindowsDriver.md deleted file mode 100644 index fbadbfb5a2..0000000000 --- a/docset/winserver2012-ps/dism/Add-WindowsDriver.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/add-windowsdriver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-WindowsDriver - -## SYNOPSIS -Adds a driver to an offline Windows image. - -## SYNTAX - -``` -Add-WindowsDriver [-Recurse] [-ForceUnsigned] -Driver -Path [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Add-WindowsDriver** cmdlet adds third-party driver packages to an offline Windows image. - -Use the *Path* parameter to specify the location of a mounted Windows image. - -Use the *Driver* parameter to specify the location of an .inf driver file or a folder containing one or more .inf driver files. - -Use the *ForceUnsigned* parameter to add unsigned .inf files to an x64-based image. - -## EXAMPLES - -### Example 1: Add drivers to an image -``` -PS C:\>Add-WindowsDriver -Path "c:\offline" -Driver "c:\test\drivers" -Recurse -``` - -This command adds any drivers in the c:\test\drivers folder or any of its subdirectories to the Windows operating system image that is mounted to c:\offline. - -### Example 2: Add an unsigned driver package -``` -PS C:\>Add-WindowsDriver -Path "c:\offline" -Driver "c:\test\drivers\Usb\Usb.inf" -ForceUnsigned -``` - -This command adds the unsigned driver package, Usb.inf, to the Windows image that is mounted to c:\offline. - -## PARAMETERS - -### -Driver -Specifies the .inf file or folder containing the .inf files of the drivers you want to add. -When you specify a folder, .inf files that are not valid driver packages are ignored. -These files are reported on the console when the command runs, and a warning is included in the log file. -You will not receive an error message. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForceUnsigned -Adds unsigned drivers to an x64 image. -The *ForceUnsigned* parameter overrides the requirement that drivers that are installed on X64-based computers must have a digital signature. -For more information about driver signing requirements, see Windows Deployment Optionshttp://go.microsoft.com/fwlink/?LinkId=214574 (http://go.microsoft.com/fwlink/?LinkId=214574) in the TechNet Library. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Includes all subfolders when searching for drivers to add. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.BasicDriverObject - -### Microsoft.Dism.Commands.AdvancedDriverObject - -## OUTPUTS - -### Microsoft.Dism.Commands.BasicDriverObject - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Add-WindowsPackage.md b/docset/winserver2012-ps/dism/Add-WindowsPackage.md deleted file mode 100644 index 3c6aded92b..0000000000 --- a/docset/winserver2012-ps/dism/Add-WindowsPackage.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/add-windowspackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-WindowsPackage - -## SYNOPSIS -Adds a single .cab or .msu file to a Windows image. - -## SYNTAX - -### Online -``` -Add-WindowsPackage -PackagePath [-IgnoreCheck] [-PreventPending] [-NoRestart] [-Online] - [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -### Offline -``` -Add-WindowsPackage -PackagePath [-IgnoreCheck] [-PreventPending] [-NoRestart] -Path - [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -## DESCRIPTION -The **Add-WindowsPackage** cmdlet installs a specified .cab or .msu package in the image. - -## EXAMPLES - -### Example 1: Add a package to an online image -``` -PS C:\>Add-WindowsPackage -Online -PackagePath "c:\packages\package.cab" -``` - -This command adds a .cab package to an online image. - -### Example 2: Add a file to a mounted image -``` -PS C:\>Add-WindowsPackage -Path "c:\offline" -PackagePath "c:\packages\demo_package.msu" -PreventPending -``` - -This command adds an .msu file to a mounted Windows image unless there are pending actions on the package or the image. - -### Example 3: Add several packages to a mounted image -``` -PS C:\>Add-WindowsPackage -Path "c:\offline" -PackagePath "c:\packages" -IgnoreCheck -``` - -This command adds all of the packages in a folder to a mounted Windows image without checking if they are applicable to the image. - -## PARAMETERS - -### -IgnoreCheck -Skips the applicability check for each package. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRestart -Suppresses reboot. -If a reboot is not required, this command does nothing. -This option will keep the application from prompting for a restart or keep it from restarting automatically. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackagePath -Specifies the location of the package to add to the image. - -Valid values are: - -- A single .cab or .msu file. -- A folder that contains a single expanded .cab file. -- A folder that contains a single .msu file. -- A folder that contains multiple .cab or .msu files. - -If *PackagePath* is a folder that contains a .cab or .msu files at its root, any subfolders are also recursively checked for .cab and .msu files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PreventPending -Skips the installation of the package if the package or Windows image has pending online actions. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.BasicPackageObject - -### Microsoft.Dism.Commands.AdvancedPackageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Clear-WindowsCorruptMountPoint.md b/docset/winserver2012-ps/dism/Clear-WindowsCorruptMountPoint.md deleted file mode 100644 index 017d30f468..0000000000 --- a/docset/winserver2012-ps/dism/Clear-WindowsCorruptMountPoint.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/clear-windowscorruptmountpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-WindowsCorruptMountPoint - -## SYNOPSIS -Deletes all of the resources associated with a mounted image that has been corrupted. - -## SYNTAX - -``` -Clear-WindowsCorruptMountPoint [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Clear-WindowsCorruptMountPoint** cmdlet deletes all of the resources associated with a mounted image that has been corrupted. - -## EXAMPLES - -### Example 1: Delete all resources associated with a mounted image -``` -PS C:\>Clear-WindowsCorruptMountPoint -``` - -This command deletes all of the resources on the computer that are associated with a mounted image that has been corrupted. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Dism.Commands.BasicDismObject - -## OUTPUTS - -### Microsoft.Dism.Commands.BaseDismObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Disable-WindowsOptionalFeature.md b/docset/winserver2012-ps/dism/Disable-WindowsOptionalFeature.md deleted file mode 100644 index f729fe2fea..0000000000 --- a/docset/winserver2012-ps/dism/Disable-WindowsOptionalFeature.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/disable-windowsoptionalfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-WindowsOptionalFeature - -## SYNOPSIS -Disables a feature in a Windows image. - -## SYNTAX - -### Online -``` -Disable-WindowsOptionalFeature -FeatureName [-PackageName ] [-Remove] [-NoRestart] [-Online] - [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -### Offline -``` -Disable-WindowsOptionalFeature -FeatureName [-PackageName ] [-Remove] [-NoRestart] - -Path [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Disable-WindowsOptionalFeature** cmdlet disables or removes an optional feature in a Windows image. - -Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image. - -The *PackageName* parameter specifies the package that the feature is a component of. -This parameter is optional when the package is the Windows Foundation package. - -The *FeatureName* parameter specifies the feature to remove. -You can specify more than one feature in the same package. -Separate feature names with a comma. - -The *Remove* parameter removes the files for an optional feature without removing the feature's manifest from the image. -You can use *Remove* to reduce the disk space that is used by a Windows image. -After the image has been installed, you can restore the feature at any time from a remote source such as Windows Update or a network share. -For more information about Features on Demand, see Configure a Windows Repair Sourcehttp://go.microsoft.com/fwlink/?LinkId=243077 (http://go.microsoft.com/fwlink/?LinkId=243077) in the TechNet Library. - -## EXAMPLES - -### Example 1: Disable an optional feature -``` -PS C:\>Disable-WindowsOptionalFeature -Online -FeatureName "Hearts" -``` - -This command disables an optional feature, Hearts, from the running Windows operating system. - -### Example 2: Disable a feature in an image -``` -PS C:\>Disable-WindowsOptionalFeature -Path "c:\offline" -FeatureName "Calc" -PackageName "Microsoft.Windows.Calc.Demo~6595b6144ccf1df~x86~en~1.0.0.0" -Remove -``` - -This command disables the optional feature, Calc, in the specified package in the Windows image that is mounted to c:\offline. -It also removes all of the files except the manifest file, which reduces the size of the Windows image. -The feature can be restored with the Enable-WindowsOptionalFeature cmdlet or by using Features on Demand at any time after the image is deployed. - -## PARAMETERS - -### -FeatureName -Specifies the name of the feature to be disabled. -Feature names are case sensitive if you are servicing a Windows image other than Windows® 8 or a later version. -You can use Get-WindowsOptionalFeature to find the name of the feature in the image. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRestart -Suppresses reboot. -If a reboot is not required, this command does nothing. -This option will keep the application from prompting for a restart or keep it from restarting automatically. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of a package in the Windows image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Remove -Removes the files for an optional feature without removing the feature's manifest from the image. -You can use *Remove* to reduce the disk space that is used by a Windows image. -After the image has been installed, you can restore the feature at any time from a remote source such as Windows Update or a network share. - -*Remove* can only be used when servicing an image contain Windows 8 or Windows Server 2012 or a later version. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.BasicFeatureObject - -### Microsoft.Dism.Commands.AdvancedFeatureObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Dism.md b/docset/winserver2012-ps/dism/Dism.md deleted file mode 100644 index 85cb92a24e..0000000000 --- a/docset/winserver2012-ps/dism/Dism.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.2.0 -Locale: en-US -Module Guid: 389c464d-8b8d-48e9-aafe-6d8a590d6798 -Module Name: DISM ---- - -# DISM Module - -## Description - -The Deployment Image Servicing and Management (DISM) platform is used to mount and service Windows -images before deployment. A subset of DISM commands can be used on online Windows images. You can -use DISM tools to mount, and get information about, Windows image (`.wim`) files or virtual hard -disks (`.vhd` or `.vhdx`). You can also use it to install, uninstall, configure, and update Windows -features, packages, and drivers in a Windows image or to change the edition of a Windows image. - -This topic introduces the DISM cmdlets available in the DISM PowerShell module. This module is -available in Windows 8.1 and Windows Server 2012 R2. On other supported operating systems, you can -install the DISM module from the -[Windows Assessment and Deployment Kit (Windows ADK)](https://go.microsoft.com/fwlink/?LinkId=206587). -For more information about how to use the DISM PowerShell module installed with the ADK, see -[How to Use DISM in Windows PowerShell](https://go.microsoft.com/fwlink/?LinkId=239927). - -For Windows 8.1 and Windows Server 2012 R2, Windows PowerShell 4.0 is included in the installation. -For other supported versions of Windows and Windows Server, (including Windows 8, Windows 7 SP1, -Windows Server 2012, and Windows Server 2008 R2 SP1), you must install the latest Windows Management -Framework. - -The DISM platform also includes a command-line tool, DISM.exe, and the -[DISM API](https://go.microsoft.com/fwlink/?LinkID=237611). The command-line tool is available in -the -[Windows Assessment and Deployment Kit (Windows ADK)](https://go.microsoft.com/fwlink/?LinkId=206587) -and includes additional functionality that supports servicing commands for international settings. - -You can check for errors when running DISM cmdlets by checking if the `$?`. If set to True the last -operation succeeded. If False the last operation failed. The `$LASTEXITCODE` contains the exit code -of the last Win32 executable run. For example, to check that the `Get-WindowsImage` cmdlet fails to -get information about the Windows image contained in the file, `E:\images\c.wim`, type the -following: - -```powershell -try -{ - - Get-WindowsImage -ImagePath E:\images\c.wim -} -catch -{ - $message = "TRAPPED: {0}: '{1}'" -f ($_.Exception.GetType().FullName), ($_.Exception.Message) - Write-host $message -} - -``` - -For more information about error handling, see the -[about_Try_Catch_Finally](https://go.microsoft.com/fwlink/p/?LinkID=317390). - -## DISM Cmdlets -### [Add-AppxProvisionedPackage](./Add-AppxProvisionedPackage.md) -Adds an app package (.appx) that will install for each new user to a Windows image. - -### [Add-WindowsDriver](./Add-WindowsDriver.md) -Adds a driver to an offline Windows image. - -### [Add-WindowsPackage](./Add-WindowsPackage.md) -Adds a single .cab or .msu file to a Windows image. - -### [Clear-WindowsCorruptMountPoint](./Clear-WindowsCorruptMountPoint.md) -Deletes all of the resources associated with a mounted image that has been corrupted. - -### [Disable-WindowsOptionalFeature](./Disable-WindowsOptionalFeature.md) -Disables a feature in a Windows image. - -### [Dismount-WindowsImage](./Dismount-WindowsImage.md) -Dismounts a Windows image from the directory it is mapped to. - -### [Enable-WindowsOptionalFeature](./Enable-WindowsOptionalFeature.md) -Enables a feature in a Windows image. - -### [Get-AppxProvisionedPackage](./Get-AppxProvisionedPackage.md) -Gets information about app packages (.appx) in an image that will be installed for each new user. - -### [Get-WindowsDriver](./Get-WindowsDriver.md) -Displays information about drivers in a Windows image. - -### [Get-WindowsEdition](./Get-WindowsEdition.md) -Gets edition information about a Windows image. - -### [Get-WindowsImage](./Get-WindowsImage.md) -Gets information about a Windows image in a WIM or VHD file. - -### [Get-WindowsOptionalFeature](./Get-WindowsOptionalFeature.md) -Gets information about optional features in a Windows image. - -### [Get-WindowsPackage](./Get-WindowsPackage.md) -Gets information about packages in a Windows image. - -### [Mount-WindowsImage](./Mount-WindowsImage.md) -Mounts a Windows image in a WIM or VHD file to a directory on the local computer. - -### [Remove-AppxProvisionedPackage](./Remove-AppxProvisionedPackage.md) -Removes an app package (.appx) from a Windows image. - -### [Remove-WindowsDriver](./Remove-WindowsDriver.md) -Removes a driver from an offline Windows image. - -### [Remove-WindowsPackage](./Remove-WindowsPackage.md) -Removes a package from a Windows image. - -### [Repair-WindowsImage](./Repair-WindowsImage.md) -Repairs a Windows image in a WIM or VHD file. - -### [Save-WindowsImage](./Save-WindowsImage.md) -Applies changes made to a mounted image to its WIM or VHD file. - -### [Set-WindowsEdition](./Set-WindowsEdition.md) -Changes a Windows image to a higher edition. - -### [Set-WindowsProductKey](./Set-WindowsProductKey.md) -Sets the product key for the Windows image. - -### [Use-WindowsUnattend](./Use-WindowsUnattend.md) -Applies an unattended answer file to a Windows image. - diff --git a/docset/winserver2012-ps/dism/Dismount-WindowsImage.md b/docset/winserver2012-ps/dism/Dismount-WindowsImage.md deleted file mode 100644 index 4b5f0eed5b..0000000000 --- a/docset/winserver2012-ps/dism/Dismount-WindowsImage.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/dismount-windowsimage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Dismount-WindowsImage - -## SYNOPSIS -Dismounts a Windows image from the directory it is mapped to. - -## SYNTAX - -### DismountDiscard -``` -Dismount-WindowsImage -Path [-Discard] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -### DismountSave -``` -Dismount-WindowsImage -Path [-Save] [-CheckIntegrity] [-Append] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Dismount-WindowsImage** cmdlet either saves or discards the changes to a Windows image and then dismounts the image. - -The *Path* parameter specifies the location of the mounted Windows image. - -The *Append* parameter specifies the location of an existing .wim file to add the Windows image to when you dismount it instead of overwriting the existing image. - -The *CheckIntegrity* parameter detects and tracks .wim file corruption. -CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. - -The *CheckIntegrity* and *Append* parameters do not apply to virtual hard disk (VHD) files. - -## EXAMPLES - -### Example 1: Dismount an operating system image -``` -PS C:\>Dismount-WindowsImage -Path "c:\offline" -Save -``` - -This command dismounts the Windows Image mapped to c:\offline and saves any changes that were made while servicing the image. - -## PARAMETERS - -### -Append -Specifies the location of an existing .wim file to add the Windows image to when you dismount it instead of overwriting the existing image. - -```yaml -Type: SwitchParameter -Parameter Sets: DismountSave -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CheckIntegrity -Detects and tracks .wim file corruption. -*CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: DismountSave -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Discard -Discards the changes to a Windows image. - -```yaml -Type: SwitchParameter -Parameter Sets: DismountDiscard -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Save -Saves the changes to a Windows image. - -```yaml -Type: SwitchParameter -Parameter Sets: DismountSave -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.MountedImageInfoObject - -### Microsoft.Dism.Commands.ImageInfoObject - -## OUTPUTS - -### Microsoft.Dism.Commands.BaseDismObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Enable-WindowsOptionalFeature.md b/docset/winserver2012-ps/dism/Enable-WindowsOptionalFeature.md deleted file mode 100644 index f2e5ee08c7..0000000000 --- a/docset/winserver2012-ps/dism/Enable-WindowsOptionalFeature.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/enable-windowsoptionalfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-WindowsOptionalFeature - -## SYNOPSIS -Enables a feature in a Windows image. - -## SYNTAX - -### Offline -``` -Enable-WindowsOptionalFeature -FeatureName [-PackageName ] [-All] [-LimitAccess] - [-Source ] [-NoRestart] -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Online -``` -Enable-WindowsOptionalFeature -FeatureName [-PackageName ] [-All] [-LimitAccess] - [-Source ] [-NoRestart] [-Online] [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Enable-WindowsOptionalFeature** cmdlet enables or restores an optional feature in a Windows image. - -Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image. - -The *PackageName* parameter specifies the package that the feature is a component of. -This parameter is optional when the package is the Windows Foundation package. - -The *FeatureName* parameter specifies the feature to add. -You can specify more than one feature in the same package. -Separate feature names with a comma. - -The *Source* parameter specifies the location of files that are needed to restore a removed feature. - -The *LimitAccess* parameter prevents access to Windows Update as a Source for restoring features to online images. -The *All* parameter enables all parent features of the specified feature before enabling the specified feature. -The parent feature will be enabled with default values. - -## EXAMPLES - -### Example 1: Enable an optional feature in the running operating system -``` -PS C:\>Enable-WindowsOptionalFeature -Online -FeatureName "Hearts" -All -``` - -This command enables the optional feature, Hearts, the parent feature for Hearts, and the dependencies for the parent feature in the running Windows operating system. - -### Example 2: Enable an optional feature in a mounted operating system image -``` -PS C:\>Enable-WindowsOptionalFeature -Path "c:\offline" -FeatureName "Calc" -PackageName "Microsoft.Windows.Calc.Demo~6595b6144ccf1df~x86~en~1.0.0.0" -``` - -This command enables the optional feature, Calc, in the specified package in the Windows image that is mounted to c:\offline. - -### Example 3: Restore an optional feature -``` -PS C:\>Enable-WindowsOptionalFeature -Online -FeatureName "MyFeature" -Source "c:\test\mount" -LimitAccess -``` - -This command restores the optional feature, MyFeature, to the Windows image that is mounted to c:\offline using source files from another Windows image that is mounted to c:\test\mount. -If the files are not found in the source image, this command specifies not to check Windows Update for the source files. - -## PARAMETERS - -### -All -Enables all parent features of the specified feature. -If a parent feature is required for the specified feature to be enabled in the image, *All* enables the parent and all of its default dependencies. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature to be enabled. -Feature names are case sensitive if you are servicing a Windows image running a version of Windows earlier than Windows® 8. -You can use Get-WindowsOptionalFeature to find the name of the feature in the image. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LimitAccess -Prevents DISM from contacting Windows Update when searching for the source files to restore a feature on an online image. - -*LimitAccess* can only be used when servicing images with Windows 8, Windows Server® 2012, Windows® Preinstallation Environment (Windows PE) 4.0 or a later version. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRestart -Suppresses reboot. -If a reboot is not required, this command does nothing. -This option will keep the application from prompting for a restart or keep it from restarting automatically. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of a package in the Windows image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Source -Specifies the location of the files that are required to restore a feature that has been removed from the image. -You can specify the Windows directory of a mounted image or a running Windows installation that is shared on the network. - -If you specify multiple *Source* arguments, the files are gathered from the first location where they are found and the rest of the locations are ignored. -Separate feature names with a comma. - -If you do not specify a *Source* for a feature that has been removed, the default location set by Group Policy is used. -Windows Update is also used for online images. - -*Source* can only be used when servicing an image with Windows 8 or Windows Server 2012 or a later version. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Get-AppxProvisionedPackage.md b/docset/winserver2012-ps/dism/Get-AppxProvisionedPackage.md deleted file mode 100644 index 1b3a2b7d99..0000000000 --- a/docset/winserver2012-ps/dism/Get-AppxProvisionedPackage.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/get-appxprovisionedpackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-AppxProvisionedPackage - -## SYNOPSIS -Gets information about app packages (.appx) in an image that will be installed for each new user. - -## SYNTAX - -### Offline -``` -Get-AppxProvisionedPackage -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Online -``` -Get-AppxProvisionedPackage [-Online] [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Get-AppxProvisionedPackage** cmdlet gets information about app packages (.appx) in an image that are set to install for each new user. -For information about app packages (.appx) that are not provisioned, use the Get-AppxPackage cmdlet instead. - -Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image. - -## EXAMPLES - -### Example 1: List the app packages the mounted image to install for each account -``` -PS C:\>Get-AppxProvisionedPackage -Path "c:\offline" -``` - -This command lists the app packages (.appx) in the Windows image that is mounted to c:\offline that will be installed for each new user account. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.AppxPackageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Get-WindowsDriver.md b/docset/winserver2012-ps/dism/Get-WindowsDriver.md deleted file mode 100644 index e41f78fad6..0000000000 --- a/docset/winserver2012-ps/dism/Get-WindowsDriver.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/get-windowsdriver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WindowsDriver - -## SYNOPSIS -Displays information about drivers in a Windows image. - -## SYNTAX - -### Offline -``` -Get-WindowsDriver [-All] [-Driver ] -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Online -``` -Get-WindowsDriver [-All] [-Driver ] [-Online] [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Get-WindowsDriver** cmdlet displays information about driver packages in the online or offline Windows image. -You can display basic information about all of the drivers in an image, or display detailed information about a specific driver. - -## EXAMPLES - -### Example 1: Gets all drivers in an online image -``` -PS C:\>Get-WindowsDriver -Online -All -``` - -This command gets all of the drivers in an online Windows image. - -### Example 2: Gets third-party drivers in a mounted image -``` -PS C:\>Get-WindowsDriver -Path "c:\offline" -``` - -This command gets the third-party drivers in a mounted Windows image. - -### Example 3: Get details about a driver in a mounted image -``` -PS C:\>Get-WindowsDriver -Path "c:\offline" -Driver "OEM1.inf" -``` - -This command gets detailed information about the OEM1.inf driver in a mounted Windows image. - -### Example 4: Get details about a driver in a specified location in a mounted image -``` -PS C:\>Get-WindowsDriver -Path "c:\offline" -Driver "c:\drivers\Usb\Usb.inf" -``` - -This command gets detailed information about the Usb.inf driver in a mounted Windows image. - -## PARAMETERS - -### -All -Displays information about default drivers. -If you do not specify this parameter, only third-party drivers and listed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Driver -Specifies the .inf file or folder containing the .inf files of the drivers you want detailed information about. -When you specify a folder, .inf files that are not valid driver packages are ignored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.BasicDriverObject - -### Microsoft.Dism.Commands.AdvancedDriverObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Get-WindowsEdition.md b/docset/winserver2012-ps/dism/Get-WindowsEdition.md deleted file mode 100644 index cc421f154f..0000000000 --- a/docset/winserver2012-ps/dism/Get-WindowsEdition.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/get-windowsedition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WindowsEdition - -## SYNOPSIS -Gets edition information about a Windows image. - -## SYNTAX - -### Offline -``` -Get-WindowsEdition [-Target] -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Online -``` -Get-WindowsEdition [-Target] [-Online] [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Get-WindowsEdition** cmdlet gets the current editions of the specified Windows image. - -The *Target* parameter gets the target editions available in the specified Windows image. - -Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image. - -## EXAMPLES - -### Example 1: Display the current edition of the operating system -``` -PS C:\>Get-WindowsEdition -Online -``` - -This command displays the name of the current edition of the running Windows operating system. - -### Example 2: Display the target editions for a mounted image -``` -PS C:\>Get-WindowsEdition -Path "c:\offline" -Target -``` - -This command displays the names of the available target editions that the mounted Windows image at c:\offline can be changed to. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Target -Displays a list of Windows editions that an image can be changed to. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.EditionObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Get-WindowsImage.md b/docset/winserver2012-ps/dism/Get-WindowsImage.md deleted file mode 100644 index 5cf028cd0b..0000000000 --- a/docset/winserver2012-ps/dism/Get-WindowsImage.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/get-windowsimage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WindowsImage - -## SYNOPSIS -Gets information about a Windows image in a WIM or VHD file. - -## SYNTAX - -### InputByFilePathAndIndex -``` -Get-WindowsImage -ImagePath -Index [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -### InputByFilePath -``` -Get-WindowsImage -ImagePath [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -### InputByFilePathAndName -``` -Get-WindowsImage -ImagePath -Name [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -### InputByMounted -``` -Get-WindowsImage [-Mounted] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Get-WindowsImage** cmdlet gets information about a Windows image in a WIM or VHD file. - -Use the *Mounted* parameter to get information about any Windows images that are mapped to directories on the local computer. - -Use the *ImagePath* parameter to get information about images in a specific WIM or VHD file. - -Use the *Index* or *Name* parameter to get detailed information about a specific image in a WIM or VHD file. -For a VHD file, the **Index** must be 1. - -## EXAMPLES - -### Example 1: Get information about all mounted images -``` -PS C:\>Get-WindowsImage -Mounted -``` - -This command gets information, including mount path, about all of the Windows images mounted on the local computer. - -### Example 2: Get information about a specific mounted image -``` -PS C:\>Get-WindowsImage -ImagePath "c:\imagestore\install.wim" -Name "Ultimate" -``` - -This command gets detailed information about the Windows image named Ultimate in the install.wim file at c:\imagestore. - -### Example 3: Get information about a specific image -``` -PS C:\>Get-WindowsImage -ImagePath "c:\imagestore\install.vhd" -``` - -This command gets basic information about the Windows image in the install.vhd file at c:\imagestore. - -## PARAMETERS - -### -ImagePath -Specifies the location of a WIM or VHD file. - -```yaml -Type: String -Parameter Sets: InputByFilePathAndIndex, InputByFilePath, InputByFilePathAndName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Index -Specifies the index number of a Windows image in a WIM or VHD file. -For a VHD file, the Index must be 1. - -```yaml -Type: UInt32 -Parameter Sets: InputByFilePathAndIndex -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: 3 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Mounted -Gets information, including the mount path, for all images mapped to a directories on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: InputByMounted -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an image in a WIM or VHD file. - -```yaml -Type: String -Parameter Sets: InputByFilePathAndName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageInfoObject - -### Microsoft.Dism.Commands.MountedImageInfoObject - -### Microsoft.Dism.Commands.WimImageInfoObject - -### Microsoft.Dism.Commands.BasicImageInfoObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Get-WindowsOptionalFeature.md b/docset/winserver2012-ps/dism/Get-WindowsOptionalFeature.md deleted file mode 100644 index cfebe02bbb..0000000000 --- a/docset/winserver2012-ps/dism/Get-WindowsOptionalFeature.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/get-windowsoptionalfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WindowsOptionalFeature - -## SYNOPSIS -Gets information about optional features in a Windows image. - -## SYNTAX - -### Offline -``` -Get-WindowsOptionalFeature [-FeatureName ] [-PackageName ] [-PackagePath ] - -Path [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Online -``` -Get-WindowsOptionalFeature [-FeatureName ] [-PackageName ] [-PackagePath ] [-Online] - [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -## DESCRIPTION -The **Get-WindowsOptionalFeature** cmdlet gets information about all features (operating system features that include optional Windows foundation features) in the Windows Foundation Package or a specified package in the Windows image. - -Use the *PackageName* or *PackagePath* parameter to get information about all features in a specific package in the Windows image. - -The *FeatureName* parameter gets more detailed information about a specific feature in the Windows image. -If the feature is not a part of the Windows Foundation package, either a PackageName or *PackagePath* parameter must be used to specify the parent package of the feature. - -Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image. - -## EXAMPLES - -### Example 1: Lists optional features in the running operating system -``` -PS C:\>Get-WindowsOptionalFeature -Online -``` - -This command lists all of the optional features in the running Windows operating system. - -### Example 2: Lists optional features in a package in a mounted image -``` -PS C:\>Get-WindowsOptionalFeature -Path "c:\offline" -PackageName "Microsoft-Windows-Backup-Package~31bf3856ad364e35~x86~~6.1.7601.16525" -``` - -This command displays lists all of the optional features in the specified package in the Windows image mounted to c:\offline. - -### Example 3: Get details about a feature in a mounted image -``` -PS C:\>Get-WindowsOptionalFeature -Path "c:\offline" -FeatureName "Hearts" -``` - -This command displays detailed information about the feature, Hearts, in the Windows Foundation Package in the Windows image mounted to c:\offline. - -### Example 4: Gets details about a feature in a specified package in a mounted image -``` -PS C:\>Get-WindowsOptionalFeature -Path "c:\offline" -FeatureName "MyFeature" -PackagePath "c:\packages\package.cab" -``` - -This command displays detailed information about the feature, MyFeature, in the package at c:\package\package.cab in the Windows image mounted to c:\offline. - -## PARAMETERS - -### -FeatureName -Specifies the name of a feature to get detailed information about. -Feature names are case sensitive if you are servicing a Windows image other than Windows 8. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of a package as it is listed in the Windows image. -Use the *PackageName* parameter to get all of the features in the package. -Use the *FeatureName* and *PackageName* parameters to get more detailed information about a specific feature in the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackagePath -Specifies the location of a .cab file in the Windows image. -Use the *PackagePath* parameter to get all of the features in the package. -Use the *FeatureName* and *PackagePath* parameters to get more detailed information about a specific feature in the package. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.BasicFeatureObject - -### Microsoft.Dism.Commands.AdvancedFeatureObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Get-WindowsPackage.md b/docset/winserver2012-ps/dism/Get-WindowsPackage.md deleted file mode 100644 index 7b6d2ee7ff..0000000000 --- a/docset/winserver2012-ps/dism/Get-WindowsPackage.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/get-windowspackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WindowsPackage - -## SYNOPSIS -Gets information about packages in a Windows image. - -## SYNTAX - -### Offline -``` -Get-WindowsPackage [-PackagePath ] [-PackageName ] -Path [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -### Online -``` -Get-WindowsPackage [-PackagePath ] [-PackageName ] [-Online] [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Get-WindowsPackage** cmdlet gets information about all packages in a Windows image or about a specific package that is provided as a .cab file. - -Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image. - -Use either the *PackageName* or *PackagePath* parameter to get more detailed information about a specific package in the Windows image such as whether the package can be installed completely offline without booting the image. - -You cannot use this command to obtain detailed package information for .msu files, only .cab files. - -## EXAMPLES - -### Example 1: List packages in a mounted image -``` -PS C:\>Get-WindowsPackage -Path "c:\offline" -``` - -This command lists all of the packages in the Windows image that is mounted to c:\offline. - -### Example 2: List details about a package in a mounted image -``` -PS C:\>Get-WindowsPackage -Path "c:\offline" -PackageName "Microsoft-Windows-Backup-Package~31bf3856ad364e35~x86~~6.1.7601.16525" -``` - -This command displays detailed information about the specified package in the Windows image that is mounted to c:\offline. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of a package as it is listed in the Windows image. -Use the *PackageName* parameter to get more detailed information about a specific package in the Windows image, such as whether the package can be installed completely offline without booting the image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackagePath -Specifies the location of a .cab file in the Windows image. -Use the *PackagePath* parameter to get more detailed information about a specific package in the Windows image, such as whether the package can be installed completely offline without booting the image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.BasicPackageObject - -### Microsoft.Dism.Commands.AdvancedPackageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Mount-WindowsImage.md b/docset/winserver2012-ps/dism/Mount-WindowsImage.md deleted file mode 100644 index 4441c09b3c..0000000000 --- a/docset/winserver2012-ps/dism/Mount-WindowsImage.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/mount-windowsimage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Mount-WindowsImage - -## SYNOPSIS -Mounts a Windows image in a WIM or VHD file to a directory on the local computer. - -## SYNTAX - -### OfflineName -``` -Mount-WindowsImage -Path -ImagePath -Name [-ReadOnly] [-Optimize] [-CheckIntegrity] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -### OfflineIndex -``` -Mount-WindowsImage -Path -ImagePath -Index [-ReadOnly] [-Optimize] [-CheckIntegrity] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Remount -``` -Mount-WindowsImage -Path [-Remount] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -## DESCRIPTION -The **Mount-WindowsImage** cmdlet maps a Windows image in a WIM or VHD file to the specified directory so that it is accessible for servicing. - -The *Path* parameter specifies the location where you want to mount the Windows image. - -The *ImagePath* parameter specifies the location of the WIM or VHD file containing the Windows image you want to mount. - -Use the *Index* or *Name* parameter to specify which image in a WIM or VHD file that you want to mount. -For a VHD file, the *Index* must be 1. - -The *Optimize* parameter reduces the amount of time it takes to initially mount the image. -However, processes that are ordinarily performed during a mount will instead be completed the first time that you access a directory. -As a result, there may be an increase in the time that is required to access a directory for the first time after mounting an image using the *Optimize* parameter. - -The *Remount* parameter mounts an image in a WIM or VHD file that was already mounted at the specified *Path*, but has become inaccessible for servicing. - -The *CheckIntegrity* parameter detects and tracks .wim file corruption. -*CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. - -The *CheckIntegrity* parameter does not apply to virtual hard disk (VHD) files. - -## EXAMPLES - -### Example 1: Mount an image from the Install.vhd file to a directory -``` -PS C:\>Mount-WindowsImage -ImagePath "c:\imagestore\Install.vhd" -Index 1 -Path "c:\offline" -``` - -This command mounts the Windows image contained in the Install.vhd file to the c:\offline directory. - -### Example 2: Mount an image at an index of a file with read-only privileges -``` -PS C:\>Mount-WindowsImage -ImagePath "c:\imagestore\Install.wim" -Index 2 -Path "c:\offline" -ReadOnly -``` - -This command mounts the Windows image at index 2 of the Install.wim file to the c:\offline directory with read-only privileges. - -### Example 3: Mount an image at an index of a file -``` -PS C:\>Mount-WindowsImage -ImagePath "c:\imagestore\Install.wim" -Index 2 -Path "c:\offline" -Optimize -``` - -This command mounts the Windows image at index 2 of the Install.wim file to the c:\offline directory with a quicker initial mount time. -Additional operations may be slower. - -### Example 4: Remount an image previously mounted to a directory that is inaccessible -``` -PS C:\>Mount-WindowsImage -Path "c:\offline" -Remount -``` - -This command remounts a Windows image that has already been mounted to the c:\offline directory but has become inaccessible for servicing. - -## PARAMETERS - -### -CheckIntegrity -Detects and tracks .wim file corruption when used with the Dismount-WindowsImage or Save-WindowsImage cmdlet. -*CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. -The *CheckIntegrity* parameter does not apply to virtual hard disk (VHD) files. - -```yaml -Type: SwitchParameter -Parameter Sets: OfflineName, OfflineIndex -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ImagePath -Specifies the location of the WIM or VHD file containing the Windows image you want to mount. - -```yaml -Type: String -Parameter Sets: OfflineName, OfflineIndex -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Index -Specifies the index number of a Windows image in a WIM or VHD file. -For a VHD file, the **Index** must be 1. - -```yaml -Type: UInt32 -Parameter Sets: OfflineIndex -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of an image in a WIM or VHD file. - -```yaml -Type: String -Parameter Sets: OfflineName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Optimize -Reduces the amount of time it takes to initially mount the image. -However, processes that are ordinarily performed during a mount will instead be completed the first time that you access a directory. -As a result, there may be an increase in the time that is required to access a directory for the first time after mounting an image using the *Optimize* parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: OfflineName, OfflineIndex -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the location on your local computer where you want to mount the Windows image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReadOnly -Specifies that the image should be mounted with read-only permissions. - -```yaml -Type: SwitchParameter -Parameter Sets: OfflineName, OfflineIndex -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Remount -Mounts an image in a WIM or VHD file that was already mounted at the specified *Path*, but has become inaccessible for servicing. - -```yaml -Type: SwitchParameter -Parameter Sets: Remount -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.ImageInfoObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Remove-AppxProvisionedPackage.md b/docset/winserver2012-ps/dism/Remove-AppxProvisionedPackage.md deleted file mode 100644 index 9b815bfda2..0000000000 --- a/docset/winserver2012-ps/dism/Remove-AppxProvisionedPackage.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/remove-appxprovisionedpackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-AppxProvisionedPackage - -## SYNOPSIS -Removes an app package (.appx) from a Windows image. - -## SYNTAX - -### Offline -``` -Remove-AppxProvisionedPackage -PackageName -Path [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -### Online -``` -Remove-AppxProvisionedPackage -PackageName [-Online] [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Remove-AppxProvisionedPackage** cmdlet removes app packages (.appx) from a Windows image. -App packages are not installed when new user accounts are created. -Packages are not removed from existing user accounts. -To remove app packages (.appx) that are not provisioned or to remove a package for a particular user only, use Remove-AppxPackage instead. - -## EXAMPLES - -### Example 1: Remove an app package from an image -``` -PS C:\>Remove-AppxProvisionedPackage -Path c:\offline -PackageName "MyAppxPkg" -``` - -This command removes the app package (.appx), MyAppxPkg, from the Windows image that is mounted to c:\offline. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of the app package (.appx) to remove from the Windows image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.AppxPackageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Remove-WindowsDriver.md b/docset/winserver2012-ps/dism/Remove-WindowsDriver.md deleted file mode 100644 index a00ba12d0b..0000000000 --- a/docset/winserver2012-ps/dism/Remove-WindowsDriver.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/remove-windowsdriver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-WindowsDriver - -## SYNOPSIS -Removes a driver from an offline Windows image. - -## SYNTAX - -``` -Remove-WindowsDriver -Driver -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Remove-WindowsDriver** cmdlet removes third-party driver packages from an offline Windows image. - -Caution: Removing a boot-critical driver package can make the offline Windows image unbootable. - -## EXAMPLES - -### Example 1: Remove a driver from an image -``` -PS C:\>Remove-WindowsDriver -Path "c:\offline" -Driver "OEM1.inf" -``` - -This command removes the OEM1.inf driver from a mounted Windows image. - -## PARAMETERS - -### -Driver -Specifies the .inf file or folder containing the .inf files of the drivers you want to add. -When third-party drivers are added to an image, they are named OEM0.inf, OEM1.inf, and so on. -You must specify the published name (for example, OEM1.inf) to remove the driver. -You cannot remove default drivers. - -When you specify a folder, .inf files that are not valid driver packages are ignored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.BasicDriverObject - -### Microsoft.Dism.Commands.AdvancedDriverObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Remove-WindowsPackage.md b/docset/winserver2012-ps/dism/Remove-WindowsPackage.md deleted file mode 100644 index b041902568..0000000000 --- a/docset/winserver2012-ps/dism/Remove-WindowsPackage.md +++ /dev/null @@ -1,249 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/remove-windowspackage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-WindowsPackage - -## SYNOPSIS -Removes a package from a Windows image. - -## SYNTAX - -### Offline -``` -Remove-WindowsPackage [-PackagePath ] [-PackageName ] [-NoRestart] -Path - [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -### Online -``` -Remove-WindowsPackage [-PackagePath ] [-PackageName ] [-NoRestart] [-Online] - [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -## DESCRIPTION -The **Remove-WindowsPackage** cmdlet removes a specified .cab file package from the image. -Only .cab files can be specified. -You cannot use this command to remove .msu files. - -Using this command to remove a package from an offline image will not reduce the image size. - -## EXAMPLES - -### Example 1: Remove a package from a running operating system image -``` -PS C:\>Remove-WindowsPackage -Online -PackageName "Microsoft-Windows-Backup-Package~31bf3856ad364e35~x86~~6.1.7601.16525" -``` - -This command removes the specified package from the running Windows operating system. - -### Example 2: Remove a package from a mounted operating system image -``` -PS C:\>Remove-WindowsPackage -Path "c:\offline" -PackagePath "c:\packages\package.cab" -``` - -This command removes the package at c:\packages\package.cab from the Windows image that is mounted to c:\offline. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output. - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRestart -Suppresses reboot. -If a reboot is not required, this command does nothing. -This option will keep the application from prompting for a restart or keep it from restarting automatically. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackageName -Specifies the name of a package in the Windows image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PackagePath -Specifies the path to a .cab file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.BasicPackageObject - -### Microsoft.Dism.Commands.AdvancedPackageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Repair-WindowsImage.md b/docset/winserver2012-ps/dism/Repair-WindowsImage.md deleted file mode 100644 index 829cb974bc..0000000000 --- a/docset/winserver2012-ps/dism/Repair-WindowsImage.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/repair-windowsimage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Repair-WindowsImage - -## SYNOPSIS -Repairs a Windows image in a WIM or VHD file. - -## SYNTAX - -### Offline -``` -Repair-WindowsImage [-CheckHealth] [-ScanHealth] [-RestoreHealth] [-LimitAccess] [-Source ] - [-NoRestart] -Path [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -### Online -``` -Repair-WindowsImage [-CheckHealth] [-ScanHealth] [-RestoreHealth] [-LimitAccess] [-Source ] - [-NoRestart] [-Online] [-WindowsDirectory ] [-SystemDrive ] [-LogPath ] - [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Repair-WindowsImage** cmdlet repairs a Windows image in a WIM or VHD file. - -Use the *Online* parameter to specify the running operating system on your local computer, or use the *Path* parameter to specify the location of a mounted Windows image. - -The *LimitAccess* parameter prevents access to Windows Update (WU) as a *Source* for repairing online images. - -The *CheckHealth* parameter checks whether the image has been flagged as corrupted by a failed process and whether the corruption can be repaired. - -The *ScanHealth* parameter scans the image for component store corruption. -This operation will take several minutes. - -The *RestoreHealth* parameter scans the image for component store corruption, and then performs repair operations automatically. -This operation will take several minutes. - -The *Source* parameter specifies the location of known good versions of files that can be used for the repair, such as a path to the root directory of a mounted image. - -*CheckHealth*, *ScanHealth*, *RestoreHealth*, *Source*, and *LimitAccess* can only be used when servicing images that are running at least Windows® 8 or Windows Server® 2012. - -## EXAMPLES - -### Example 1: Scan an image for corruption -``` -PS C:\>Repair-WindowsImage -Path "C:\offline\Mount" -ScanHealth -``` - -This command scans the specified image for component store corruption. - -### Example 2: Check an image for corruption and whether to repair the image -``` -PS C:\>Repair-WindowsImage -Path "C:\offline\Mount" -CheckHealth -``` - -This command checks whether the specified image has been flagged as corrupted by a failed process and whether the corruption can be repaired. - -### Example 3: Check an image for corruption and repairs the image -``` -PS C:\>Repair-WindowsImage -Online -RestoreHealth -Source "C:\Mounted\VHD\Windows\WinSxS", "C:\Windows\TEMP" -LimitAccess -``` - -This command scans the specified image for component store corruption, and then performs repair operations automatically. - -## PARAMETERS - -### -CheckHealth -Checks whether the image has been flagged as corrupted by a failed process and whether the corruption can be repaired. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LimitAccess -Prevents DISM from contacting Windows Update (WU) when searching for the source files to repair an online image. - -*LimitAccess* can only be used when servicing images that are running at least Windows® 8, Windows Server® 2012, or Windows® Preinstallation Environment (Windows PE) 4.0. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRestart -Suppresses reboot. -If a reboot is not required, this command does nothing. -This option will keep the application from prompting for a restart or keep it from restarting automatically. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RestoreHealth -Scans the image for component store corruption, and then performs repair operations automatically. -This operation will take several minutes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScanHealth -Scans the image for component store corruption. -This operation will take several minutes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Source -Specifies the location of the files that are required to repair an image. -You can specify the Windows directory of a mounted image or a running Windows installation that is shared on the network. - -If you specify multiple *Source* arguments, the files are gathered from the first location where they are found and the rest of the locations are ignored. -Separate source locations with a comma. - -If you do not specify a *Source*, the default location set by Group Policy is used. -Windows Update (WU) is also used for online images. - -**Source can only be used when servicing images that are running at least Windows® 8 or Windows Server® 2012. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.ImageInfoObject - -### Microsoft.Dism.Commands.MountedImageInfoObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObjectWithState - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Save-WindowsImage.md b/docset/winserver2012-ps/dism/Save-WindowsImage.md deleted file mode 100644 index 4de8230898..0000000000 --- a/docset/winserver2012-ps/dism/Save-WindowsImage.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/save-windowsimage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Save-WindowsImage - -## SYNOPSIS -Applies changes made to a mounted image to its WIM or VHD file. - -## SYNTAX - -``` -Save-WindowsImage -Path [-CheckIntegrity] [-Append] [-LogPath ] [-ScratchDirectory ] - [-LogLevel ] [] -``` - -## DESCRIPTION -The **Save-WindowsImage** cmdlet applies the servicing changes made to a mounted image to its WIM or VHD file without unmounting it. - -The *Path* parameter specifies the location of the mounted Windows image. - -The *Append* parameter specifies the location of an existing .wim file to add the Windows image to when you save it. - -The *CheckIntegrity* parameter detects and tracks .wim file corruption. -*CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. -The *CheckIntegrity* parameter does not apply to virtual hard disk (VHD) files. - -## EXAMPLES - -### Example 1: Save servicing changes made to a mounted image -``` -PS C:\>Save-WindowsImage -Path "c:\offline" -``` - -This command saves the servicing changes made to the Windows image mounted to c:\offline. -It does not unmounts the image. - -## PARAMETERS - -### -Append -Indicates that this cmdlet specifies the location of an existing .wim file to add the Windows image to when you save it. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CheckIntegrity -Indicates that this cmdlet detects and tracks .wim file corruption. -*CheckIntegrity* stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. -The *CheckIntegrity* parameter does not apply to virtual hard disk (VHD) files. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you want to save. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.ImageObjectWithState - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Set-WindowsEdition.md b/docset/winserver2012-ps/dism/Set-WindowsEdition.md deleted file mode 100644 index a04bd90480..0000000000 --- a/docset/winserver2012-ps/dism/Set-WindowsEdition.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/set-windowsedition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WindowsEdition - -## SYNOPSIS -Changes a Windows image to a higher edition. - -## SYNTAX - -``` -Set-WindowsEdition -Edition -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Set-WindowsEdition** cmdlet changes a Windows image to a higher edition. -Use Get-WindowsEdition with the *Target* parameter to find which editions are available in an image. - -You should not use the **Set-WindowsEdition** on an image that has already been changed to a higher edition. -It is recommended that you use this option on the lowest edition available in the edition family. - -You can only change the edition on a running operating system for Windows Server images, not online Windows client images. - -## EXAMPLES - -### Example 1: Change the edition of an image -``` -PS C:\>Set-WindowsEdition -Path "c:\offline" -Edition "Ultimate" -``` - -This command changes the edition of the Windows image that is mounted to c:\offline to Ultimate. - -## PARAMETERS - -### -Edition -Specifies the target edition to change the Windows image to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -### Microsoft.Dism.Commands.EditionObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Set-WindowsProductKey.md b/docset/winserver2012-ps/dism/Set-WindowsProductKey.md deleted file mode 100644 index d1cb01b3bb..0000000000 --- a/docset/winserver2012-ps/dism/Set-WindowsProductKey.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/set-windowsproductkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WindowsProductKey - -## SYNOPSIS -Sets the product key for the Windows image. - -## SYNTAX - -``` -Set-WindowsProductKey -ProductKey -Path [-WindowsDirectory ] [-SystemDrive ] - [-LogPath ] [-ScratchDirectory ] [-LogLevel ] [] -``` - -## DESCRIPTION -The **Set-WindowsProductKey** cmdlet sets the product key for the current Windows Edition in the specified image. - -## EXAMPLES - -### Example 1: Set the product key on a mounted image -``` -PS C:\>Set-WindowsProductKey -Path "c:\offline" -ProductKey "12345-12345-12345-12345-12345" -``` - -This command sets the product key on the Windows image that is mounted to c:\offline. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductKey -Specifies the product key to use for the Windows image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dism/Use-WindowsUnattend.md b/docset/winserver2012-ps/dism/Use-WindowsUnattend.md deleted file mode 100644 index 8f0b979c5a..0000000000 --- a/docset/winserver2012-ps/dism/Use-WindowsUnattend.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.Dism.PowerShell.dll-Help.xml -Module Name: System.Object[] -online version: https://learn.microsoft.com/powershell/module/dism/use-windowsunattend?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Use-WindowsUnattend - -## SYNOPSIS -Applies an unattended answer file to a Windows image. - -## SYNTAX - -### Offline -``` -Use-WindowsUnattend -UnattendPath [-NoRestart] -Path [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -### Online -``` -Use-WindowsUnattend -UnattendPath [-NoRestart] [-Online] [-WindowsDirectory ] - [-SystemDrive ] [-LogPath ] [-ScratchDirectory ] [-LogLevel ] - [] -``` - -## DESCRIPTION -The **Use-WindowsUnattend** cmdlet applies an unattended answer file (Unattend.xml) to a Windows image. - -If you are updating device drivers using an unattended answer file, you must apply the answer file to an offline image and specify the settings in the offlineServicing configuration pass. - -If you are updating packages or other settings using an unattended answer file, you can apply the answer file to an offline or online image. -Specify the settings in the offlineServicing configuration pass. - -## EXAMPLES - -### Example 1: Apply an answer file to a mounted image -``` -PS C:\>Use-WindowsUnattend -Path "c:\offline" -UnattendPath "c:\test\answerfiles\myunattend.xml" -``` - -This command applies an answer file, myunattend.xml, to the Windows image that is mounted to c:\offline. - -### Example 2: Apply an answer file to the running operating system -``` -PS C:\>Use-WindowsUnattend -Online -UnattendPath "c:\test\answerfiles\myunattend.xml" -``` - -This command applies an answer file, myunattend.xml, to the online Windows image. - -## PARAMETERS - -### -LogLevel -Specifies the maximum output level shown in the logs. -The default log level is 3. -The accepted values are as follows: -1 = Errors only -2 = Errors and warnings -3 = Errors, warnings, and information -4 = All of the information listed previously, plus debug output - -```yaml -Type: LogLevel -Parameter Sets: (All) -Aliases: -Accepted values: Errors, Warnings, WarningsInfo - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogPath -Specifies the full path and file name to log to. -If not set, the default is `%WINDIR%\Logs\Dism\dism.log`. -In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. -The log file will automatically be archived. -The archived log file will be saved with .bak appended to the file name and a new log file will be generated. -Each time the log file is archived the .bak file will be overwritten. -When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRestart -Suppresses reboot. -If a reboot is not required, this command does nothing. -This option will keep the application from prompting for a restart or keep it from restarting automatically. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Online -Specifies that the action is to be taken on the operating system that is currently running on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: Online -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the root directory of the offline Windows image that you will service. -If the directory named Windows is not a subdirectory of the root directory, -WindowsDirectory must be specified. - -```yaml -Type: String -Parameter Sets: Offline -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScratchDirectory -Specifies a temporary directory that will be used when extracting files for use during servicing. -The directory must exist locally. -If not specified, the `\Windows\%Temp%` directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. -Items in the scratch directory are deleted after each operation. -You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. -The directory used for extracting files for temporary usage during servicing should be a local directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SystemDrive -Specifies the path to the location of the BootMgr files. -This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. -Use -SystemDrive to service an installed Windows image from a Windows PE environment. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UnattendPath -Specifies the location of the unattend.xml answer file to apply to the image. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WindowsDirectory -Specifies the path to the Windows directory relative to the image path. -This cannot be the full path to the Windows directory; it should be a relative path. -If not specified, the default is the Windows directory in the root of the offline image directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.String[] - -### Microsoft.Dism.Commands.ImageObject - -## OUTPUTS - -### Microsoft.Dism.Commands.ImageObject - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dnsclient/Add-DnsClientNrptRule.md b/docset/winserver2012-ps/dnsclient/Add-DnsClientNrptRule.md deleted file mode 100644 index 609a60da17..0000000000 --- a/docset/winserver2012-ps/dnsclient/Add-DnsClientNrptRule.md +++ /dev/null @@ -1,503 +0,0 @@ ---- -external help file: PS_DnsClientNRPTRule_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/add-dnsclientnrptrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsClientNrptRule - -## SYNOPSIS -Adds a rule to the Name Resolution Policy Table (NRPT). - -## SYNTAX - -``` -Add-DnsClientNrptRule [-GpoName ] [-DANameServers ] [-DAIPsecRequired] - [-DAIPsecEncryptionType ] [-DAProxyServerName ] [-DnsSecEnable] [-DnsSecIPsecRequired] - [-DnsSecIPsecEncryptionType ] [-NameServers ] [-NameEncoding ] - [-Namespace] [-Server ] [-DAProxyType ] [-DnsSecValidationRequired] [-DAEnable] - [-IPsecTrustAuthority ] [-Comment ] [-DisplayName ] [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-DnsClientNrptRule** cmdlet adds a Name Resolution Policy Table (NRPT) rule for the specified namespace. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-DnsClientNrptRule -GpoName TestGPO -DANameServers 10.0.0.1 -DAIPsecRequired -DAIPsecEncryptionType "High" -DAProxyServerName "DaServer.com:6666" -DnsSecEnable -PassThru -DAProxyType "UseProxyName" -DnsSecValidationRequired -DAEnable -IPsecTrustAuthority "RootCA" -Comment "Sample NRPT Rule" -DisplayName "Sample" -DnsSecIPsecRequired -DnsSecIPsecEncryptionType "Medium" -NameServers 10.0.0.1 -NameEncoding "Punycode" -Namespace "dnsnrpt.com" -Server host1.com -``` - -This example adds an NRPT rule in TestGPO on server host1.com for the namespace dnsnrpt.com. - -### EXAMPLE 2 -``` -PS C:\>Add-DnsClientNrptRule -Namespace pqr.com -NameServers 10.0.0.1 -``` - -This example adds an NRPT rule that configures the server named 10.0.0.1 as a DNS server for the namespace pqr.com. - -### EXAMPLE 3 -``` -PS C:\>Add-DnsClientNrptRule -Namespace pqr.com -DnsSecEnable -``` - -This example adds an NRPT rule that enables DNSSEC queries to be sent for the namespace pqr.com. - -### EXAMPLE 4 -``` -PS C:\>Add-DnsClientNrptRule -Namespace pqr.com -DnsSecEnable -NameServers 10.0.0.1 -``` - -This example adds an NRPT rule that enables DNSSEC queries to be sent to DNS server named 10.0.0.1 for the namespace pqr.com. - -### EXAMPLE 5 -``` -PS C:\>Add-DnsClientNrptRule -Namespace pqr.com -NameEncoding Punycode -NameServers 10.1.1.1 -PassThru -Name : {6a78d8d1-231d-4d1e-bc23-fb593e11a53d} -Version : 2 -Namespace : {pqr.com} -IPsecCARestriction : -DirectAccessDnsServers : -DirectAccessEnabled : False -DirectAccessProxyType : -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : -NameServers : 10.1.1.1 -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Punycode -DisplayName : -Comment : -``` - -This example adds an NRPT rule that sends DNS queries encoded in Punycode to DNS server named 10.1.1.1 for the namespace pqr.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -Stores administrator notes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DAEnable -Specifies the rule state for DirectAccess (DA). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: DirectAccessEnabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAIPsecEncryptionType -Specifies the IPsec encryption setting for DA. -The acceptable values for this parameter are: None, Low, Medium, or High. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DirectAccessQueryIPSSECEncryption -Accepted values: , None, Low, Medium, High - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAIPsecRequired -Specifies that IPsec is required for DA. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: DirectAccessQueryIPsecRequired - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DANameServers -Specifies the DNS servers that will be queried when DA is enabled. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DirectAccessDnsServers - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAProxyServerName -Specifies the proxy server to be used when connecting to the Internet. - -This parameter is only applicable the **DAProxyType** parameter is set to UseProxyName. - -The allowed formats for this parameter are: hostname:port, IPv4 address:port, or IPv6 address:port. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DirectAccessProxyName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAProxyType -Specifies the proxy server type to be used when connecting to the Internet. -The acceptable values for this parameter are: NoProxy, UseDefault, or UseProxyName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DirectAccessProxyType -Accepted values: , NoProxy, UseDefault, UseProxyName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies an optional friendly name for the NRPT rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecEnable -Specifies that DNSSEC is enabled on the rule. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: DnsSecEnabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecIPsecEncryptionType -Specifies the IPsec tunnel encryption settings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DnsSecQueryIPsecEncryption -Accepted values: , None, Low, Medium, High - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecIPsecRequired -Specifies that the DNS client must set up an IPsec connection to the DNS server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: DnsSecQueryIPsecRequired - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecValidationRequired -Specifies that DNSSEC validation is required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GpoName -Specifies the name of the Group Policy Object (GPO). - - -- If this parameter and the **Server** parameter are specified, then the NRPT rule is added in the GPO of domain. -The **Server** parameter specifies the domain controller (DC). - - -- If neither this parameter nor the **Server** parameter is specified, then the NRPT rule is added for local client computer. - - -- If this parameter is specified and the **Server** parameter is not specified, then the DC of the domain specified by this parameter value is found and NRPT rule is added to the GPO. - - -- If this parameter is not specified and the **Server** parameter is specified, then an error is displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPsecTrustAuthority -Specifies the certification authority to validate the IPsec channel. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: IPsecCARestriction - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameEncoding -Specifies the encoding format for host names in the DNS query. -The acceptable values for this parameter are: Disable, Utf8WithMapping, Utf8WithoutMapping, or Punycode. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Disable, Utf8WithMapping, Utf8WithoutMapping, Punycode - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServers -Specifies the DNS servers to which the DNS query is sent when DA is disabled. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Specifies the DNS namespace. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the server hosting the GPO. -This parameter is only applicable with the **GpoName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptRule object contains all of the properties of the DNS client NRPT rule. - -## NOTES - -## RELATED LINKS - -[Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) - -[Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) - -[Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) - -[Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) - diff --git a/docset/winserver2012-ps/dnsclient/Clear-DnsClientCache.md b/docset/winserver2012-ps/dnsclient/Clear-DnsClientCache.md deleted file mode 100644 index 45bbd264ed..0000000000 --- a/docset/winserver2012-ps/dnsclient/Clear-DnsClientCache.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: MSFT_DnsClientCache.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/clear-dnsclientcache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-DnsClientCache - -## SYNOPSIS -Clears the contents of the DNS client cache. - -## SYNTAX - -``` -Clear-DnsClientCache [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Clear-DnsClientCache** cmdlet deletes all the contents of the DNS client cache. -Running this cmdlet is equivalent to running `ipconfig /flushdns`. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Clear-DnsClientCache -``` - -This example clears the DNS client cache. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-DnsClientCache](./Get-DnsClientCache.md) - diff --git a/docset/winserver2012-ps/dnsclient/DnsClient.md b/docset/winserver2012-ps/dnsclient/DnsClient.md deleted file mode 100644 index 859afd21ca..0000000000 --- a/docset/winserver2012-ps/dnsclient/DnsClient.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 5696d5ef-fa2d-4997-94f1-0bc13daa2ac5 -Module Name: DnsClient ---- - -# DnsClient Module -## Description -This reference provides cmdlet descriptions and syntax for all Domain Name System (DNS) Client-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## DnsClient Cmdlets -### [Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) -Adds a rule to the Name Resolution Policy Table (NRPT). - -### [Clear-DnsClientCache](./Clear-DnsClientCache.md) -Clears the contents of the DNS client cache. - -### [Get-DnsClient](./Get-DnsClient.md) -Retrieves details of the network interfaces configured on a specified computer. - -### [Get-DnsClientCache](./Get-DnsClientCache.md) -Retrieves the contents of the DNS client cache. - -### [Get-DnsClientGlobalSetting](./Get-DnsClientGlobalSetting.md) -Retrieves global DNS client settings like the suffix search list. - -### [Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) -Retrieves the Name Resolution Policy Table (NRPT) global settings. - -### [Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) -Retrieves the Name Resolution Policy Table (NRPT) configured on the computer. - -### [Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) -Retrieves the DNS client Name Resolution Policy Table (NRPT) rules. - -### [Get-DnsClientServerAddress](./Get-DnsClientServerAddress.md) -Gets DNS server IP addresses from the TCP/IP properties on an interface. - -### [Register-DnsClient](./Register-DnsClient.md) -Registers all of the IP addresses on the computer onto the configured DNS server. - -### [Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) -Removes the specified DNS client Name Resolution Policy Table (NRPT) rule. - -### [Resolve-DnsName](./Resolve-DnsName.md) -Performs a DNS name query resolution for the specified name. - -### [Set-DnsClient](./Set-DnsClient.md) -Sets the interface specific DNS client configurations on the computer. - -### [Set-DnsClientGlobalSetting](./Set-DnsClientGlobalSetting.md) -Sets the DNS client global, non-interface specific, settings. - -### [Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) -Modifies the global Name Resolution Policy Table (NRPT) settings. - -### [Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) -Modifies a DNS client Name Resolution Policy Table (NRPT) rule for the specified namespace. - -### [Set-DnsClientServerAddress](./Set-DnsClientServerAddress.md) -Sets DNS server addresses associated with the TCP/IP properties on an interface. - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClient.md b/docset/winserver2012-ps/dnsclient/Get-DnsClient.md deleted file mode 100644 index 9631e22e97..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClient.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: MSFT_DnsClient.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclient?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClient - -## SYNOPSIS -Retrieves details of the network interfaces configured on a specified computer. - -## SYNTAX - -``` -Get-DnsClient [-InterfaceIndex ] [[-InterfaceAlias] ] - [-ConnectionSpecificSuffix ] [-RegisterThisConnectionsAddress ] - [-UseSuffixWhenRegistering ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-DnsClient** cmdlet retrieves configuration details specific to the different network interfaces on a specified computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClient -``` - -This example gets configuration details of network interfaces on a computer. - -### EXAMPLE 2 -``` -PS C:\>$dnsClient1 = Get-DnsClient -InterfaceAlias "Wired Ethernet Connection" - - - -PS C:\>Set-DnsClientServerAddress -InputObject $dnsClinet1 -ServerAddresses ("10.0.0.1","10.0.0.2") - - -This is a version of the cmdlet using the pipeline. -PS C:\>Get-DnsClient | Set-DnsClientServerAddress -ServerAddresses ("10.0.0.1","10.0.0.2") -``` - -This example sets the DNS server IP address on all of the wired Ethernet connections on a computer. - -### EXAMPLE 3 -``` -PS C:\>Get-DnsClient | Set-DnsClientServerAddress -ResetServerAddresses -``` - -This example resets all of the network interfaces to use DHCP-specified DNS server addresses. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionSpecificSuffix -Specifies the connection-specific suffixes that are to be appended. -This parameter is a per-connection DNS suffix which will be appended to the computer name to construct a Fully Qualified Domain Name (FQDN). -This FQDN will be used as the host name for name resolution by the DNS client. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Suffix - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies the friendly name of the interface. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceIndex -Specifies the index number of the interface. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -RegisterThisConnectionsAddress -Specifies the registration policy for this interface. - -This parameter specifies that the computer should automatically register the IP address associated with this connection with the DNS server. - -```yaml -Type: Boolean[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSuffixWhenRegistering -Specifies the registration suffix policy for this interface. - -This parameter specifies that suffixes need to be used while registering an IP address. - -```yaml -Type: Boolean[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddress -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Register-DnsClient](./Register-DnsClient.md) - -[Set-DnsClient](./Set-DnsClient.md) - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClientCache.md b/docset/winserver2012-ps/dnsclient/Get-DnsClientCache.md deleted file mode 100644 index 8dc3390681..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClientCache.md +++ /dev/null @@ -1,230 +0,0 @@ ---- -external help file: MSFT_DnsClientCache.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclientcache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClientCache - -## SYNOPSIS -Retrieves the contents of the DNS client cache. - -## SYNTAX - -``` -Get-DnsClientCache [[-Entry] ] [-Name ] [-Type ] [-Status ] - [-Section ] [-TimeToLive ] [-DataLength ] [-Data ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DnsClientCache** cmdlet retrieves the contents of the local DNS client cache. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClientCache -``` - -This example gets the contents of the DNS client cache. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Data -Specifies the record data. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DataLength -Specifies the record data length. - -```yaml -Type: UInt16[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Entry -Specifies the cache entry name. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the record name. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: RecordName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Section -Specifies the record section. -The acceptable values for this parameter are: Answer, Authority, or Additional. - -```yaml -Type: Section[] -Parameter Sets: (All) -Aliases: -Accepted values: Answer, Authority, Additional - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -Specifies the record status. -The acceptable values for this parameter are: Success, NotExist, or NoRecords. - -```yaml -Type: Status[] -Parameter Sets: (All) -Aliases: -Accepted values: Success, NotExist, NoRecords - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the record time-to-live, in seconds. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: TTL - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the record type. -The acceptable values for this parameter are: A, NS, CNAME, SOA, PTR, MX, AAAA, or SRV. - -```yaml -Type: Type[] -Parameter Sets: (All) -Aliases: RecordType -Accepted values: A, NS, CNAME, SOA, PTR, MX, AAAA, SRV - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DnsClientCache -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_DnsClientCache object contains all of the entries in the DNS client cache. - -## NOTES - -## RELATED LINKS - -[Clear-DnsClientCache](./Clear-DnsClientCache.md) - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClientGlobalSetting.md b/docset/winserver2012-ps/dnsclient/Get-DnsClientGlobalSetting.md deleted file mode 100644 index ca6ef1806b..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClientGlobalSetting.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: MSFT_DnsClientGlobalSetting.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclientglobalsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClientGlobalSetting - -## SYNOPSIS -Retrieves global DNS client settings like the suffix search list. - -## SYNTAX - -``` -Get-DnsClientGlobalSetting [-CimSession ] [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DnsClientGlobalSetting** cmdlet retrieves DNS client settings that are global, that are not associated with a specific interface. -The settings affect the behavior of the DNS client across all of the interfaces. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClientGlobalSetting -UseSuffixSearchList : True -SuffixSearchList : {corp.contoso.com, na.corp.contoso.com} -UseDevolution : True -DevolutionLevel : 0 -``` - -This example gets all of the global DNS client settings. - -### EXAMPLE 2 -``` -PS C:\>$dnsCGSetting = Get-DnsClientGlobalSetting - - - -PS C:\>$dnsCGSetting.SuffixSearchList -corp.contoso.com -na.corp.contoso.com -``` - -This example gets the connection-specific suffixes. -The first item in the list is the primary DNS suffix, if configured. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientGlobalSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DnsClientGlobalSetting](./Set-DnsClientGlobalSetting.md) - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptGlobal.md b/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptGlobal.md deleted file mode 100644 index dbaaa48d2c..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptGlobal.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: PS_DnsClientNRPTGlobal_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclientnrptglobal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClientNrptGlobal - -## SYNOPSIS -Retrieves the Name Resolution Policy Table (NRPT) global settings. - -## SYNTAX - -``` -Get-DnsClientNrptGlobal [-Server ] [-GpoName ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DnsClientNrptGlobal** cmdlet retrieves the following Name Resolution Policy Table (NRPT) details: - - -- DirectAccess (DA) settings. - - -- DNS client query policy. - - -- DNS client name resolution fallback policy. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClientNrptGlobal -EnableDAForAllNetworks QueryPolicy SecureNameQueryFallback ----------------------- ----------- ----------------------- -Disable Disable Disable -``` - -This example retrieves the global NRPT settings. - -### EXAMPLE 2 -``` -PS C:\>Get-DnsClientNrptGlobal -GpoName "corp.contoso.com\DirectAccess Client Settings" -``` - -This example retrieves the global NRPT settings for the GPO named DirectAccess Client Settings that is linked to corp.contoso.com. - -### EXAMPLE 3 -``` -PS C:\>Get-DnsClientNrptGlobal -GpoName "corp.contoso.com\DirectAccess Client Settings" -Server dc1 -``` - -This example retrieves the global NRPT settings for the GPO named DirectAccess Client Settings that is linked to corp.contoso.com on the server named dc1. - -### EXAMPLE 4 -``` -PS C:\>Get-DnsClientNrptGlobal -GpoName "corp.contoso.com\DirectAccess Client Settings" -CimSession 2-dc1.corp2.corp.contoso.com -``` - -This example retrieves the global NRPT settings for the GPO named DirectAccess Client Settings that is linked to corp.contoso.com on the remote computer named 2-dc1.corp2.corp.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GpoName -Specifies the name of Group Policy Object (GPO). -If this parameter is not specified, then the default NRPT settings are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the server hosting the GPO. -This parameter is only applicable with the **GpoName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptGlobal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptGlobal object contains all of the properties of the DNS client NRPT global settings. - -## NOTES - -## RELATED LINKS - -[Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) - -[Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) - -[Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) - -[Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptPolicy.md b/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptPolicy.md deleted file mode 100644 index 1b8f2567b2..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptPolicy.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -external help file: PS_DnsClientNrptPolicy_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclientnrptpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClientNrptPolicy - -## SYNOPSIS -Retrieves the Name Resolution Policy Table (NRPT) configured on the computer. - -## SYNTAX - -``` -Get-DnsClientNrptPolicy [-Effective] [[-Namespace] ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DnsClientNrptPolicy** cmdlet retrieves the following Name Resolution Policy Table (NRPT) details for each namespace. - - -- DNS client name resolution fallback policy. - - -- DNS client secure name query fallback setting. - - -- Direct Access (DA) IPsec Certification Authority (CA) restriction setting. - - -- DA proxy name setting. - - -- DA DNS servers setting. - - -- DA enabled setting. - - -- DA proxy type setting. - - -- DA Query IPsec encryption setting. - - -- DA Query IPsec required setting. - - -- DNS client name servers setting. - - -- DNS security IPsec CA restriction setting. - - -- DNS security query IPsec encryption setting. - - -- DNS security query IPsec required setting. - - -- DNS security validation required setting. - - -- DNS client name encoding setting. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClientNrptPolicy -Namespace : nls.corp.contoso.com -QueryPolicy : -SecureNameQueryFallback : -DirectAccessIPsecCARestriction : -DirectAccessProxyName : -DirectAccessDnsServers : -DirectAccessEnabled : -DirectAccessProxyType : UseDefault -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecIPsecCARestriction : -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : False -DnsSecValidationRequired : False -NameEncoding : Utf8WithoutMapping - -Namespace : .corp.contoso.com -QueryPolicy : -SecureNameQueryFallback : -DirectAccessIPsecCARestriction : -DirectAccessProxyName : -DirectAccessDnsServers : {2001:db8:1::2, 2001:db8:2::20, - 2001:db8:6::6} -DirectAccessEnabled : -DirectAccessProxyType : NoProxy -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecIPsecCARestriction : -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : False -DnsSecValidationRequired : False -NameEncoding : Utf8WithoutMapping -``` - -This example retrieves the NRPT policy on a computer. - -### EXAMPLE 2 -``` -PS C:\>Get-DnsClientNrptPolicy -Effective -Namespace : nls.corp.contoso.com -QueryPolicy : QueryIPv6Only -SecureNameQueryFallback : FallbackPrivate -DirectAccessIPsecCARestriction : -DirectAccessProxyName : -DirectAccessDnsServers : -DirectAccessEnabled : True -DirectAccessProxyType : UseDefault -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecIPsecCARestriction : -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : - -Namespace : .corp.contoso.com -QueryPolicy : QueryIPv6Only -SecureNameQueryFallback : FallbackPrivate -DirectAccessIPsecCARestriction : -DirectAccessProxyName : -DirectAccessDnsServers : {2001:db8:1::2, 2001:db8:2::20, - 2001:db8:6::6} -DirectAccessEnabled : True -DirectAccessProxyType : NoProxy -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecIPsecCARestriction : -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : -``` - -This example retrieves the effective NRPT policy on a computer. - -### 1: -``` -PS C:\>Get-DnsClientNrptPolicy -Effective -Namespace nls.corp.contoso.com -Namespace : nls.corp.contoso.com -QueryPolicy : QueryIPv6Only -SecureNameQueryFallback : FallbackPrivate -DirectAccessIPsecCARestriction : -DirectAccessProxyName : -DirectAccessDnsServers : -DirectAccessEnabled : True -DirectAccessProxyType : UseDefault -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecIPsecCARestriction : -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : -``` - -This example retrieves an effective NRPT policy for the namespace nls.corp.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Effective -Specifies that the effective NRPT policy is returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies the DNS namespace for which the policy is retrieved - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientPolicyConfiguration[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientPolicyConfiguration object contains all of the properties of the DNS client NRPT policy. -If the **Effective** parameter is specified, then only the contents of effective policy are retrieved. - -## NOTES - -## RELATED LINKS - -[Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) - -[Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) - -[Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) - -[Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) - -[Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptRule.md b/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptRule.md deleted file mode 100644 index 879ef381aa..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClientNrptRule.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: PS_DnsClientNRPTRule_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclientnrptrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClientNrptRule - -## SYNOPSIS -Retrieves the DNS client Name Resolution Policy Table (NRPT) rules. - -## SYNTAX - -``` -Get-DnsClientNrptRule [-GpoName ] [[-Name] ] [-Server ] [-CimSession ] - [-ThrottleLimit ] [-AsJob] [] -``` - -## DESCRIPTION -The **Get-DnsClientNrptRule** cmdlet retrieves DNS client Name Resolution Policy Table (NRPT) rules with the following details: - - -- DNS client name setting. - - -- DNS client version setting. - - -- DNS client namespace setting. - - -- DNS client IPsec Certification Authority (CA) restriction setting. - - -- Direct Access (DA) DNS servers setting. - - -- DA enabled setting. - - -- DA proxy type setting. - - -- DA proxy name setting. - - -- DA query IPsec encryption setting. - - -- DA query IPsec required setting. - - -- DNS client name servers setting. - - -- DNS security enabled setting. - - -- DNS security query IPsec encryption setting. - - -- DNS security query IPsec required setting. - - -- DNS security validation required setting. - - -- DNS client name encoding setting. - - -- DNS client display name setting. - - -- DNS client comment setting. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -Name : DA-{FD4B6054-F8C8-4868-94E6-8132AC707DBD} -Version : 1 -Namespace : {.corp.contoso.com} -IPsecCARestriction : -DirectAccessDnsServers : {2001:db8:1::2, 2001:db8:2::20, 2001:db8:6::6} -DirectAccessEnabled : True -DirectAccessProxyType : NoProxy -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Disable -DisplayName : -Comment : - -Name : DA-{274D94E4-E38B-4997-BA9F-84700712C09E} -Version : 1 -Namespace : {nls.corp.contoso.com} -IPsecCARestriction : -DirectAccessDnsServers : -DirectAccessEnabled : True -DirectAccessProxyType : UseDefault -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Disable -DisplayName : -Comment : -``` - -This example retrieves an NRPT rules for the specified GPO. - -### EXAMPLE 2 -``` -PS C:\>Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -Server dc1 -Name : DA-{FD4B6054-F8C8-4868-94E6-8132AC707DBD} -Version : 1 -Namespace : {.corp.contoso.com} -IPsecCARestriction : -DirectAccessDnsServers : {2001:db8:1::2, 2001:db8:2::20, 2001:db8:6::6} -DirectAccessEnabled : True -DirectAccessProxyType : NoProxy -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Disable -DisplayName : -Comment : - -Name : DA-{274D94E4-E38B-4997-BA9F-84700712C09E} -Version : 1 -Namespace : {nls.corp.contoso.com} -IPsecCARestriction : -DirectAccessDnsServers : -DirectAccessEnabled : True -DirectAccessProxyType : UseDefault -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Disable -DisplayName : -Comment : -``` - -This example retrieves an NRPT rule for the specified GPO on the specified server. - -### EXAMPLE 3 -``` -PS C:\>Get-DnsClientNrptRule -GpoName "corp.contoso.com\DirectAccess Client Settings" -CimSession 2-dc1.corp2.corp.contoso.com -``` - -This example retrieves the NRPT rules on the remote computer named 2-dc1.corp2.corp.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GpoName -Specifies the name of the Group Policy Object (GPO). - - -- If this parameter and the **Server** parameter are specified, then the NRPT rule is added in the GPO of domain. -The **Server** parameter specifies the domain controller (DC). - - -- If neither this parameter nor the **Server** parameter is specified, then the NRPT rule is added for local client computer. - - -- If this parameter is specified and the **Server** parameter is not specified, then the DC of the domain specified by this parameter value is found and NRPT rule is added to the GPO. - - -- If this parameter is not specified and the **Server** parameter is specified, then an error is displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name which uniquely identifies a rule. -If this parameter is not specified, then all of the available NRPT rules are retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the server hosting the GPO. -This parameter is only applicable with the **GpoName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptRule object contains all of the properties of the DNS client NRPT rule. - -## NOTES - -## RELATED LINKS - -[Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) - -[Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) - -[Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) - -[Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) - diff --git a/docset/winserver2012-ps/dnsclient/Get-DnsClientServerAddress.md b/docset/winserver2012-ps/dnsclient/Get-DnsClientServerAddress.md deleted file mode 100644 index 4d7c528e11..0000000000 --- a/docset/winserver2012-ps/dnsclient/Get-DnsClientServerAddress.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: MSFT_DnsClientServerAddress.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/get-dnsclientserveraddress?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsClientServerAddress - -## SYNOPSIS -Gets DNS server IP addresses from the TCP/IP properties on an interface. - -## SYNTAX - -``` -Get-DnsClientServerAddress [-InterfaceIndex ] [[-InterfaceAlias] ] - [-AddressFamily ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-DnsClientServerAddress** cmdlet gets one or more DNS server IP addresses associated with the interfaces on the computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-DnsClientServerAddress -``` - -This example gets the DNS server IP addresses configured on all the interfaces on a computer. - -### EXAMPLE 2 -``` -PS C:\>Get-DnsClientServerAddress -InterfaceAlias "Wired Ethernet Connection" -``` - -This example gets the DNS server IP addresses configured on the interface named Wired Ethernet Connection. - -## PARAMETERS - -### -AddressFamily -Specifies the address family. -The acceptable values for this parameter are: IPv4 or IPv6. - -```yaml -Type: AddressFamily[] -Parameter Sets: (All) -Aliases: Family -Accepted values: IPv4, IPv6 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies the friendly name of the interface. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceIndex -Specifies the index number of the interface. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddress -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Set-DnsClientServerAddress](./Set-DnsClientServerAddress.md) - diff --git a/docset/winserver2012-ps/dnsclient/Register-DnsClient.md b/docset/winserver2012-ps/dnsclient/Register-DnsClient.md deleted file mode 100644 index bb5dc84a14..0000000000 --- a/docset/winserver2012-ps/dnsclient/Register-DnsClient.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: MSFT_DnsClient.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/register-dnsclient?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Register-DnsClient - -## SYNOPSIS -Registers all of the IP addresses on the computer onto the configured DNS server. - -## SYNTAX - -``` -Register-DnsClient [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Register-DnsClient** cmdlet invokes a dynamic update of the DNS names associated with the computer. -This cmdlet is global and cannot be invoked on a per-interface basis. -Running this cmdlet is equivalent to running `ipconfig /registerdns`. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Register-DnsClient -``` - -This example performs a DNS dynamic update on all of the interfaces configured on the computer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-DnsClient](./Get-DnsClient.md) - -[Set-DnsClient](./Set-DnsClient.md) - diff --git a/docset/winserver2012-ps/dnsclient/Remove-DnsClientNrptRule.md b/docset/winserver2012-ps/dnsclient/Remove-DnsClientNrptRule.md deleted file mode 100644 index 89ba4b50fa..0000000000 --- a/docset/winserver2012-ps/dnsclient/Remove-DnsClientNrptRule.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: PS_DnsClientNRPTRule_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/remove-dnsclientnrptrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsClientNrptRule - -## SYNOPSIS -Removes the specified DNS client Name Resolution Policy Table (NRPT) rule. - -## SYNTAX - -``` -Remove-DnsClientNrptRule [-GpoName ] [-Name] [-PassThru] [-Server ] [-Force] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Remove-DnsClientNrptRule** cmdlet removes the specified DNS client Name Resolution Policy Table (NRPT) rule. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-DnsClientNrptRule -GpoName TestGPO -Name "{1326d9d0-4fb5-4fed-9f67-f53637b85010}" -PassThru -Server host1.com -Force -``` - -This example removes the NRPT rule named {1326d9d0-4fb5-4fed-9f67-f53637b85010} on the server named host1.com. - -### EXAMPLE 2 -``` -PS C:\>Remove-DnsClientNrptRule -Name "DA-{274D94E4-E38B-4997-BA9F-84700712C09E}" -PassThru - -Confirm -Removing NRPT rule for the namespace nls.corp.contoso.com with - DAEnable: Enable, - DnsSecValidationRequired: Disabled, - NameEncoding: Disable - NameServers: No - Do you want to continue? -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y - -Name : DA-{274D94E4-E38B-4997-BA9F-84700712C09E} -Version : 1 -Namespace : {nls.corp.contoso.com} -IPsecCARestriction : -DirectAccessDnsServers : -DirectAccessEnabled : True -DirectAccessProxyType : UseDefault -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Disable -DisplayName : -Comment : - - -This version of the cmdlet performs the task without user confirmation. -PS C:\>Remove-DnsClientNrptRule -Name "DA-{274D94E4-E38B-4997-BA9F-84700712C09E}" -PassThru -Force - -Name : DA-{274D94E4-E38B-4997-BA9F-84700712C09E} -Version : 1 -Namespace : {nls.corp.contoso.com} -IPsecCARestriction : -DirectAccessDnsServers : -DirectAccessEnabled : True -DirectAccessProxyType : UseDefault -DirectAccessProxyName : -DirectAccessQueryIPsecEncryption : -DirectAccessQueryIPsecRequired : False -NameServers : -DnsSecEnabled : False -DnsSecQueryIPsecEncryption : -DnsSecQueryIPsecRequired : -DnsSecValidationRequired : -NameEncoding : Disable -DisplayName : -Comment : -``` - -This example removes the NRPT rule named {1326d9d0-4fb5-4fed-9f67-f53637b85010}. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GpoName -Specifies the name of the Group Policy Object (GPO). - - -- If this parameter and the **Server** parameter are specified, then the NRPT rule is added in the GPO of domain. -The **Server** parameter specifies the domain controller (DC). - - -- If neither this parameter nor the **Server** parameter is specified, then the NRPT rule is added for local client computer. - - -- If this parameter is specified and the **Server** parameter is not specified, then the DC of the domain specified by this parameter value is found and NRPT rule is added to the GPO. - - -- If this parameter is not specified and the **Server** parameter is specified, then an error is displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name which uniquely identifies a rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the server containing the GPO. -This parameter is only applicable with the **GpoName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptRule object contains all of the properties of the DNS client NRPT rule. - -## NOTES - -## RELATED LINKS - -[Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) - -[Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) - -[Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) - -[Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) - diff --git a/docset/winserver2012-ps/dnsclient/Resolve-DnsName.md b/docset/winserver2012-ps/dnsclient/Resolve-DnsName.md deleted file mode 100644 index e051295985..0000000000 --- a/docset/winserver2012-ps/dnsclient/Resolve-DnsName.md +++ /dev/null @@ -1,391 +0,0 @@ ---- -external help file: dnslookup.dll-Help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/resolve-dnsname?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resolve-DnsName - -## SYNOPSIS -Performs a DNS name query resolution for the specified name. - -## SYNTAX - -``` -Resolve-DnsName [-Name] [[-Type] ] [-Server ] [-DnsOnly] [-CacheOnly] - [-DnssecOk] [-DnssecCd] [-NoHostsFile] [-LlmnrNetbiosOnly] [-LlmnrFallback] [-LlmnrOnly] [-NetbiosFallback] - [-NoIdn] [-NoRecursion] [-QuickTimeout] [-TcpOnly] [] -``` - -## DESCRIPTION -The **Resolve-DnsName** cmdlet performs a DNS query for the specified name. -This cmdlet is functionally similar to the nslookup tool which allows users to query for names. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Resolve-DnsName -Name www.bing.com -``` - -This example resolves a name using the default options. - -### EXAMPLE 2 -``` -PS C:\>Resolve-DnsName -Name www.bing.com -Server 10.0.0.1 -``` - -This example resolves a name against the DNS server at 10.0.0.1. - -### EXAMPLE 3 -``` -PS C:\>Resolve-DnsName -Name www.bing.com -Type A -``` - -This example queries for A type records for name www.bing.com. - -### EXAMPLE 4 -``` -PS C:\>Resolve-DnsName -Name www.bing.com -DnsOnly -``` - -This example resolves a name using only DNS. -LLMNR and NetBIOS queries are not issued. - -## PARAMETERS - -### -CacheOnly -Resolves this query using only the local cache. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsOnly -Resolves this query using only the DNS protocol. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnssecCd -Sets the DNSSEC checking-disabled bit for this query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnssecOk -Sets the DNSSEC OK bit for this query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LlmnrFallback -Allows falling back to the LLMNR protocol when resolving this query with DNS fails. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LlmnrNetbiosOnly -Resolves this query using only the LLMNR or NetBIOS protocols. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LlmnrOnly -Resolves this query using only the LLMNR protocol. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name to be resolved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -NetbiosFallback -Allows fallback to the NetBIOS protocol when resolving this query with DNS fails. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoHostsFile -Skips the hosts file when resolving this query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoIdn -Specifies not to use IDN encoding logic for the query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRecursion -Instructs the server not to use recursion when resolving this query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuickTimeout -Uses shorter timeouts for this query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the IP addresses or host names of the DNS servers to be queried. -By default the interface DNS servers are queried if this parameter is not supplied. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpOnly -Uses only TCP for this query. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the DNS query type that is to be issued. -By default the type is A_AAAA, the A and AAAA types will both be queried. -The acceptable values for this parameter are: - - -- UNKNOWN = 0, - - -- A_AAAA = 0, the DNS query type is A_AAAA. - - -- A = 1, the DNS query type is IPv4 server Address. - - -- AAAA = 28, the DNS query type is IPv6 server address. - - -- NS = 2, the DNS query type is name server. - - -- MX = 15, the DNS query type is mail routing information. - - -- MD = 3, the DNS query type is mail destination. - - -- MF = 4, the DNS query type is mail forwarder. - - -- CNAME = 5, the DNS query type is canonical name. - - -- SOA = 6, the DNS query type is start of authority zone. - - -- MB = 7, the DNS query type is mailbox domain name. - - -- MG = 8, the DNS query type is mail group member. - - -- MR = 9, the DNS query type is mail rename name. - - -- NULL = 10, the DNS query type is null resource record. - - -- WKS = 11, the DNS query type is well known service. - - -- PTR = 12, the DNS query type is domain name pointer. - - -- HINFO = 13, the DNS query type is host information. - - -- MINFO = 14, the DNS query type is mailbox information. - - -- TXT = 16, the DNS query type is text strings. - - -- RP = 17, the DNS query type is responsible person. - - -- AFSDB = 18, the DNS query type is AFS database servers. - - -- X25 = 19, the DNS query type is packet switched wide area network. - - -- ISDN = 20, the DNS query type is Integrated Services Digital Network. - - -- RT = 21, the DNS query type is DNS route through. - - -- SRV = 33, the DNS query type is server selection. - - -- DNAME = 39, the DNS query type is domain aliases. - - -- OPT = 41, the DNS query type is DNS option. - - -- DS = 43, the DNS query type is delegation signer. - - -- RRSIG = 46, the DNS query type is DNSSEC signature. - - -- NSEC = 47, the DNS query type is next-secure record. - - -- DNSKEY = 48, the DNS query type is DNS key record. - - -- DHCID = 49, the DNS query type is Dynamic Host Configuration Protocol information. - - -- NSEC3 = 50, the DNS query type is NSEC record version 3. - - -- NSEC3PARAM = 51, the DNS query type is NSEC3 parameters. - - -- ANY = 255, the DNS query type is wildcard match. - - -- ALL = 255, the DNS query type is wildcard match. - -```yaml -Type: RecordType -Parameter Sets: (All) -Aliases: -Accepted values: UNKNOWN, A_AAAA, A, NS, MD, MF, CNAME, SOA, MB, MG, MR, NULL, WKS, PTR, HINFO, MINFO, MX, TXT, RP, AFSDB, X25, ISDN, RT, AAAA, SRV, DNAME, OPT, DS, RRSIG, NSEC, DNSKEY, DHCID, NSEC3, NSEC3PARAM, ANY, ALL, WINS - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.DnsClient.Commands.DnsRecord -The DnsRecord object contains all of the records returned from the wire for the specified DNS query. - -## NOTES - -## RELATED LINKS - -[Nslookup on TechNet](https://go.microsoft.com/fwlink/p/?LinkId=84907) - diff --git a/docset/winserver2012-ps/dnsclient/Set-DnsClient.md b/docset/winserver2012-ps/dnsclient/Set-DnsClient.md deleted file mode 100644 index 3fc56bfccb..0000000000 --- a/docset/winserver2012-ps/dnsclient/Set-DnsClient.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: MSFT_DnsClient.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/set-dnsclient?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsClient - -## SYNOPSIS -Sets the interface specific DNS client configurations on the computer. - -## SYNTAX - -### ByAlias (Default) -```powershell -Set-DnsClient [-InterfaceAlias] [-ConnectionSpecificSuffix ] - [-RegisterThisConnectionsAddress ] [-UseSuffixWhenRegistering ] - [-ResetConnectionSpecificSuffix] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### ByName -```powershell -Set-DnsClient -InterfaceIndex [-ConnectionSpecificSuffix ] - [-RegisterThisConnectionsAddress ] [-UseSuffixWhenRegistering ] - [-ResetConnectionSpecificSuffix] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -```powershell -Set-DnsClient -InputObject [-ConnectionSpecificSuffix ] - [-RegisterThisConnectionsAddress ] [-UseSuffixWhenRegistering ] - [-ResetConnectionSpecificSuffix] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] - [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DnsClient** cmdlet sets the interface specific DNS client configurations on the computer. - -## EXAMPLES - -### Example 1: Set the connection-specific suffix -```powershell -PS C:\> Set-DnsClient -InterfaceIndex 12 -ConnectionSpecificSuffix "corp.contoso.com" -``` - -This example sets the connection-specific suffix on an interface with index 12. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionSpecificSuffix -Specifies the connection-specific suffixes that are to be appended. -This parameter is a per-connection DNS suffix which will be appended to the computer name to construct a Fully Qualified Domain Name (FQDN). -This FQDN will be used as the host name for name resolution by the DNS client. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Suffix - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies the friendly name of the interface. - -```yaml -Type: String[] -Parameter Sets: ByAlias -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceIndex -Specifies the index number of the interface. - -```yaml -Type: UInt32[] -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegisterThisConnectionsAddress -Specifies that the IP address for this connection is to be registered. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetConnectionSpecificSuffix -Resets the connection-specific suffix to the default value. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ResetSuffix - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseSuffixWhenRegistering -Specifies that this host name and the connection specific suffix for this connection are to be registered. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddress -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-DnsClient](./Get-DnsClient.md) - -[Register-DnsClient](./Register-DnsClient.md) diff --git a/docset/winserver2012-ps/dnsclient/Set-DnsClientGlobalSetting.md b/docset/winserver2012-ps/dnsclient/Set-DnsClientGlobalSetting.md deleted file mode 100644 index 7229a08388..0000000000 --- a/docset/winserver2012-ps/dnsclient/Set-DnsClientGlobalSetting.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: MSFT_DnsClientGlobalSetting.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/set-dnsclientglobalsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsClientGlobalSetting - -## SYNOPSIS -Sets the DNS client global, non-interface specific, settings. - -## SYNTAX - -### ByName (Default) -``` -Set-DnsClientGlobalSetting [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Set-DnsClientGlobalSetting [-InputObject ] [-SuffixSearchList ] - [-UseDevolution ] [-DevolutionLevel ] [-CimSession ] [-ThrottleLimit ] - [-AsJob] [-PassThru] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DnsClientGlobalSettings** cmdlet sets the global DNS client settings that are global, that are not associated with a specific interface. -These settings affect the behavior of the DNS client across all interfaces. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DnsClientGlobalSetting -SuffixSearchList @("corp.contoso.com", "na.corp.contoso.com") -``` - -This example sets the DNS suffix search list on the computer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: InputObject (cdxml) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DevolutionLevel -Specifies the number of labels up to which devolution should occur. -If this parameter is not specified, then the FRD algorithm is used. -If this parameter is configured, then devolution occurs until the specified level. -This parameter value cannot be set if the devolution level setting is already deployed through Group Policy. - -```yaml -Type: UInt32 -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SuffixSearchList -Specifies a list of global suffixes that can be used in the specified order by the DNS client for resolving the IP address of the computer name. -These suffixes are appended in the specified order to resolve the computer name that is specified. -This parameter value cannot be set if the suffix search list setting is already deployed through Group Policy. - -```yaml -Type: String[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseDevolution -Specifies that devolution is activated. -With devolution, the DNS resolver creates new FQDNs by appending the single-label, unqualified domain name with the parent suffix of the primary DNS suffix name, and the parent of that suffix, and so on, stopping if the name is successfully resolved or at a level specified in the **DevolutionLevel** parameter. -Devolution works by removing the left-most label and continuing to get to the parent suffix. -The default value is True. -This parameter value cannot be set if the devolution level setting is already deployed through Group Policy. - -```yaml -Type: Boolean -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientGlobalSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientGlobalSetting -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_DNSClientGlobalSetting class has the various global settings for the DNS client. -Global settings include non-interface specific settings. - -## NOTES - -## RELATED LINKS - -[Get-DnsClientGlobalSetting](./Get-DnsClientGlobalSetting.md) - diff --git a/docset/winserver2012-ps/dnsclient/Set-DnsClientNrptGlobal.md b/docset/winserver2012-ps/dnsclient/Set-DnsClientNrptGlobal.md deleted file mode 100644 index 7b033011eb..0000000000 --- a/docset/winserver2012-ps/dnsclient/Set-DnsClientNrptGlobal.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: PS_DnsClientNRPTGlobal_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/set-dnsclientnrptglobal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsClientNrptGlobal - -## SYNOPSIS -Modifies the global Name Resolution Policy Table (NRPT) settings. - -## SYNTAX - -``` -Set-DnsClientNrptGlobal [-EnableDAForAllNetworks ] [-GpoName ] - [-SecureNameQueryFallback ] [-QueryPolicy ] [-Server ] [-PassThru] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DnsClientNrptGlobal** cmdlet modifies the following global Name Resolution Policy Table (NRPT) settings: - - -- DNS client enable Direct Access (DA) for all networks setting. - - -- DNS client query policy. - - -- DNS client secure name query fallback setting. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DnsClientNrptGlobal -EnableDAForAllNetworks disable -PassThru -EnableDAForAllNetworks QueryPolicy SecureNameQueryFallback ----------------------- ----------- ----------------------- -Disable Disable Disable -``` - -This example modifies the EnableDAForAllNetworks settings in the NPRT globally. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableDAForAllNetworks -Specifies DirectAccess (DA) settings. -The acceptable values for this parameter are: EnableOnNetworkID, EnableAlways, Disable, or DisableDA. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: EnableOnNetworkID, EnableAlways, Disable, DisableDA - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GpoName -Specifies the name of the Group Policy Object (GPO). -If this parameter is not specified, then the local NRPT settings are retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueryPolicy -Specifies the DNS client query policy. -The acceptable values for this parameter are: Disable, QueryIPv6Only, or QueryBoth. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Disable, QueryIPv6Only, QueryBoth - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecureNameQueryFallback -Specifies the DNS client name resolution fallback policy. -The acceptable values for this parameter are: Disable, FallbackSecure, FallbackUnsecure, or FallbackPrivate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Disable, FallbackSecure, FallbackUnsecure, FallbackPrivate - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the server hosting the GPO. -This parameter is only applicable with the **GpoName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptGlobal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptGlobal object contains all of the properties of the DNS client NRPT global settings. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptGlobal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptGlobal object contains all of the properties of the DNS client NRPT global settings. - -## NOTES - -## RELATED LINKS - -[Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) - -[Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) - -[Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) - -[Set-DnsClientNrptRule](./Set-DnsClientNrptRule.md) - diff --git a/docset/winserver2012-ps/dnsclient/Set-DnsClientNrptRule.md b/docset/winserver2012-ps/dnsclient/Set-DnsClientNrptRule.md deleted file mode 100644 index 3cd6cd6fce..0000000000 --- a/docset/winserver2012-ps/dnsclient/Set-DnsClientNrptRule.md +++ /dev/null @@ -1,474 +0,0 @@ ---- -external help file: PS_DnsClientNRPTRule_v1.0.0.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/set-dnsclientnrptrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsClientNrptRule - -## SYNOPSIS -Modifies a DNS client Name Resolution Policy Table (NRPT) rule for the specified namespace. - -## SYNTAX - -``` -Set-DnsClientNrptRule [-DAEnable ] [-DAIPsecEncryptionType ] [-DAIPsecRequired ] - [-DANameServers ] [-DAProxyServerName ] [-DAProxyType ] [-Comment ] - [-DnsSecEnable ] [-DnsSecIPsecEncryptionType ] [-DnsSecIPsecRequired ] - [-DnsSecValidationRequired ] [-GpoName ] [-IPsecTrustAuthority ] [-Name] - [-NameEncoding ] [-NameServers ] [-Namespace ] [-Server ] - [-DisplayName ] [-PassThru] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DnsClientNrptRule** cmdlet modifies the specified DNS client Name Resolution Policy Table (NRPT) rule. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DnsClientNrptRule -DAEnable $true -DAIPsecEncryptionType "High" -DAIPsecRequired $true -DANameServers 10.0.0.1 -DAProxyServerName "DaServer.com:6666" -DAProxyType "UseProxyName" -DisplayName "Sample" -PassThru -IPsecTrustAuthority "RootCA" -Name "{1326d9d0-4fb5-4fed-9f67-f53637b85010}" -NameEncoding "Punycode" -NameServers 10.0.0.1 -Namespace "dnsnrpt.com" -Server host1.com -Comment "Sample NRPT Rule" -DnsSecEnable $true -DnsSecIPsecEncryptionType "Medium" -DnsSecIPsecRequired $true -DnsSecValidationRequired $true -GpoName TestGPO -``` - -This example modifies an NRPT rule for GPO named TestGPO on the server named host1.com for namespace dnsnrpt.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -Stores administrator comments. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DAEnable -Specifies the rule state for DirectAccess (DA). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: DirectAccessEnabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAIPsecEncryptionType -Specifies the IPsec encryption type for DA. -The acceptable values for this parameter are: None, Low, Medium, or High. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DirectAccessQueryIPSSECEncryption -Accepted values: , None, Low, Medium, High - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAIPsecRequired -Specifies the IPsec tunnel encryption settings. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: DirectAccessQueryIPsecRequired - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DANameServers -Specifies the DNS servers which will be queried when DA is enabled. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: DirectAccessDNSServers - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAProxyServerName -Specifies the proxy server to be used when connecting to the Internet. - -This parameter is only applicable when the **DAProxyType** parameter is set to UseProxyName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DirectAccessProxyName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DAProxyType -Specifies the proxy server type to be used when connecting to the Internet. -The acceptable values for this parameter are: NoProxy, UseDefault, or UseProxyName. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DirectAccessProxyType -Accepted values: , NoProxy, UseDefault, UseProxyName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies an optional friendly name for the NRPT rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecEnable -Specifies that DNSSEC is enabled on the rule. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: DnsSecEnabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecIPsecEncryptionType -Specifies the IPsec tunnel encryption settings. -The acceptable values for this parameter are: None, Low, Medium, or High. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DnsSecQueryIPsecEncryption -Accepted values: , None, Low, Medium, High - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecIPsecRequired -Specifies that the DNS client must set up an IPsec connection to the DNS server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: DnsSecQueryIPsecRequired - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsSecValidationRequired -Specifies that DNSSEC validation is required. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GpoName -Specifies the name of the Group Policy Object (GPO). - - -- If this parameter and the **Server** parameter are specified, then the NRPT rule is added in the GPO of domain. -The **Server** parameter specifies the domain controller (DC). - - -- If neither this parameter nor the **Server** parameter is specified, then the NRPT rule is added for local client computer. - - -- If this parameter is specified and the **Server** parameter is not specified, then the DC of the domain specified by this parameter value is found and NRPT rule is added to the GPO. - - -- If this parameter is not specified and the **Server** parameter is specified, then an error is displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPsecTrustAuthority -Specifies the Certification Authority (CA) to validate the IPsec channel for DA. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: IPsecCARestriction - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name which uniquely identifies a rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameEncoding -Specifies the encoding format for host names in the DNS query. -The acceptable values for this parameter are: Disable, Utf8WithMapping, Utf8WithoutMapping, or Punycode. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Accepted values: Disable, Utf8WithMapping, Utf8WithoutMapping, Punycode - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServers -Specifies the DNS servers to which the DNS query is sent when DA is disabled. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Namespace -Specifies the DNS namespace. -The acceptable values for this parameter are: Suffix, Prefix, FQDN, Subnet, or Any. -If this parameter is set to Any, then the parameter value must be specified in dot-notation. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the server hosting the GPO. -This parameter is only applicable with the **GpoName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DnsClientNrptRule -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The DnsClientNrptRule object contains all of the properties of the DNS client NRPT rule. - -## NOTES - -## RELATED LINKS - -[Add-DnsClientNrptRule](./Add-DnsClientNrptRule.md) - -[Get-DnsClientNrptGlobal](./Get-DnsClientNrptGlobal.md) - -[Get-DnsClientNrptPolicy](./Get-DnsClientNrptPolicy.md) - -[Get-DnsClientNrptRule](./Get-DnsClientNrptRule.md) - -[Remove-DnsClientNrptRule](./Remove-DnsClientNrptRule.md) - -[Set-DnsClientNrptGlobal](./Set-DnsClientNrptGlobal.md) - diff --git a/docset/winserver2012-ps/dnsclient/Set-DnsClientServerAddress.md b/docset/winserver2012-ps/dnsclient/Set-DnsClientServerAddress.md deleted file mode 100644 index 17c9d7484a..0000000000 --- a/docset/winserver2012-ps/dnsclient/Set-DnsClientServerAddress.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: MSFT_DnsClientServerAddress.cdxml-help.xml -Module Name: DnsClient -online version: https://learn.microsoft.com/powershell/module/dnsclient/set-dnsclientserveraddress?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsClientServerAddress - -## SYNOPSIS -Sets DNS server addresses associated with the TCP/IP properties on an interface. - -## SYNTAX - -### ByAlias (Default) -``` -Set-DnsClientServerAddress [-InterfaceAlias] [-ServerAddresses ] [-Validate] - [-ResetServerAddresses] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### ByName -``` -Set-DnsClientServerAddress -InterfaceIndex [-ServerAddresses ] [-Validate] - [-ResetServerAddresses] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -### InputObject (cdxml) -``` -Set-DnsClientServerAddress -InputObject [-ServerAddresses ] [-Validate] - [-ResetServerAddresses] [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] - [-Confirm] [] -``` - -## DESCRIPTION -The **Set-DnsClientServerAddress** cmdlet sets one or more IP addresses for DNS servers associated with an interface. -This cmdlet statically adds DNS server addresses to the interface. -If this cmdlet is used to add DNS servers to the interface, then the DNS servers will override any DHCP configuration for that interface. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-DnsClientServerAddress -InterfaceIndex 12 -ServerAddresses ("10.0.0.1","10.0.0.2") -``` - -This example sets the DNS server addresses on a specified interface with the index value of 12. - -### EXAMPLE 2 -``` -PS C:\>Set-DnsClientServerAddress -InterfaceIndex 12 -ResetServerAddresses -``` - -This example resets the DNS client to use the default DNS server addresses specified by DHCP on the interface with an index value of 12. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies the friendly name of the interface. - -```yaml -Type: String[] -Parameter Sets: ByAlias -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceIndex -Specifies the index number of the interface. - -```yaml -Type: UInt32[] -Parameter Sets: ByName -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResetServerAddresses -Resets the DNS server IP addresses to the default value. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: ResetAddresses - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerAddresses -Specifies a list of DNS server IP addresses to set for the interface. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: Addresses - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Validate -Validates that one or more IP addresses are responsive DNS servers before the IP addresses are set to the interface. -This parameter must be used with the **ServerAddress** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClient -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddresses -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetIPInterface -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_DNSClientServerAddress -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_DNSClientServerAddress class has the various DNS server IP addresses configured on a given interface. -If no interface is specified, then all interfaces are configured. - -## NOTES - -## RELATED LINKS - -[Get-DnsClientServerAddress](./Get-DnsClientServerAddress.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerConditionalForwarderZone.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerConditionalForwarderZone.md deleted file mode 100644 index 49230ede93..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerConditionalForwarderZone.md +++ /dev/null @@ -1,318 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverconditionalforwarderzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerConditionalForwarderZone - -## SYNOPSIS -Adds a conditional forwarder to a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerConditionalForwarderZone [-Name] [-MasterServers] - [[-ForwarderTimeout] ] [-AsJob] [-CimSession ] [-ComputerName ] [-LoadExisting] - [-PassThru] [-ThrottleLimit ] [-UseRecursion] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerConditionalForwarderZone [-Name] [-MasterServers] - [[-ForwarderTimeout] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-DirectoryPartitionName ] [-LoadExisting] [-PassThru] [-ReplicationScope ] - [-ThrottleLimit ] [-UseRecursion] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerConditionalForwarderZone** cmdlet adds a conditional forwarder to a Domain Name System (DNS) server. -You can select the master servers, forwarder time-out, recursion, host computer, replication scope, and directory partition for the conditional forwarder. -Conditional forwarders are stored as zones on a DNS server. - -## EXAMPLES - -### Example 1: Create file a backednon-Active Directory-integrated forwarder zonea non-Active Directory-integrated -``` -PS C:\> Add-DnsServerConditionalForwarderZone -Name "contoso.com" -MasterServers 2001:4898:7020:f100:458f:e6a2:fcaf:698c,172.23.90.124 -PassThru -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -contoso.com Forwarder False False False -``` - -This command creates a conditional forwarder zone called contoso.com. -The entries are stored in the registry. -The command includes IP addresses for one or more master DNS servers. -The command uses the **-passthru** parameter. - -### Example 2: Create an Active Directory- AD integrated forwarder zonean Active Directory- -``` -PS C:\>Add-DnsServerConditionalForwarderZone -Name "contoso.com" -ReplicationScope "Forest" -MasterServers 2001:4898:7020:f100:458f:e6a2:fcaf:698c,172.23.90.124 -``` - -This command creates an Active Directory-integrated conditional forwarder zone for contoso.com. -The command specifies IP addresses for one or more master DNS servers. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the DNS server. -The cmdlet adds the forwarder to this server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the forwarder. -Conditional forwarders are internally stored as zones. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForwarderTimeout -Specifies a length of time, in seconds, that a DNS server waits for a master server to resolve a query. -If a server does not resolve the request, the next server in the list is queried until all master servers are queried. -After this period, the DNS server can attempt to resolve the query itself. -This parameter applies only to the forwarder zone. -The minimum value is 0. -The maximum value is 15. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadExisting -Indicates that the server loads existing data for the forwarder from the registry. -Conditional forwarders are internally stored as zones. -This parameter is not valid for Active Directory-integrated zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -DNS queries for a forwarded zone are sent to master servers. -You can use both IPv4 and IPv6 addresses. -You must specify at least one master server. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. -The cmdlet adds a conditional forwarder for this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies the replication scope for the conditional forwarder. -Conditional forwarders are stored internally as zones. -The acceptable values for this parameter are: - -- Custom. -Replicate the conditional forwarder to all DNS servers running on domain controllers enlisted in a custom directory partition. -- Domain. -Replicate the conditional forwarder to all DNS servers that run on domain controllers in the domain. -- Forest. -Replicate the conditional forwarder to all DNS servers that run on domain controllers in the forest. -- Legacy. -Replicate the conditional forwarder to all domain controllers in the domain. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseRecursion -Specifies whether a DNS server attempts to resolve a query after the forwarder fails to resolve it. -A value of $False prevents a DNS server from attempting resolution using other DNS servers. -This parameter overrides the Use Recursion setting for a DNS server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerConditionalForwarderZone - -## NOTES - -## RELATED LINKS - -[Set-DnsServerConditionalForwarderZone](./Set-DnsServerConditionalForwarderZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerDirectoryPartition.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerDirectoryPartition.md deleted file mode 100644 index b26c1a79e9..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerDirectoryPartition.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverdirectorypartition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerDirectoryPartition - -## SYNOPSIS -Creates a DNS application directory partition. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerDirectoryPartition [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerDirectoryPartition [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -Type [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerDirectoryPartition** cmdlet creates a Domain Name System (DNS) application directory partition. -After you install a DNS server, DNS creates an application directory partition for the service at the forest and domain levels. -This cmdlet creates additional DNS application directory partitions. - -You can store Domain Name System (DNS) zones in the domain or application directory partitions of Active Directory Domain Services (AD DS). -A partition is a data structure in AD DS that distinguishes data for different replication purposes. -When you create an application directory partition for DNS, you can control the scope of replication for the zone that is stored in that partition. - -## EXAMPLES - -### Example 1: Create a DNS application directory partition -``` -PS C:\> Add-DnsServerDirectoryPartition -Name "ADpart" -``` - -This command adds a new DNS application directory partition named ADpart to the local computer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new DNS application directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies a type of DNS application directory partition. -Valid values are: - -- /Domain -- /Forest -- /AllDomains - -To create a default domain-wide DNS application directory partition for the Active Directory domain where the specified DNS server is located, specify /Domain. - -To create a default forest-wide DNS application directory partition for the Active Directory forest where the specified DNS server is located, specify /Forest. - -The **ComputerName** parameter is ignored for an /AllDomains DNS application directory partition. -The computer from where you run this command must be joined to a domain in the forest where you want to create all of the default domain-wide application directory partitions. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -Class dnsDirectoryPartition - -{ - -boolean ApplicationDirectoryPartitions; //Specifies whether support for application directory partitions is enabled on the DNS Server. -string fqdn; // UTF-8 string that specifies the FQDN of the application directory partition. -string dpdn; // Unicode string that specifies the distinguished name for the application directory partition head object -string crDn; // Unicode string that specifies the distinguished name for the application directory partition crossRef object. -ulong flags; //application directory partition properties (see MS-DNSP for details) -ulong ZoneCount: //The number of zones from this application directory partition that are loaded in the DNS server's memory. -ulong state; //The current state of this application directory partition (see MS-DNSP for details) -ulong replicaCount; // The number of replication locations for the application directory partition -string replicaArray\[\]; //contains information about replication locations for this application directory partition -boolean DefaultDirectoryPartitions -string DirectoryPartition Scope -ComputerName servers\[\]; // servers enlisted in DNS Application Directory Partition - -} - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDirectoryPartition - -## NOTES - -## RELATED LINKS - -[Get-DnsServerDirectoryPartition](./Get-DnsServerDirectoryPartition.md) - -[Register-DnsServerDirectoryPartition](./Register-DnsServerDirectoryPartition.md) - -[Unregister-DnsServerDirectoryPartition](./Unregister-DnsServerDirectoryPartition.md) - -[Remove-DnsServerDirectoryPartition](./Remove-DnsServerDirectoryPartition.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerForwarder.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerForwarder.md deleted file mode 100644 index 829acc7d0b..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerForwarder.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverforwarder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerForwarder - -## SYNOPSIS -Adds server level forwarders to a DNS server. - -## SYNTAX - -``` -Add-DnsServerForwarder [-IPAddress] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerForwarder** cmdlet adds one or more forwarders to a DNS server's forwarders list. -If you prefer one of the forwarders, put that forwarder first in the series of forwarder IP addresses. -After you first use this cmdlet to add forwarders to a DNS server, this cmdlet adds forwarders to the end of the forwarders list. - -## EXAMPLES - -### Example 1: Add a forwarder to a DNS server by using an IPv6 address -``` -PS C:\> Add-DnsServerForwarder -IPAddress 2001:4898:7020:f100:458f:e6a2:fcaf:698c -PassThru -``` - -This command adds the IPv6 address 2001:4898:7020:f100:458f:e6a2:fcaf:698c to the list of forwarders on a local DNS server. - -### Example 2: Add a forwarder to a DNS server by using an IPAddress -``` -PS C:\>Add-DnsServerForwarder -IPAddress 172.23.90.124 -PassThru -``` - -This command adds the IP address 172.23.90.124 to the list of forwarders on a local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IP addresses of DNS servers where queries are forwarded. -If you prefer one of the forwarders, put that forwarder first in the series of forwarder IP addresses. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerForwarder - -## NOTES - -## RELATED LINKS - -[Set-DnsServerForwarder](./Set-DnsServerForwarder.md) - -[Remove-DnsServerForwarder](./Remove-DnsServerForwarder.md) - -[Get-DnsServerForwarder](./Get-DnsServerForwarder.md) - -[Add-DnsServerConditionalForwarderZone](./Add-DnsServerConditionalForwarderZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerPrimaryZone.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerPrimaryZone.md deleted file mode 100644 index 1638b15ec1..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerPrimaryZone.md +++ /dev/null @@ -1,373 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverprimaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerPrimaryZone - -## SYNOPSIS -Adds a primary zone to a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerPrimaryZone [-Name] [-ReplicationScope] [[-DirectoryPartitionName] ] - [-AsJob] [-CimSession ] [-ComputerName ] [-DynamicUpdate ] [-LoadExisting] - [-PassThru] [-ResponsiblePerson ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerPrimaryZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-DynamicUpdate ] [-LoadExisting] [-PassThru] [-ResponsiblePerson ] [-ThrottleLimit ] - -ZoneFile [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-DnsServerPrimaryZone [-ReplicationScope] [[-DirectoryPartitionName] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-DynamicUpdate ] [-LoadExisting] [-PassThru] - [-ResponsiblePerson ] [-ThrottleLimit ] -NetworkId [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-DnsServerPrimaryZone [-AsJob] [-CimSession ] [-ComputerName ] - [-DynamicUpdate ] [-LoadExisting] [-PassThru] [-ResponsiblePerson ] [-ThrottleLimit ] - -NetworkId -ZoneFile [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerPrimaryZone** cmdlet adds a specified primary zone on a Domain Name System (DNS) server. - -You can add an Active Directory-integrated forward lookup zone, an Active Directory-integrated reverse lookup zone, a file-backed forward lookup zone, or a file-backed reverse lookup zone. - -## EXAMPLES - -### Example 1: Create a primary zone -``` -PS C:\> Add-DnsServerPrimaryZone -Name "west01.contoso.com" -ReplicationScope "Forest" -PassThru -``` - -This command creates an Active Directory-integrated forward lookup zone called west01.contoso.com with Forest-wide replication scope. - -### Example 2: Create a file-backed primary zone -``` -PS C:\>Add-DnsServerPrimaryZone -Name "west02.contoso.com" -ZoneFile "west02.contoso.com.dns" -``` - -This command creates a file-backed primary forward lookup zone called west02.contoso.com with the specified DNS file. - -### Example 3: Create a reverse lookup zone -``` -PS C:\>Add-DnsServerPrimaryZone -NetworkID "10.1.0.0/24" -ReplicationScope "Forest" -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -1.10.in-addr.arpa Primary False True True False -``` - -This command creates the Active Directory-integrated class C reverse lookup zone 0.1.10.in-addr.arpa with Forest-wide replication scope. - -### Example 4: Create a file-backed reverse lookup zone -``` -PS C:\>Add-DnsServerPrimaryZone -NetworkID 10.3.0.0/24 -ZoneFile "0.3.10.in-addr.arpa.dns" -``` - -This command creates the file-backed reverse lookup zone 0.3.10.in-addr.arpa. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the zone. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DynamicUpdate -Specifies how a zone accepts dynamic updates. -The acceptable values for this parameter are: - -- None -- Secure -- NonsecureAndSecure - -Secure DNS updates are available only for Active Directory-integrated zones. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadExisting -Loads an existing file for the zone. -Otherwise, the cmdlet creates default zone records automatically. -This switch is relevant only for file-backed zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the zone the cmdlet creates. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkId -Specifies a network ID and prefix length for a reverse lookup zone. -Use the format A.B.C.D/prefix. - -The cmdlet creates only class A, B, C, or D zones. -If you specify a prefix that is between classes, the cmdlet uses the longer prefix divisible by 8. -For example, a value of 10.2.10.0/23 results in the 10.2.10.0/24 reverse lookup zone, not the 10.2.11.0/24 reverse lookup zone. -If you enter a prefix longer than /24, the cmdlet creates a /32 reverse lookup zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies a partition on which to store an Active Directory-integrated zone. -The acceptable values for this parameter are: - -- Custom. -Any custom directory partition that a user creates. -Specify a custom directory partition by using the **DirectoryPartitionName** parameter. -- Domain. -The domain directory partition. -- Forest. -The ForestDnsZone directory partition. -- Legacy. -A legacy directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResponsiblePerson -Specifies a person responsible for the zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies a name of the zone file. -This parameter is only relevant for file-backed zones. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerPrimaryZone - -## NOTES - -## RELATED LINKS - -[ConvertTo-DnsServerPrimaryZone](./ConvertTo-DnsServerPrimaryZone.md) - -[Restore-DnsServerPrimaryZone](./Restore-DnsServerPrimaryZone.md) - -[Set-DnsServerPrimaryZone](./Set-DnsServerPrimaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecord.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecord.md deleted file mode 100644 index e184ae7015..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecord.md +++ /dev/null @@ -1,1391 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecord?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecord - -## SYNOPSIS -Adds a resource record of a specified type to a specified DNS zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerResourceRecord [-ZoneName] [-AllowUpdateAny] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-A] [-AgeRecord] [-AllowUpdateAny] [-AsJob] - [-CimSession ] [-ComputerName ] [-CreatePtr] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -IPv4Address [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-AAAA] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-CreatePtr] [-PassThru] - [-ThrottleLimit ] [-TimeToLive ] -IPv6Address [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Atma] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -Address -AddressType [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Afsdb] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -ServerName -SubType [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Ptr] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -PtrDomainName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_7 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Txt] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -DescriptiveText [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_8 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Srv] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -DomainName -Port -Priority -Weight [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_9 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-RT] [-AgeRecord] [-AllowUpdateAny] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -IntermediateHost -Preference [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_10 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Wks] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -InternetAddress -InternetProtocol -Service - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_11 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-MX] [-AgeRecord] [-AllowUpdateAny] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -MailExchange -Preference [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_12 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-Isdn] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -IsdnNumber -IsdnSubAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_13 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-HInfo] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -Cpu -OperatingSystem [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_14 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-DName] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -DomainNameAlias [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_15 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-DhcId] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -DhcpIdentifier [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_16 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-CName] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -HostNameAlias [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_17 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-NS] [-AgeRecord] [-AllowUpdateAny] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -NameServer [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_18 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-X25] [-AgeRecord] [-AllowUpdateAny] - [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -PsdnAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_19 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Name] [-RP] [-AgeRecord] [-AllowUpdateAny] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] -Description -ResponsiblePerson [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_20 -``` -Add-DnsServerResourceRecord [-ZoneName] [-WinsR] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-Replicate] [-ThrottleLimit ] -CacheTimeout - -LookupTimeout -ResultDomain [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_21 -``` -Add-DnsServerResourceRecord [-ZoneName] [-Wins] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-Replicate] [-ThrottleLimit ] -CacheTimeout - -LookupTimeout -WinsServers [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecord** cmdlet adds a resource record for a Domain Name System (DNS) zone on a DNS server. -You can add different types of resource records. -Use different switches for different record types. -For more information about resource records, see [Managing Resource Records](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc754308(v=ws.11)). - -By using this cmdlet, you can change a value for a record, configure whether a record has a time stamp, whether any authenticated user can update a record with the same owner name, and change lookup timeout values, Windows Internet Name Service (WINS) cache settings, and replication settings. - -## EXAMPLES - -### Example 1: Add an A record -``` -PS C:\>Add-DnsServerResourceRecord -ZoneName "Contoso.com" -A -Name "Host34" -AllowUpdateAny -IPv4Address "10.17.1.34" -TimeToLive 01:00:00 -AgeRecord -``` - -This command adds an A record that is named Host34 in the zone contoso.com with the specified IP address. -The command uses the **AllowUpdateAny** switch to allow any authenticated user to update the record. -It specifies a TTL value and enables a time stamp for the record. - -### Example 2: Add an A resource record under the Admin noderesource -``` -PS C:\> Add-DnsServerResourceRecord -ZoneName "Contoso.com" -A -Name "Host21.admin" -IPv4Address "10.17.1.21" -VERBOSE: Adding DNS resource record host21.admin of type A in zone contoso.com on ROOT server. -VERBOSE: Adding DNS resource record host21.admin of type A in zone contoso.com on ROOT server. -HostName RecordType Timestamp TimeToLive RecordData - --------- ---------- --------- ---------- ---------- - -host21.admin A 0 01:00:00 10.17.1.74 -HostName RecordType Timestamp TimeToLive RecordData - --------- ---------- --------- ---------- ---------- - -host21.admin A 0 01:00:00 10.17.1.74 -``` - -This command adds an A record for Host21 under the Admin node of Contoso.com. - -### Example 3: Add an AAAA resource record resource -``` -PS C:\>Add-DnsServerResourceRecord -AAAA -Name "Host73" -ZoneName "Contoso.com" -AllowUpdateAny -IPv6Address "3ffe::1" -TimeToLive 01:00:00 -AgeRecord -``` - -This command adds an AAAA record. -The command specifies **AllowUpdateAny**, a TTL value, and enables a time stamp for the record. - -### Example 4: Add a CName CNAME resource recordCNAME -``` -PS C:\>Add-DnsServerResourceRecord -CName -Name "labhost34" -HostNameAlias "Host34.lab.contoso.com" -ZoneName "Contoso.com" -AllowUpdateAny -TimeToLive 01:00:00 -``` - -This command adds a CNAME resource record. -The command specifies **AllowUpdateAny** and a TTL value. - -### Example 5: Add a pointer PTR resource recordPTR resource -``` -PS C:\>Add-DnsServerResourceRecord -Name "77" -Ptr -ZoneName "0.168.192.in-addr.arpa" -AllowUpdateAny -PtrDomainName "host77.contoso.com" -``` - -This command adds a pointer record named host77.contoso.com for the IP address 192.168.0.77 to the reverse lookup zone 0.168.192.in-addr.arpa.. - -### Example 6: Add an MX resource record -``` -PS C:\>Add-DnsServerResourceRecord -Name ".-MX -ZoneName "contoso.com" -MailExchange "mail.contoso.com" -Preference 10 -``` - -This command adds an MX resource record for the contoso.com zone with a preference of 10. - -### Example 7: Add an SRV resource record -``` -PS C:\>Add-DnsServerResourceRecord -Srv -Name "sip" -ZoneName "contoso.com" -DomainName "sipserver1.contoso.com" -Priority 0 -Weight 0 -Port 5060 -``` - -This command adds a service locator (SRV) resource record for the _sip service on port 5060 with a weight and priority of 0 to the contoso.com domain. -The host that offers the service is sipserver1.contoso.com. - -### Example 8: Add a multiline TXT resource record -```powershell -$dkim2 = "v=DKIM1;k=rsa;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAy6OAXCmjYT823gq+DXRjXdsypt7iepfl4pkvLRVN8wRwoND2Fk2aVlG+CitAeJ0nqWn7JAPjoTXpFtHnOWMN7ay/atQd+DcLLHfJkpRvsYSDQ1jkI2s7CkWF6G+nwLGJcNFndOdB8oawpppyESE7+DiZae8bDicaTK8oPU0J7iogeZ1fgvmutwNtNzZHiSgwF9euCiX6lTmGe+0oZ+gRUJnUmZevh//IZ+NyDkRV2kPxQBtM8brHUpRL1c11q/CA0kC6C3ku+Pqmf6A8CGT+qvlCeQ2lVqlBydQL5UjiixUEwkSrgUEKoKE2Hqw97WrDEJZqngtuqma9hWoAsKVbzwIDAQAB" -$dkim2_part1 = $dkim2.Substring(0,252) - -$dkim2_part2 = $dkim2.Substring(252,$dkim2.Length - 252) - -Add-DnsServerResourceRecord -DescriptiveText "$dkim2_part1`r`n$dkim_part2" -Name sea2048._domainkey -Txt -ZoneName $domain -TimeToLive 0:1:0:0 -``` - -This command adds a multiline TXT resource record. The string is split into 252 character sets and the new line, which is two characters in Windows, is added at the end. - -## PARAMETERS - -### -A -Indicates that the record that this cmdlet adds to the DNS server is a host address (A) resource record. -An A resource record maps a host name to an IPv4 address. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AAAA -Indicates that the record that this cmdlet adds to the DNS server is an AAAA resource record. -An AAAA resource record maps a host name to an IPv6 address. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Address -Specifies a byte array that contains the asynchronous transfer mode (ATM) address of the owner to which this resource record object pertains. -The **AddressType** parameter specifies the format of the byte array. -The first 4 bytes of the array store the size of the octet string. -The most significant byte is byte 0. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddressType -Specifies the format of an ATM address in an ATM address (ATMA) resource record. -Valid values are: 0, for an ATM End System Address (AESA) format, and 1, for an E.164 address format. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Afsdb -Indicates that the record that this cmdlet adds to the DNS server is an Andrew File System cell database server (AFSDB) resource record. -An AFSDB resource record gives the location of the AFS cell database server and uses DNS to map a DNS domain name to the name of an AFS cell database server. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6, UNNAMED_PARAMETER_SET_7, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10, UNNAMED_PARAMETER_SET_11, UNNAMED_PARAMETER_SET_12, UNNAMED_PARAMETER_SET_13, UNNAMED_PARAMETER_SET_14, UNNAMED_PARAMETER_SET_15, UNNAMED_PARAMETER_SET_16, UNNAMED_PARAMETER_SET_17, UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_18 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdateAny -Indicates that any authenticated user can update a resource record that has the same owner name. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6, UNNAMED_PARAMETER_SET_7, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10, UNNAMED_PARAMETER_SET_11, UNNAMED_PARAMETER_SET_12, UNNAMED_PARAMETER_SET_13, UNNAMED_PARAMETER_SET_14, UNNAMED_PARAMETER_SET_15, UNNAMED_PARAMETER_SET_16, UNNAMED_PARAMETER_SET_17, UNNAMED_PARAMETER_SET_18, UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Atma -Indicates that the record that this cmdlet adds to the DNS server is an ATM address resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CacheTimeout -Specifies how long, in seconds, that a DNS server caches a response from a WINS server. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_20, UNNAMED_PARAMETER_SET_21 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CName -Indicates that the record that this cmdlet adds to the DNS server is a canonical name (CNAME) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_16 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cpu -Specifies the CPU type of a DNS server. -You can find the CPU type in a host information (HINFO) resource record. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_13 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreatePtr -Indicates that the DNS server automatically creates an associated pointer (PTR) resource record for an A or AAAA record. -A PTR resource record maps an IP address to a host name. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies text to describe the person or people that are responsible for the domain. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DescriptiveText -Specifies additional text to describe a resource record on a DNS server. It is limited to 254 characters per line. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DhcId -Indicates that the record that this cmdlet adds to the DNS server is a Dynamic Host Configuration Protocol Information (DHCID) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_15 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DhcpIdentifier -Specifies a public key that is associated with an FQDN, as described in section 3 of RFC 2535. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_15 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DName -Indicates that the record that this cmdlet adds to the DNS server is a domain alias (DNAME) resource record on a DNS server. -A DNAME resource record renames the root and all descendants in a domain namespace subtree and provides nonterminal domain name redirection. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_14 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the name of a domain. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DomainNameAlias -Specifies the alias for a domain name. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_14 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Adds a resource record without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_20, UNNAMED_PARAMETER_SET_21 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HInfo -Indicates that the record that this cmdlet adds to the DNS server is a host information (HINFO) resource record on a DNS server. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_13 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostNameAlias -Specifies a canonical name target for a CNAME record. -This must be a fully qualified domain name (FQDN). - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_16 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. -This parameter takes an object of type **DnsServerResourceRecord**. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IntermediateHost -Specifies the FQDN of a host that routes packets to a destination host. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_9 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InternetAddress -Specifies the IP address of the owner of a resource record. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_10 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InternetProtocol -Specifies the Internet Protocol (IP) for a resource record. -Valid values are: UDP or TCP. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_10 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv4Address -Specifies the IPv4 address of a host. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv6Address -Specifies the IPv6 address of a host. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Isdn -Indicates that the record that this cmdlet adds to the DNS server is an Integrated Services Digital Network (ISDN) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_12 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsdnNumber -Specifies the number in the ISDN address that maps to the FQDN of a DNS server. -An ISDN address, which consists of a phone number and an optional subaddress, is located in an ISDN resource record. -The phone number can contain a country/region code, an area code, and a local phone number. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_12 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsdnSubAddress -Specifies the number that is contained in an ISDN address that maps to the FQDN of a DNS server. -An ISDN address consists of a phone number and an optional subaddress and is located in an ISDN resource record. -The subaddress is an identifier that describes the ISDN subaddress encoding type. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_12 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LookupTimeout -Specifies the lookup time-out value for a resource record. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_20, UNNAMED_PARAMETER_SET_21 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailExchange -Specifies the FQDN of the host that is acting as a mail exchanger for the owner. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_11 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MX -Indicates that the record that this cmdlet adds to the DNS server is a mail exchanger (MX) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_11 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a DNS server resource record object. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6, UNNAMED_PARAMETER_SET_7, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10, UNNAMED_PARAMETER_SET_11, UNNAMED_PARAMETER_SET_12, UNNAMED_PARAMETER_SET_13, UNNAMED_PARAMETER_SET_14, UNNAMED_PARAMETER_SET_15, UNNAMED_PARAMETER_SET_16, UNNAMED_PARAMETER_SET_17, UNNAMED_PARAMETER_SET_18, UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServer -Specifies the name server of a domain. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_17 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NS -Indicates that the record that this cmdlet adds to the DNS server is a Name Server (NS) resource record on a DNS server. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_17 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperatingSystem -Specifies the operating system identifier of a DNS server. -You can find the operating system identifier in a HINFO resource record. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_13 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port where the server listens for the service. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Preference -Specifies the priority for this resource record among other resource records that belong to the same owner, where a lower value has a higher priority. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_11 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of a DNS server. -Clients try to contact the server that has the lowest priority. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PsdnAddress -Specifies the public switched data network (PSDN) address of the owner of a resource record. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_18 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Ptr -Indicates that the record that this cmdlet adds to the DNS server is a PTR resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PtrDomainName -Specifies the FQDN of the host when you add a PTR resource record. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Replicate -Indicates that the DNS server allows WINS replication. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_20, UNNAMED_PARAMETER_SET_21 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResponsiblePerson -Specifies the FQDN for the domain mailbox name of the person who is responsible for the resource record. - -When used together with the MR parameter set, this value specifies a mailbox that is the proper rename of the mailbox that is specified in the resource record's owner name. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResultDomain -Specifies the domain name to append to returned NetBIOS names. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_20 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RP -Indicates that the record that this cmdlet adds to the DNS server is a Responsible Person (RP) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RT -Indicates that the record that this cmdlet adds to the DNS server is a Route Through (RT) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_9 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -Specifies the subtype of a host AFS server. -For subtype 1 (value=1), the host has an AFS version 3.0 Volume Location Server for the named AFS cell. -For subtype 2 (value=2), the host has an authenticated name server holding the cell-root directory node for the named DCE/NCA cell. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Service -Specifies the service or services that are available for the current rewrite path. -It can also specify a particular protocol to use for a service. -Available services include Well-known Service (WKS) and NAPTR. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_10 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Srv -Indicates that the record that this cmdlet adds to the DNS server is a Service (SRV) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubType -Specifies whether the server is an AFS volume location server. -Use a value of 1 indicate that the server is an AFS version 3.0 volume location server for the specified AFS cell. -Use a value of 2 to indicate that the server is an authenticated name server that holds the cell-root directory node for the server that uses either Open Software Foundation's (OSF) DCE authenticated cell-naming system or HP/Apollo's Network Computing Architecture (NCA). - -For more information about server subtypes, see [RFC 1183](https://www.ietf.org/rfc/rfc1183.txt). - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6, UNNAMED_PARAMETER_SET_7, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10, UNNAMED_PARAMETER_SET_11, UNNAMED_PARAMETER_SET_12, UNNAMED_PARAMETER_SET_13, UNNAMED_PARAMETER_SET_14, UNNAMED_PARAMETER_SET_15, UNNAMED_PARAMETER_SET_16, UNNAMED_PARAMETER_SET_17, UNNAMED_PARAMETER_SET_18, UNNAMED_PARAMETER_SET_19 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Txt -Indicates that the record that this cmdlet adds to the DNS server is a TXT resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Weight -Specifies a value for the weight of the target host for a resource record. -You can use this parameter when you have multiple hosts that have an identical priority. -Use of the host is proportional to its weight. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Wins -Indicates that the record that this cmdlet adds to the DNS server is a WINS resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_21 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WinsR -Indicates that the record that this cmdlet adds to the DNS server is a WINS reverse (WinsR) resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_20 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WinsServers -Specifies one or more IP addresses of WINS servers that you want to use for a resource record. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_21 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Wks -Indicates that the record that this cmdlet adds to the DNS server is WKS resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_10 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -X25 -Indicates that the record that this cmdlet adds to the DNS server is an X25 resource record. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_18 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - -[RFC 2535](http://www.ietf.org/rfc/rfc2535.txt) - -[RFC 1183](https://www.ietf.org/rfc/rfc1183.txt) - -[Show-DnsServerCache](./Show-DnsServerCache.md) - -[Set-DnsServerZoneAging](./Set-DnsServerZoneAging.md) diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordA.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordA.md deleted file mode 100644 index 1dcc50ef1f..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordA.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecorda?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordA - -## SYNOPSIS -Adds a type A resource record to a DNS zone. - -## SYNTAX - -``` -Add-DnsServerResourceRecordA [-ZoneName] [-Name] [-IPv4Address] [-AgeRecord] - [-AllowUpdateAny] [-AsJob] [-CimSession ] [-ComputerName ] [-CreatePtr] [-PassThru] - [-ThrottleLimit ] [-TimeToLive ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordA** cmdlet adds a host address (A) record to a Domain Name System (DNS) zone. -An A record specifies an IPv4 address. - -## EXAMPLES - -### Example 1: Add a DNS record -``` -PS C:\> Add-DnsServerResourceRecordA -Name "host23" -ZoneName "contoso.com" -AllowUpdateAny -IPv4Address "172.18.99.23" -TimeToLive 01:00:00 -``` - -This example adds a type A DNS record for a host named host23 in the zone named contoso.com. -The command specifies **AllowUpdateAny** and provides a TTL value. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdateAny -Indicates that any authenticated user can update a resource record that has the same owner name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreatePtr -Indicates that the DNS server automatically creates an associated pointer (PTR) resource record for an A record. -A PTR resource record maps an IP address to an FQDN. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv4Address -Specifies an array of IPv4 addresses. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a host name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerResourceRecord](./Add-DnsServerResourceRecord.md) - -[Get-DnsServerResourceRecord](./Get-DnsServerResourceRecord.md) - -[Remove-DnsServerResourceRecord](./Remove-DnsServerResourceRecord.md) - -[Set-DnsServerResourceRecord](./Set-DnsServerResourceRecord.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordAAAA.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordAAAA.md deleted file mode 100644 index c1f9d204f2..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordAAAA.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecordaaaa?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordAAAA - -## SYNOPSIS -Adds a type AAAA resource record to a DNS server. - -## SYNTAX - -``` -Add-DnsServerResourceRecordAAAA [-ZoneName] [-Name] [-IPv6Address] [-AgeRecord] - [-AllowUpdateAny] [-AsJob] [-CimSession ] [-ComputerName ] [-CreatePtr] [-PassThru] - [-ThrottleLimit ] [-TimeToLive ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordAAAA** cmdlet adds a specified host IPv6 address (AAAA) record to a specified Domain Name System (DNS) zone. -An AAAA record specifies an IPv6 address. - -## EXAMPLES - -### Example 1: Add a DNS record -``` -PS C:\> Add-DnsServerResourceRecordAAAA -Name "host24" -ZoneName "contoso.com" -AllowUpdateAny -IPv6Address "3ffe::1" -TimeToLive 01:00:00 -``` - -This example adds a type AAAA DNS record for a host named host24 in the zone named contoso.com. -The command specifies **AllowUpdateAny** and provides a TTL value. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdateAny -Indicates that any authenticated user can update a resource record that has the same owner name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreatePtr -Indicates that the DNS server automatically creates an associated pointer (PTR) resource record for an AAAA record. -A PTR resource record maps an IP address to an FQDN. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv6Address -Specifies an array of IPv6 addresses. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a host name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the DNS zone to which you add the record. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord[] - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordCName.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordCName.md deleted file mode 100644 index 7473f58e0d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordCName.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecordcname?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordCName - -## SYNOPSIS -Adds a type CNAME resource record to a DNS zone. - -## SYNTAX - -``` -Add-DnsServerResourceRecordCName [-ZoneName] [-Name] [-HostNameAlias] [-AgeRecord] - [-AllowUpdateAny] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-TimeToLive ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordCName** cmdlet adds a canonical name (CNAME) resource record to a specified Domain Name System (DNS) zone. -A CNAME record allows you to use more than one resource record to refer to a single host. - -You can use CNAME records for the following scenarios. - -- Host more than one kind of server on the same system. -For instance, you might host an FTP server and a Web server on the same system with the names ftp.contoso.com and www.contoso.com. -- Rename a computer with an existing host (A) resource record in the same DNS zone. -You can use an CNAME resource record temporarily to allow a grace period for users and programs to switch from the old computer name to the new one. -- Resolve a generic name for a well-known server, like www, to a group of servers, such as redundant Web servers. - -## EXAMPLES - -### Example 1: Add a CNAME resource record -``` -PS C:\> Add-DnsServerResourceRecordCName -Name "labsrv1" -HostNameAlias "srv1.lab.contoso.com" -ZoneName "contoso.com" -``` - -This command adds a CNAME resource record with the alias labsrv1 to the contoso.com domain for a system named srv1 in the zone named lab.contoso.com. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdateAny -Indicates that any authenticated user can update a resource record that has the same owner name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostNameAlias -Specifies the FQDN of the host that gets the alias. -This is the canonical name of the host.. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the alias for the CNAME record. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordDS.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordDS.md deleted file mode 100644 index 3c580ef5cf..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordDS.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecordds?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordDS - -## SYNOPSIS -Adds a type DS resource record to a DNS zone. - -## SYNTAX - -``` -Add-DnsServerResourceRecordDS [-ZoneName] [-Name] [-KeyTag] - [-CryptoAlgorithm] [-DigestType] [-Digest] [-AgeRecord] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] - [-TimeToLive ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordDS** cmdlet adds a Delegation Signer (DS) resource record to a specified Domain Name System (DNS) zone. - -The **AgeRecord** parameter is not relevant for DS resource records. - -## EXAMPLES - -### Example 1: Import and add a DS record -``` -PS C:\> $b = Get-DnsServerResourceRecord -RRType DS -ZoneName "contoso.com" -computerName "Server1" - -PS C:\> $b[0].RecordData | Add-DnsServerResourceRecordDS -ZoneName "contoso.com" -Name "west02" -computerName "Server2" -``` - -This command imports a DS record from a zone named West02.contoso.com and adds it to the parent zone, contoso.com. - -The first command gets the DS record and stores it in the variable named **$b**. - -The second command gets the DS record from $b and adds it to contoso.com. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoAlgorithm -Specifies the cryptographic algorithm the server uses to generate keys. -The acceptable values for this parameter are: - -- RsaSha1 -- RsaSha256 -- RsaSha512 -- RsaSha1NSec3 -- ECDsaP256Sha256 -- ECDsaP384Sha384 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Digest -Specifies DS digest data. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 7 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DigestType -Specifies the type of digest data. -The acceptable values for this parameter are: - -- Sha1 -- Sha256 -- Sha384 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyTag -Specifies a key tag. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource record that this cmdlet adds to the DNS server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. -The cmdlet adds the record to this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - -[Import-DnsServerResourceRecordDS](./Import-DnsServerResourceRecordDS.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordDnsKey.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordDnsKey.md deleted file mode 100644 index 69aa3f5f65..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordDnsKey.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecorddnskey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordDnsKey - -## SYNOPSIS -Adds a type DNSKEY resource record to a DNS zone. - -## SYNTAX - -``` -Add-DnsServerResourceRecordDnsKey [-ZoneName] [-Name] [-CryptoAlgorithm] - [-Base64Data] [-AgeRecord] [-AsJob] [-CimSession ] [-ComputerName ] - [-KeyProtocol ] [-PassThru] [-SecureEntryPoint] [-ThrottleLimit ] [-TimeToLive ] - [-ZoneKey] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordDNSKEY** cmdlet adds DNSKEY resource record to a Domain Name System (DNS) server. -DNSKEY is a DNS Security Extensions (DNSSEC) element that stores a public key. -You most often use this cmdlet to add DNSKEY records to the TrustAnchors zone. - -The **AgeRecord** parameter is not relevant for DS resource records. - -If you do not specify either **SecureEntryPoint** or **ZoneSigningKey**, the cmdlet creates a trust anchor with the Secure Entry Point (SEP) bit set. - -## EXAMPLES - -### Example 1: Add a DNSKEY resource record to a different computer -``` -PS C:\>$DNSKEYS = Get-DnsServerResourceRecord -RRType DnsKey -ZoneName "contoso.com" -ComputerName "dnsserver.contoso.com" - -PS C:\>$DNSKEYS | %{ $_.RecordData | Add-DnsServerResourceRecordDnsKey -ZoneName "TrustAnchors" -Name "contoso.com" -ComputerName "dnsresolver.contoso.com" } -``` - -This example adds a DNSKEY resource record of the zone named contoso.com from the server named dnsserver.contoso.com to the server named dnsresolver.contoso.com. - -The first command gets the DNSKEY resource record and stores it in the variable named **$DNSKEYS**. - -The second command gets the DNSKEY resource record from **$DSNKEYS** and stores the resource record in the zone named TrustAnchors on the server named dnsresolver.contoso.com. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Base64Data -Specifies key data for this resource record. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoAlgorithm -Specifies the cryptographic algorithm the server uses to generate keys. -The acceptable values for this parameter are: - -- RsaSha1 -- RsaSha256 -- RsaSha512 -- RsaSha1NSec3 -- ECDsaP256Sha256 -- ECDsaP384Sha384 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyProtocol -Specifies the key protocol for this resource record. -The only value for this parameter is DnsSec. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource record that this cmdlet adds to the DNS server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecureEntryPoint -Specifies whether the key is a secure entry point, as defined in RFC 3757. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneKey -Specifies whether you can use this key to sign the zone. -This key can be either a Zone Signing Key (ZSK) or a Key Signing Key (KSK). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordMX.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordMX.md deleted file mode 100644 index 94486f56df..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordMX.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecordmx?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordMX - -## SYNOPSIS -Adds an MX resource record to a DNS server. - -## SYNTAX - -``` -Add-DnsServerResourceRecordMX [-ZoneName] [-Name] [-MailExchange] - [-Preference] [-AgeRecord] [-AllowUpdateAny] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-TimeToLive ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordMX** cmdlet adds a Mail Exchanger (MX) resource record to a Domain Name System (DNS) zone. - -The MX resource record provides the name for a mail server for a domain. -If there are multiple MX resource records for a domain, the client attempts to contact mail servers in the order of preference from lowest value to highest value. - -## EXAMPLES - -### Example 1: Add an MX resource record -``` -PS C:\> Add-DnsServerResourceRecordMX -Preference 10 -Name "." -TimeToLive 01:00:00 -MailExchange "mail.contoso.com" -ZoneName "contoso.com" -``` - -This command adds an MX record named RecordNameMX for the zone western.contoso.com with a preference of 123. -The mail exchanger is MAILSrv1. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdateAny -Indicates that any authenticated user can update a resource record that has the same owner name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailExchange -Specifies an FQDN for a mail exchanger. -This value must resolve to a corresponding host (A) resource record. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the host or child domain for the mail exchange record. -To add an MX resource record for the parent domain, specify a dot (.).. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Preference -Specifies a priority, from 0 to 65535, for this MX resource record. -A service attempts to contact mail servers in the order of preference from lowest priority value to highest priority value. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -The Start of Authority (SOA) record defines the default TTL. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordPtr.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordPtr.md deleted file mode 100644 index 7f8613ce43..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerResourceRecordPtr.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverresourcerecordptr?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerResourceRecordPtr - -## SYNOPSIS -Adds a type PTR resource record to a DNS server. - -## SYNTAX - -``` -Add-DnsServerResourceRecordPtr [-ZoneName] [-Name] [-PtrDomainName] [-AgeRecord] - [-AllowUpdateAny] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-TimeToLive ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerResourceRecordPtr** cmdlet adds a specified pointer (PTR) record to a specified Domain Name System (DNS) zone. - -PTR resource records support reverse lookup based on the in-addr.arpa domain. -PTR records locate a computer by its IP address and resolve the address to the DNS domain name for that computer. - -## EXAMPLES - -### Example 1: Add a PTR record -``` -PS C:\> Add-DnsServerResourceRecordPtr -Name "17" -ZoneName "0.168.192.in-addr.arpa" -AllowUpdateAny -TimeToLive 01:00:00 -AgeRecord -PtrDomainName "host17.contoso.com" -``` - -This command adds a type PTR DNS record in the zone named contoso.com. -The record maps IP address 192.168.0.17 to the name host17.contoso.com. -The command includes the **AllowUpdateAny** and **AgeRecord** parameters, and provides a TTL value. -Because the command includes the **AgeRecord** parameter, a DNS server can scavenge this record. - -## PARAMETERS - -### -AgeRecord -Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. -A DNS server can scavenge resource records that have become stale based on a time stamp. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AllowUpdateAny -Indicates that any authenticated user can update a resource record that has the same owner name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies part of the IP address for the host. -You can use either an IPv4 or IPv6 address. -For example, if you use an IPv4 class C reverse lookup zone, then **Name** specifies the last octet of the IP address. -If you use a class B reverse lookup zone, then **Name** specifies the last two octets. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PtrDomainName -Specifies an FQDN for a resource record in the DNS namespace. -This value is the response to a reverse lookup using this PTR. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToLive -Specifies the Time to Live (TTL) value, in seconds, for a resource record. -Other DNS servers use this length of time to determine how long to cache a record. - -The Start of Authority (SOA) record defines the default TTL. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a reverse lookup zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.Management.ManagementBaseObject - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerRootHint.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerRootHint.md deleted file mode 100644 index 5784479e02..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerRootHint.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverroothint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerRootHint - -## SYNOPSIS -Adds root hints on a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerRootHint [-InputObject] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerRootHint [-NameServer] [-IPAddress] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerRootHint** cmdlet adds root hints on a DNS server. -You can add root hints by specifying the DNS name server and IP address, or you can use the **InputObject** parameter to specify a **DnsServerRootHint** object. - -## EXAMPLES - -### Example 1: Add a root hint to a DNS server by using IP address -``` -PS C:\> Add-DnsServerRootHint -NameServer "root.contoso.com" -IPAddress 172.23.90.128 -``` - -This command adds the IP address 172.23.90.128 for the name server root.contoso.com to the list of root hints on the local DNS server. - -### Example 2: Add a root hint to a DNS server by using an IPv6 address -``` -PS C:\>Add-DnsServerRootHint -NameServer "root.contoso.com" -IPAddress 2001:4898:7020:f100:458f:e6a2:fcaf:698c -``` - -This command adds the IPv6 address 2001:4898:7020:f100:458f:e6a2:fcaf:698c for the name server root.contoso.com to the list of root hints on the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IPv4 or IPv6 addresses of DNS servers. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServer -Specifies the fully qualified domain name of the root name server. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRootHint - -## NOTES - -## RELATED LINKS - -[Get-DnsServerRootHint](./Get-DnsServerRootHint.md) - -[Import-DnsServerRootHint](./Import-DnsServerRootHint.md) - -[Remove-DnsServerRootHint](./Remove-DnsServerRootHint.md) - -[Set-DnsServerRootHint](./Set-DnsServerRootHint.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerSecondaryZone.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerSecondaryZone.md deleted file mode 100644 index 26f85f2ffd..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerSecondaryZone.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserversecondaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerSecondaryZone - -## SYNOPSIS -Adds a DNS server secondary zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerSecondaryZone [-Name] [-ZoneFile] [-MasterServers] [-AsJob] - [-CimSession ] [-ComputerName ] [-LoadExisting] [-PassThru] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerSecondaryZone [-ZoneFile] [-MasterServers] [-AsJob] - [-CimSession ] [-ComputerName ] [-LoadExisting] [-PassThru] [-ThrottleLimit ] - -NetworkId [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerSecondaryZone** cmdlet adds a specified secondary zone on a Domain Name System (DNS) server. -You can create either a forward lookup zone or a reverse lookup zone. -To create a reverse lookup zone, specify a network ID by using the **NetworkID** parameter, or specify a full reverse lookup zone name by using the **Name** parameter. - -## EXAMPLES - -### Example 1: Add a secondary DNS server zone -``` -PS C:\> Add-DnsServerSecondaryZone -Name "western.contoso.com" -ZoneFile "western.contoso.com.dns" -MasterServers 172.23.90.124 -``` - -This command creates a secondary DNS zone named western.contoso.com with the specified master server. -This zone is file-backed. - -### Example 2: Create secondary zones -``` -PS C:\>Get-DnsServerZone -ComputerName win-olpn33s5q3m.mytest.contoso.com | where {("Primary" -eq $_.ZoneType) -and ($false -eq $_.IsAutoCreated) -and ("TrustAnchors" -ne $_.ZoneName)} | %{ $_ | Add-DnsServerSecondaryZone -MasterServers 172.23.90.136 -ZoneFile "$($_.ZoneName).dns"} -``` - -This example gets primary zones from the server win-olpn33s5q3m.mytest.contoso.com and creates secondary zones (except TrustAnchors and AutoCreated zones) on the local system. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadExisting -Loads an existing file for the zone. -Otherwise, the cmdlet creates default zone records automatically. -This switch is relevant only for file-backed zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -You can use both IPv4 and IPv6. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of a zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkId -Specifies the network ID and prefix for the secondary zone. -Enter an IP address with prefix length in this format: 11.1.1/24 or 1234::/64. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies the name of the zone file. -This parameter is only relevant for file-backed zones. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSecondaryZone - -## NOTES - -## RELATED LINKS - -[ConvertTo-DnsServerSecondaryZone](./ConvertTo-DnsServerSecondaryZone.md) - -[Restore-DnsServerSecondaryZone](./Restore-DnsServerSecondaryZone.md) - -[Set-DnsServerSecondaryZone](./Set-DnsServerSecondaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerSigningKey.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerSigningKey.md deleted file mode 100644 index d15057edd4..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerSigningKey.md +++ /dev/null @@ -1,384 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserversigningkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerSigningKey - -## SYNOPSIS -Adds a KSK or ZSK to a signed zone. - -## SYNTAX - -``` -Add-DnsServerSigningKey [-ZoneName] [[-Type] ] [[-CryptoAlgorithm] ] - [[-KeyLength] ] [-ActiveKey ] [-AsJob] [-CimSession ] [-ComputerName ] - [-DnsKeySignatureValidityPeriod ] [-DSSignatureValidityPeriod ] - [-InitialRolloverOffset ] [-KeyStorageProvider ] [-NextKey ] [-PassThru] - [-RolloverPeriod ] [-StandbyKey ] [-StoreKeysInAD ] [-ThrottleLimit ] - [-ZoneSignatureValidityPeriod ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerSigningKey** cmdlet adds a Key Signing Key (KSK) or Zone Signing Key (ZSK) key to a Domain Name System (DNS) signed zone. - -## EXAMPLES - -### Example 1: Add a KSK to a DNS zone -``` -PS C:\> Add-DnsServerSigningKey -ZoneName "corp.contoso.com" -Type "KeySigningKey" -CryptoAlgorithm "RsaSha1NSec3" -KeyLength 2048 -PassThru -Verbose -``` - -This command adds a KSK to the DNS signed-zone corp.contoso.com. - -## PARAMETERS - -### -ActiveKey -Specifies a signing key pointer string for the KSK's active key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoAlgorithm -Specifies a cryptographic algorithm to use for key generation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsKeySignatureValidityPeriod -Specifies the amount of time that signatures that cover DNSKEY record sets are valid. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DSSignatureValidityPeriod -Specifies the amount of time that signatures that cover DS record sets are valid. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitialRolloverOffset -Specifies the amount of time to delay the first scheduled key rollover. -You can use **InitialRolloverOffset** to stagger key rollovers. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyLength -Specifies the bit length of a key. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyStorageProvider -Specifies the Key Storage Provider that the DNS server uses to generate keys. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextKey -Specifies a signing key pointer string for the next key. -The DNS server uses this key during the next key rollover event. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RolloverPeriod -Specifies the amount of time between scheduled key rollovers. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StandbyKey -Specifies a signing key pointer string for the KSK's standby key. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StoreKeysInAD -Stores the keys in Active Directory Domain Services (AD DS). -This setting applies only to Active Directory-integrated zones when the vendor of KeyStorageProvider is Microsoft. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies whether a key is a KSK or a ZSK. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneSignatureValidityPeriod -Specifies the amount of time that signatures that cover all other record sets are valid. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey - -## NOTES - -## RELATED LINKS - -[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - -[Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) - -[Get-DnsServerSigningKey](./Get-DnsServerSigningKey.md) - -[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) - -[Remove-DnsServerSigningKey](./Remove-DnsServerSigningKey.md) - -[Set-DnsServerSigningKey](./Set-DnsServerSigningKey.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerStubZone.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerStubZone.md deleted file mode 100644 index dd4e1e2cbe..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerStubZone.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverstubzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerStubZone - -## SYNOPSIS -Adds a DNS stub zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerStubZone [-Name] [-MasterServers] [-ReplicationScope] - [[-DirectoryPartitionName] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-LoadExisting] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerStubZone [-MasterServers] [-AsJob] [-CimSession ] - [-ComputerName ] [-LoadExisting] [-PassThru] [-ThrottleLimit ] -NetworkId - -ZoneFile [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-DnsServerStubZone [-Name] [-MasterServers] [-AsJob] [-CimSession ] - [-ComputerName ] [-LoadExisting] [-PassThru] [-ThrottleLimit ] -ZoneFile [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-DnsServerStubZone [-MasterServers] [-ReplicationScope] - [[-DirectoryPartitionName] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-LoadExisting] [-PassThru] [-ThrottleLimit ] -NetworkId [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerStubZone** cmdlet adds a stub zone. -A stub zone is a copy of a Domain Name System (DNS) zone that contains only resource records that identify the DNS servers for that zone. - -You can add either a forward lookup zone or a reverse lookup zone. -You can add either an Active Directory-integrated zone or a file-backed zone. - -## EXAMPLES - -### Example 1: Add a file-backed stub zone -``` -PS C:\> Add-DnsServerStubZone -Name "west02.contoso.com" -MasterServers "172.23.90.124" -PassThru -ZoneFile "west02_contoso.dns" -``` - -This command adds west02.contoso.com as a file-backed stub zone. -The command specifies a master server and uses the **PassThru** parameter to produce output. - -### Example 2: Add an Active Directory-integrated stub zone -``` -PS C:\>Add-DnsServerStubZone -Name "west03.contoso.com" -MasterServers 172.23.90.124 -PassThru -ReplicationScope "Forest" -``` - -This command adds west03.contoso.com as a stub zone replicated to all DNS servers in the forest. - -### Example 3: Add an Active Directory-integrated reverse lookup zone -``` -PS C:\>Add-DnsServerStubZone -NetworkId 10.1.2.0/24 -MasterServers 172.23.90.124 -PassThru -ReplicationScope Forest -``` - -This command adds a stub zone for the network 2.1.10.in-addr.arpa, which is replicated to all DNS servers in the forest. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the zone. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LoadExisting -Loads an existing file for the zone. -Otherwise, the cmdlet creates default zone records automatically. -This switch is relevant only for file-backed zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -You can use both IPv4 and IPv6. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of a zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkId -Specifies a network ID and prefix length for a reverse lookup zone. -Use the format A.B.C.D/prefix. - -The cmdlet creates only class A, B, C, or D zones. -If you specify a prefix that is between classes, the cmdlet uses the longer prefix divisible by 8. -For example, a value of 10.2.10.0/23 results in the 10.2.10.0/24 reverse lookup zone, not the 10.2.11.0/24 reverse lookup zone. -If you enter a prefix longer than /24, the cmdlet creates a /32 reverse lookup zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies a partition on which to store an Active Directory-integrated zone. -The acceptable values for this parameter are: - -- Custom. -Any custom directory partition that a user creates. -Specify a custom directory partition by using the **DirectoryPartitionName** parameter. -- Domain. -The domain directory partition. -- Forest. -The ForestDnsZone directory partition. -- Legacy. -A legacy directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies a name of the zone file. -This parameter is only relevant for file-backed DNS. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerStubZone - -## NOTES - -## RELATED LINKS - -[Set-DnsServerStubZone](./Set-DnsServerStubZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerTrustAnchor.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerTrustAnchor.md deleted file mode 100644 index 8ec3c5efc5..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerTrustAnchor.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsservertrustanchor?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerTrustAnchor - -## SYNOPSIS -Adds a trust anchor to a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerTrustAnchor [-Name] [-CryptoAlgorithm] [-AsJob] [-CimSession ] - [-ComputerName ] [-KeyProtocol ] [-PassThru] [-ThrottleLimit ] -Base64Data - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerTrustAnchor [-Name] [-CryptoAlgorithm] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] -Digest -DigestType - -KeyTag [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerTrustAnchor** cmdlet adds a trust anchor (DNSKEY record or DS record) to a DNS server. -If no trust anchor is present, the cmdlet creates one. -If you specify the **DigestType** parameter, the cmdlet adds a trust anchor delegation signer (DS) record. - -## EXAMPLES - -### Example 1: Add a trust anchor to a DNS server -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "sec.contoso.com" -RRType "dnskey" -ComputerName DNS1 | %{ $_.RecordData | Add-DnsServerTrustAnchor -PassThru -Verbose -Name "sec.contoso.com"} -``` - -This command uses the Get-DnsServerResourceRecord cmdlet to obtain a DnsKey resource record from the DNS server DNS1 for the zone named sec.contoso.com. -The command then uses the pipe operator to send it to the Add-DnsServerTrustAnchor cmdlet to add a trust anchor to the current DNS server for this zone. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Base64Data -Specifies key data. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -The acceptable values for this parameter are: an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoAlgorithm -Specifies the cryptographic algorithm that the cmdlet uses for key generation. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Digest -Specifies the DS digest data. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DigestType -Specifies the type of algorithm that the zone signing key uses to create the DS record. -Valid values are one or more of the following: -- Sha1 -- Sha256 -- Sha384 - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyProtocol -Specifies the protocol name. -The default is DNSSEC. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyTag -Specifies the unique key tag that the DNS server uses to identify a key. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a trust anchor on a DNS server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustAnchor - -## NOTES - -## RELATED LINKS - -[Get-DnsServerTrustAnchor](./Get-DnsServerTrustAnchor.md) - -[Import-DnsServerTrustAnchor](./Import-DnsServerTrustAnchor.md) - -[Remove-DnsServerTrustAnchor](./Remove-DnsServerTrustAnchor.md) - -[Get-DnsServerResourceRecord](./Get-DnsServerResourceRecord.md) - diff --git a/docset/winserver2012-ps/dnsserver/Add-DnsServerZoneDelegation.md b/docset/winserver2012-ps/dnsserver/Add-DnsServerZoneDelegation.md deleted file mode 100644 index 69a44f3c97..0000000000 --- a/docset/winserver2012-ps/dnsserver/Add-DnsServerZoneDelegation.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/add-dnsserverzonedelegation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DnsServerZoneDelegation - -## SYNOPSIS -Adds a new delegated DNS zone to an existing zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DnsServerZoneDelegation [-InputObject] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DnsServerZoneDelegation [-Name] [-ChildZoneName] [-NameServer] - [-IPAddress] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-DnsServerZoneDelegation** cmdlet adds a zone delegation to a Domain Name System (DNS) zone. -For instance, you can add a child domain called west01 to your top level domain, contoso.com, and specify a DNS server for that delegated domain. - -## EXAMPLES - -### Example 1: Add a zone delegation -``` -PS C:\> Add-DnsServerZoneDelegation -Name "contoso.com" -ChildZoneName "west01" -NameServer "wserver.west01.contoso.com" -IPAddress 172.23.90.136 -PassThru -Verbose -``` - -This command creates a delegation for west01 in the zone contoso.com with the specified name server and IP address. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChildZoneName -Specifies a name of the child zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. -This parameter takes a Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation object. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IP addresses for DNS servers for the child zone. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the parent zone. -The child zone is part of this zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServer -Specifies the name of the DNS server that hosts the child zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation - -## NOTES - -## RELATED LINKS - - - -[Get-DnsServerZoneDelegation](./Get-DnsServerZoneDelegation.md) - -[Remove-DnsServerZoneDelegation](./Remove-DnsServerZoneDelegation.md) - -[Set-DnsServerZoneDelegation](./Set-DnsServerZoneDelegation.md) - diff --git a/docset/winserver2012-ps/dnsserver/Clear-DnsServerCache.md b/docset/winserver2012-ps/dnsserver/Clear-DnsServerCache.md deleted file mode 100644 index c724c21e23..0000000000 --- a/docset/winserver2012-ps/dnsserver/Clear-DnsServerCache.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/clear-dnsservercache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-DnsServerCache - -## SYNOPSIS -Clears resource records from a cache on the DNS server. - -## SYNTAX - -``` -Clear-DnsServerCache [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Clear-DnsServerCache** cmdlet clears resource records from a Domain Name System (DNS) server cache. - -## EXAMPLES - -### Example 1: -``` -PS C:\> Clear-DnsServerCache -ComputerName "Win12S-05.DNSServer-01.Contoso.com" -Force -``` - -This command clears the DNS server cache on a specified DNS server. -If you do not use the Force parameter, you must confirm the action before it is performed. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -If specified, overrides the default confirmation before the operation is performed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DnsServerCache](./Get-DnsServerCache.md) - -[Set-DnsServerCache](./Set-DnsServerCache.md) - -[Show-DnsServerCache](./Show-DnsServerCache.md) - diff --git a/docset/winserver2012-ps/dnsserver/Clear-DnsServerStatistics.md b/docset/winserver2012-ps/dnsserver/Clear-DnsServerStatistics.md deleted file mode 100644 index 797a7f871c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Clear-DnsServerStatistics.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/clear-dnsserverstatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-DnsServerStatistics - -## SYNOPSIS -Clears all DNS server statistics. - -## SYNTAX - -``` -Clear-DnsServerStatistics [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Clear-DnsServerStatistics** cmdlet clears all Domain Name System (DNS) server statistics. -After you have cleared the statistics, you cannot retrieve them. - -## EXAMPLES - -### Example 1: Clear DNS server statistics -``` -PS C:\> Clear-DnsServerStatistics -``` - -This command clears statistics from a DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. -Type the NetBIOS name, or a fully qualified domain name of a remote computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Instructs the cmdlet to perform the operation without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DnsServerStatistics](./Get-DnsServerStatistics.md) - diff --git a/docset/winserver2012-ps/dnsserver/ConvertTo-DnsServerPrimaryZone.md b/docset/winserver2012-ps/dnsserver/ConvertTo-DnsServerPrimaryZone.md deleted file mode 100644 index d569904b8e..0000000000 --- a/docset/winserver2012-ps/dnsserver/ConvertTo-DnsServerPrimaryZone.md +++ /dev/null @@ -1,294 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/convertto-dnsserverprimaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# ConvertTo-DnsServerPrimaryZone - -## SYNOPSIS -Converts a zone to a DNS primary zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -ConvertTo-DnsServerPrimaryZone [-Name] [-ReplicationScope] - [[-DirectoryPartitionName] ] [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-LoadExisting] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -ConvertTo-DnsServerPrimaryZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-Force] [-LoadExisting] [-PassThru] [-ThrottleLimit ] -ZoneFile [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **ConvertTo-DnsServerPrimaryZone** converts a Domain Name System (DNS) zone to a DNS primary zone. -Use this cmdlet to promote a secondary zone to a primary zone on the server. -For a file-backed zone, ensure there is only one server that hosts the primary zone. - -## EXAMPLES - -### Example 1: Convert a file-backed zone -``` -PS C:\> ConvertTo-DnsServerPrimaryZone -Name "west03.contoso.com" -PassThru -Verbose -ZoneFile "west03.contoso.com" -Force -VERBOSE: Convert west03.contoso.com zone to (file backed/AD integrated) DNS primary zone on DNS-11 server. -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -west03.contoso.com Primary False False False False -``` - -This command converts zone named west03.contoso.com to a file-backed primary zone on the current server. -This example uses the **Force** parameter to skip a confirmation message. - -### Example 2: Convert an Active Directory-integrated zone -``` -PS C:\>ConvertTo-DnsServerPrimaryZone "west04.contoso.com" -PassThru -Verbose -ReplicationScope Domain -Force -``` - -This command converts a zone named west04.contoso.com to an Active Directory-integrated primary zone. -The zone will be replicated to all DNS servers in the domain. -This example uses the **Force** parameter to skip a confirmation message. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the zone. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Converts a zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadExisting -Loads an existing file for the zone. -Otherwise, the cmdlet creates default zone records. -This switch is relevant only for file-backed zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies a partition on which to store an Active Directory-integrated zone. -The acceptable values for this parameter are: - -- Custom. -Any custom directory partition that a user creates. -Specify a custom directory partition by using the **DirectoryPartitionName** parameter. -- Domain. -The domain directory partition. -- Forest. -The ForestDnsZone directory partition. -- Legacy. -A legacy directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies the name of the zone file. -This parameter is only relevant for file-backed DNS. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerPrimaryZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerPrimaryZone](./Add-DnsServerPrimaryZone.md) - -[Restore-DnsServerPrimaryZone](./Restore-DnsServerPrimaryZone.md) - -[Set-DnsServerPrimaryZone](./Set-DnsServerPrimaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/ConvertTo-DnsServerSecondaryZone.md b/docset/winserver2012-ps/dnsserver/ConvertTo-DnsServerSecondaryZone.md deleted file mode 100644 index 5f961ac4d0..0000000000 --- a/docset/winserver2012-ps/dnsserver/ConvertTo-DnsServerSecondaryZone.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/convertto-dnsserversecondaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# ConvertTo-DnsServerSecondaryZone - -## SYNOPSIS -Converts a primary zone or stub zone to a secondary zone. - -## SYNTAX - -``` -ConvertTo-DnsServerSecondaryZone [-Name] [-MasterServers] [-ZoneFile] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **ConvertTo-DnsServerSecondaryZone** cmdlet converts primary zone or a stub zone on a Domain Name System (DNS) server to a secondary zone. - -## EXAMPLES - -### Example 1: Convert a file-backed zone to a secondary zone -``` -PS C:\> ConvertTo-DnsServerSecondaryZone -Name "0.0.10.in-addr.arpa" -MasterServers 172.23.90.124 -ZoneFile "0.0.10.in-addr.arpa.dns" -PassThru -Verbose -``` - -This command converts the zone named 0.0.10.in-addr.arpa to a secondary zone. -The command specifies a master server and the zone file. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Converts a zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -You can use both IPv4 and IPv6. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone to convert. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies the name of the zone file. -This parameter is only relevant for file-backed DNS. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSecondaryZone - -## NOTES - -## RELATED LINKS - -[ConvertTo-DnsServerSecondaryZone](./ConvertTo-DnsServerSecondaryZone.md) - -[Restore-DnsServerSecondaryZone](./Restore-DnsServerSecondaryZone.md) - -[Set-DnsServerSecondaryZone](./Set-DnsServerSecondaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Disable-DnsServerSigningKeyRollover.md b/docset/winserver2012-ps/dnsserver/Disable-DnsServerSigningKeyRollover.md deleted file mode 100644 index 8e68fe08c2..0000000000 --- a/docset/winserver2012-ps/dnsserver/Disable-DnsServerSigningKeyRollover.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/disable-dnsserversigningkeyrollover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-DnsServerSigningKeyRollover - -## SYNOPSIS -Disables key rollover on an input key. - -## SYNTAX - -``` -Disable-DnsServerSigningKeyRollover [-ZoneName] [-KeyId] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-DnsServerSigningKeyRollover** cmdlet disables key rollover on an input key. - -## EXAMPLES - -### Example 1: Get and disable keys -``` -PS C:\>Get-DnsServerSigningKey -ZoneName "DNSServer06.contoso.com" | Disable-DnsServerSigningKeyRollover -Verbose -PassThru -``` - -This command gets DNSSEC keys for the DNSServer06.contoso.com zone and disables rollover for each key. -Before each key's rollover is disabled, you must confirm the action. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a Domain Name System (DNS) server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -If specified, overrides the default confirmation before performing the operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Identifies a key. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey - -## NOTES - -## RELATED LINKS - -[Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) - -[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) - diff --git a/docset/winserver2012-ps/dnsserver/DnsServer.md b/docset/winserver2012-ps/dnsserver/DnsServer.md deleted file mode 100644 index 24e08f441f..0000000000 --- a/docset/winserver2012-ps/dnsserver/DnsServer.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 46f598e5-9907-42b2-afbb-68e5f7e34604 -Module Name: DnsServer ---- - -# DnsServer Module -## Description -This reference provides cmdlet descriptions and syntax for all DNS Server cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. -DnsServer Module can be obtained either by installing DNS Server role or adding the DNS Server Tools part of Remote Server Administration Tools (RSAT) feature. - -## DnsServer Cmdlets -### [Add-DnsServerConditionalForwarderZone](./Add-DnsServerConditionalForwarderZone.md) -Adds a conditional forwarder to a DNS server. - -### [Add-DnsServerDirectoryPartition](./Add-DnsServerDirectoryPartition.md) -Creates a DNS application directory partition. - -### [Add-DnsServerForwarder](./Add-DnsServerForwarder.md) -Adds server level forwarders to a DNS server. - -### [Add-DnsServerPrimaryZone](./Add-DnsServerPrimaryZone.md) -Adds a primary zone to a DNS server. - -### [Add-DnsServerResourceRecord](./Add-DnsServerResourceRecord.md) -Adds a resource record of a specified type to a specified DNS zone. - -### [Add-DnsServerResourceRecordA](./Add-DnsServerResourceRecordA.md) -Adds a type A resource record to a DNS zone. - -### [Add-DnsServerResourceRecordAAAA](./Add-DnsServerResourceRecordAAAA.md) -Adds a type AAAA resource record to a DNS server. - -### [Add-DnsServerResourceRecordCName](./Add-DnsServerResourceRecordCName.md) -Adds a type CNAME resource record to a DNS zone. - -### [Add-DnsServerResourceRecordDnsKey](./Add-DnsServerResourceRecordDnsKey.md) -Adds a type DNSKEY resource record to a DNS zone. - -### [Add-DnsServerResourceRecordDS](./Add-DnsServerResourceRecordDS.md) -Adds a type DS resource record to a DNS zone. - -### [Add-DnsServerResourceRecordMX](./Add-DnsServerResourceRecordMX.md) -Adds an MX resource record to a DNS server. - -### [Add-DnsServerResourceRecordPtr](./Add-DnsServerResourceRecordPtr.md) -Adds a type PTR resource record to a DNS server. - -### [Add-DnsServerRootHint](./Add-DnsServerRootHint.md) -Adds root hints on a DNS server. - -### [Add-DnsServerSecondaryZone](./Add-DnsServerSecondaryZone.md) -Adds a DNS server secondary zone. - -### [Add-DnsServerSigningKey](./Add-DnsServerSigningKey.md) -Adds a KSK or ZSK to a signed zone. - -### [Add-DnsServerStubZone](./Add-DnsServerStubZone.md) -Adds a DNS stub zone. - -### [Add-DnsServerTrustAnchor](./Add-DnsServerTrustAnchor.md) -Adds a trust anchor to a DNS server. - -### [Add-DnsServerZoneDelegation](./Add-DnsServerZoneDelegation.md) -Adds a new delegated DNS zone to an existing zone. - -### [Clear-DnsServerCache](./Clear-DnsServerCache.md) -Clears resource records from a cache on the DNS server. - -### [Clear-DnsServerStatistics](./Clear-DnsServerStatistics.md) -Clears all DNS server statistics. - -### [ConvertTo-DnsServerPrimaryZone](./ConvertTo-DnsServerPrimaryZone.md) -Converts a zone to a DNS primary zone. - -### [ConvertTo-DnsServerSecondaryZone](./ConvertTo-DnsServerSecondaryZone.md) -Converts a primary zone or stub zone to a secondary zone. - -### [Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) -Disables key rollover on an input key. - -### [Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) -Enables rollover on the input key. - -### [Export-DnsServerDnsSecPublicKey](./Export-DnsServerDnsSecPublicKey.md) -Exports DS and DNSKEY information for a DNSSEC-signed zone. - -### [Export-DnsServerZone](./Export-DnsServerZone.md) -Exports contents of a zone to a file. - -### [Get-DnsServer](./Get-DnsServer.md) -Retrieves a DNS server configuration. - -### [Get-DnsServerCache](./Get-DnsServerCache.md) -Retrieves DNS server cache settings. - -### [Get-DnsServerDiagnostics](./Get-DnsServerDiagnostics.md) -Retrieves DNS event logging details. - -### [Get-DnsServerDirectoryPartition](./Get-DnsServerDirectoryPartition.md) -Gets a DNS application directory partition. - -### [Get-DnsServerDnsSecZoneSetting](./Get-DnsServerDnsSecZoneSetting.md) -Gets DNSSEC settings for a zone. - -### [Get-DnsServerDsSetting](./Get-DnsServerDsSetting.md) -Retrieves DNS Server Active Directory settings - -### [Get-DnsServerEDns](./Get-DnsServerEDns.md) -Gets EDNS configuration settings on a DNS server. - -### [Get-DnsServerForwarder](./Get-DnsServerForwarder.md) -Gets forwarder configuration settings on a DNS server. - -### [Get-DnsServerGlobalNameZone](./Get-DnsServerGlobalNameZone.md) -Retrieves DNS server GlobalName zone configuration details. - -### [Get-DnsServerGlobalQueryBlockList](./Get-DnsServerGlobalQueryBlockList.md) -Gets a global query block list. - -### [Get-DnsServerRecursion](./Get-DnsServerRecursion.md) -Retrieves DNS server recursion settings. - -### [Get-DnsServerResourceRecord](./Get-DnsServerResourceRecord.md) -Gets resource records from a specified DNS zone. - -### [Get-DnsServerRootHint](./Get-DnsServerRootHint.md) -Gets root hints on a DNS server. - -### [Get-DnsServerScavenging](./Get-DnsServerScavenging.md) -Gets DNS aging and scavenging settings. - -### [Get-DnsServerSetting](./Get-DnsServerSetting.md) -Retrieves DNS server settings. - -### [Get-DnsServerSigningKey](./Get-DnsServerSigningKey.md) -Gets zone signing keys. - -### [Get-DnsServerStatistics](./Get-DnsServerStatistics.md) -Retrieves DNS server statistics. - -### [Get-DnsServerTrustAnchor](./Get-DnsServerTrustAnchor.md) -Gets trust anchors on a DNS server. - -### [Get-DnsServerTrustPoint](./Get-DnsServerTrustPoint.md) -Gets trust points on a DNS server. - -### [Get-DnsServerZone](./Get-DnsServerZone.md) -Gets details of DNS zones on a DNS server. - -### [Get-DnsServerZoneAging](./Get-DnsServerZoneAging.md) -Gets DNS aging settings for a zone. - -### [Get-DnsServerZoneDelegation](./Get-DnsServerZoneDelegation.md) -Gets the zone delegations of a DNS server zone. - -### [Import-DnsServerResourceRecordDS](./Import-DnsServerResourceRecordDS.md) -Imports DS resource record information from a file. - -### [Import-DnsServerRootHint](./Import-DnsServerRootHint.md) -Copies root hints from a DNS server. - -### [Import-DnsServerTrustAnchor](./Import-DnsServerTrustAnchor.md) -Imports a trust anchor for a DNS server. - -### [Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) -Initiates rollover of signing keys for the zone. - -### [Invoke-DnsServerZoneSign](./Invoke-DnsServerZoneSign.md) -Signs a DNS server zone. - -### [Invoke-DnsServerZoneUnsign](./Invoke-DnsServerZoneUnsign.md) -Unsigns a DNS server zone. - -### [Register-DnsServerDirectoryPartition](./Register-DnsServerDirectoryPartition.md) -Registers a DNS server in a DNS application directory partition. - -### [Remove-DnsServerDirectoryPartition](./Remove-DnsServerDirectoryPartition.md) -Removes a DNS application directory partition. - -### [Remove-DnsServerForwarder](./Remove-DnsServerForwarder.md) -Removes server level forwarders from a DNS server. - -### [Remove-DnsServerResourceRecord](./Remove-DnsServerResourceRecord.md) -Removes specified DNS server resource records from a zone. - -### [Remove-DnsServerRootHint](./Remove-DnsServerRootHint.md) -Removes root hints from a DNS server. - -### [Remove-DnsServerSigningKey](./Remove-DnsServerSigningKey.md) -Removes signing keys. - -### [Remove-DnsServerTrustAnchor](./Remove-DnsServerTrustAnchor.md) -Removes a trust anchor from a DNS server. - -### [Remove-DnsServerZone](./Remove-DnsServerZone.md) -Removes a zone from a DNS server. - -### [Remove-DnsServerZoneDelegation](./Remove-DnsServerZoneDelegation.md) -Removes a name server or delegation from a DNS zone. - -### [Reset-DnsServerZoneKeyMasterRole](./Reset-DnsServerZoneKeyMasterRole.md) -Transfers the role of Key Master for a DNS zone. - -### [Restore-DnsServerPrimaryZone](./Restore-DnsServerPrimaryZone.md) -Restores primary DNS zone contents from Active Directory or from a file. - -### [Restore-DnsServerSecondaryZone](./Restore-DnsServerSecondaryZone.md) -Restores secondary zone information from its source. - -### [Resume-DnsServerZone](./Resume-DnsServerZone.md) -Resumes name resolution on a suspended zone. - -### [Set-DnsServer](./Set-DnsServer.md) -Overwrites a DNS server configuration. - -### [Set-DnsServerCache](./Set-DnsServerCache.md) -Modifies cache settings for a DNS server. - -### [Set-DnsServerConditionalForwarderZone](./Set-DnsServerConditionalForwarderZone.md) -Changes settings for a DNS conditional forwarder. - -### [Set-DnsServerDiagnostics](./Set-DnsServerDiagnostics.md) -Sets debugging and logging parameters. - -### [Set-DnsServerDnsSecZoneSetting](./Set-DnsServerDnsSecZoneSetting.md) -Changes settings for DNSSEC for a zone. - -### [Set-DnsServerDsSetting](./Set-DnsServerDsSetting.md) -Modifies DNS Active Directory settings. - -### [Set-DnsServerEDns](./Set-DnsServerEDns.md) -Changes EDNS settings on a DNS server. - -### [Set-DnsServerForwarder](./Set-DnsServerForwarder.md) -Changes forwarder settings on a DNS server. - -### [Set-DnsServerGlobalNameZone](./Set-DnsServerGlobalNameZone.md) -Changes configuration settings for a GlobalNames zone. - -### [Set-DnsServerGlobalQueryBlockList](./Set-DnsServerGlobalQueryBlockList.md) -Changes settings of a global query block list. - -### [Set-DnsServerPrimaryZone](./Set-DnsServerPrimaryZone.md) -Changes settings for a DNS primary zone. - -### [Set-DnsServerRecursion](./Set-DnsServerRecursion.md) -Modifies recursion settings for a DNS server. - -### [Set-DnsServerResourceRecord](./Set-DnsServerResourceRecord.md) -Changes a resource record in a DNS zone. - -### [Set-DnsServerResourceRecordAging](./Set-DnsServerResourceRecordAging.md) -Begins aging of resource records in a specified DNS zone. - -### [Set-DnsServerRootHint](./Set-DnsServerRootHint.md) -Replaces a list of root hints. - -### [Set-DnsServerScavenging](./Set-DnsServerScavenging.md) -Changes DNS server scavenging settings. - -### [Set-DnsServerSecondaryZone](./Set-DnsServerSecondaryZone.md) -Change settings for a DNS secondary zone. - -### [Set-DnsServerSetting](./Set-DnsServerSetting.md) -Modifies DNS server settings. - -### [Set-DnsServerSigningKey](./Set-DnsServerSigningKey.md) -Changes settings of a signing key. - -### [Set-DnsServerStubZone](./Set-DnsServerStubZone.md) -Changes settings for a DNS server stub zone. - -### [Set-DnsServerZoneAging](./Set-DnsServerZoneAging.md) -Configures DNS aging settings for a zone. - -### [Set-DnsServerZoneDelegation](./Set-DnsServerZoneDelegation.md) -Changes delegation settings for a child zone. - -### [Show-DnsServerCache](./Show-DnsServerCache.md) -Shows the records in a DNS Server Cache. - -### [Show-DnsServerKeyStorageProvider](./Show-DnsServerKeyStorageProvider.md) -Returns a list of key storage providers. - -### [Start-DnsServerScavenging](./Start-DnsServerScavenging.md) -Notifies a DNS server to attempt a search for stale resource records. - -### [Start-DnsServerZoneTransfer](./Start-DnsServerZoneTransfer.md) -Starts a zone transfer for a secondary DNS zone from master servers. - -### [Suspend-DnsServerZone](./Suspend-DnsServerZone.md) -Suspends a zone on a DNS server. - -### [Sync-DnsServerZone](./Sync-DnsServerZone.md) -Checks the DNS server memory for changes, and writes them to persistent storage. - -### [Test-DnsServer](./Test-DnsServer.md) -Tests that a specified computer is a functioning DNS server. - -### [Test-DnsServerDnsSecZoneSetting](./Test-DnsServerDnsSecZoneSetting.md) -Validates DNSSEC settings for a zone. - -### [Unregister-DnsServerDirectoryPartition](./Unregister-DnsServerDirectoryPartition.md) -Deregisters a DNS server from a DNS application directory partition. - -### [Update-DnsServerTrustPoint](./Update-DnsServerTrustPoint.md) -Updates all trust points in a DNS trust anchor zone. - diff --git a/docset/winserver2012-ps/dnsserver/Enable-DnsServerSigningKeyRollover.md b/docset/winserver2012-ps/dnsserver/Enable-DnsServerSigningKeyRollover.md deleted file mode 100644 index 97eee90d5f..0000000000 --- a/docset/winserver2012-ps/dnsserver/Enable-DnsServerSigningKeyRollover.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/enable-dnsserversigningkeyrollover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-DnsServerSigningKeyRollover - -## SYNOPSIS -Enables rollover on the input key. - -## SYNTAX - -``` -Enable-DnsServerSigningKeyRollover [-ZoneName] [-KeyId] [[-RolloverPeriod] ] - [[-InitialRolloverOffset] ] [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-DNSServerSigningKeyRollover** cmdlet enables rollover on the input key. -For more information about DNS server signing keys, see the **Key Management** section of Overview of DNSSEChttp://technet.microsoft.com/en-us/library/jj200221.aspx. - -## EXAMPLES - -### Example 1: Get keys and enable rollover -``` -PS C:\> Get-DnsServerSigningKey -ZoneName "DNSServer06.Contoso.com" | Enable-DnsServerSigningKeyRollover -``` - -This command uses the **Get-DnsServerSigningKey** cmdlet to get keys for the DNSServer06.contoso.com zone. -These keys are then piped to the **Enable-DnsServerSigningKeyRollover** cmdlet, which enables rollover for each key. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP v4 address, an IP v6 address, and any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Instructs the cmdlet to perform the operation without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitialRolloverOffset -Specifies the amount of time before the first scheduled key rollover occurs. -You can stagger key rollovers by using this parameter. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyId -Identifies a key. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RolloverPeriod -Specifies the amount of time between scheduled key rollovers. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey - -## NOTES - -## RELATED LINKS - -[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - -[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) - -[Get-DnsServerSigningKey](./Get-DnsServerSigningKey.md) - diff --git a/docset/winserver2012-ps/dnsserver/Export-DnsServerDnsSecPublicKey.md b/docset/winserver2012-ps/dnsserver/Export-DnsServerDnsSecPublicKey.md deleted file mode 100644 index fa1f86648b..0000000000 --- a/docset/winserver2012-ps/dnsserver/Export-DnsServerDnsSecPublicKey.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/export-dnsserverdnssecpublickey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-DnsServerDnsSecPublicKey - -## SYNOPSIS -Exports DS and DNSKEY information for a DNSSEC-signed zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Export-DnsServerDnsSecPublicKey [-ZoneName] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-NoClobber] [-PassThru] [-Path ] [-ThrottleLimit ] - [-UnAuthenticated] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Export-DnsServerDnsSecPublicKey [-ZoneName] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-NoClobber] [-PassThru] [-Path ] [-ThrottleLimit ] - [-UnAuthenticated] -DigestType [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Export-DnsServerDnsSecPublicKey** cmdlet exports delegation signer (DS) or Domain Name System public key (DNSKEY) information for a Domain Name System Security Extensions (DNSSEC)-signed zone. - -## EXAMPLES - -### Example 1: Export a trust anchor to a file share -``` -PS C:\> Export-DnsServerDnsSecPublicKey -ComputerName "DNSDC1.Contoso.com" -ZoneName "Contoso.com" -Path "\\MyDNSKeyShare\keys" -PassThru -DigestType "Sha1" -Exporting a trust anchor without using authentication is insecure unless DNSSEC is active on "${ComputerName}", a trust anchor covering "${ZoneName}" is installed, and the connection between the local machine and "${ComputerName}" is secure. Consider alternative means of exporting the trust anchors, such as the DNSCMD protocol, email, or HTTPS. Proceed? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y -``` - -This command exports the trust anchor (DS record) for Contoso.com to a file share. -A DNS administrator runs this command from the DNS server that hosts the zone Contoso.com and specifies that the zone signing key uses the SHA-1 algorithm to create the DS record. - -This command creates Keyset-Contoso.com in \\\\MyDNSKeyShare\keys and writes the DS record in the Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DNS/DnsServerResourceRecord format. - -### Example 2: Export a trust anchor by using unauthorized access -``` -PS C:\>Export-DnsServerDnsSecPublicKey -ComputerName "DNSDC1.contoso.com" -ZoneName "Contoso.com" - Path "\\MyDNSKeyShare\keys" -PassThru -UnAuthorized -Force -DigestType "Sha1" -Exporting a trust anchor without using authentication is insecure unless DNSSEC is active on "${ComputerName}", a trust anchor covering "${ZoneName}" is installed, and the connection between the local machine and "${ComputerName}" is secure. Consider alternative means of exporting the trust anchors, such as the DNSCMD protocol, email, or HTTPS. Proceed? [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y -Note: User typing N exits out of the command with no export or output -``` - -This command exports a trust anchor (DNSKEY record) for Contoso.com to a file share. -The DNS administrator who runs this command has no permissions to the DNS server that hosts the zone Contoso.com. -This command specifies that the zone signing key uses the SHA-1 algorithm to create the DS record. - -This command creates Keyset-Contoso.com in \\\\MyDNSKeyShare\keys and writes the DS record in the Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DNS/DnsServerResourceRecord format. - -### Example 3: Get the trust anchors for all the signed zones -``` -PS C:\>Get-DnsServerZone | ForEach-Object {Export-DnsServerDnsSecPublicKey -ComputerName "DNSDC1.Contoso.com" -ZoneName "Contoso.com" -Path "\\MyDNSKeyShare\keys" -PassThru -UnAuthorized -Force } -``` - -This command gets the trust anchors for all the signed zones that are hosted on the DNS server Contoso.com. -In this scenario the DNS Server is currently hosting signed zones for contoso.com, dinnernow.com and hrweb.net - -The command uses a Foreach-Object cmdlet to export the trust anchors and pipe the results to the **Get-DnsServerZone** cmdlet. - -This command creates a keyset file in the share for each signed zone that is hosted on the DNS server (Keyset-Contoso.com, Keyset-Dinnernow.com, Keyset-Hrweb.net) and writes the DNSKEY record in the Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DNS/DNS/DnsServerResourceRecord format. - -### Example 4: Import a trust anchor to a non-authorized DN server -``` -PS C:\>$publicKey = Export-DnsServerDnssecPublicKey -ZoneName "contoso.com" -Path "C:\" -PassThru -UnAuthenticated -Force PS C:\>$publicKey[0].RecordData | Add-DnsServerTrustAnchor -Name "constoso.com" -ComputerName "DNSDC1.Contoso.com" -``` - -The first command exports the trust anchor (DNSKEY record) for Contoso.com to the specified path, and stores the results in the **$publicKey** variable. -The **UnAuthenticated** parameter indicates that the DNS administrator who runs this command has no permissions to the DNS server that hosts the zone Contoso.com. - -The second command adds the first trust record that was exported from Contoso.com into a non-authoritative DNS server named DNSDC1.Contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DigestType -Specifies an array of algorithms that the zone signing key uses to create the DS record. -The acceptable values for this parameter are: -- Sha1 -- Sha256 -- Sha384 - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Exports the signing key without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoClobber -Specifies that the export operation does not overwrite an existing export file that has the same name. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the absolute path that the cmdlet uses to place the keyset file. -The cmdlet automatically names the file according to the zone name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UnAuthenticated -Specifies that an unauthenticated user is running this cmdlet. -The provider DNS server queries for the DS or DNSKEY information and exports the required data even if you do not have permissions to run the cmdlet on the remote DNS server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the primary zone for which the cmdlet exports the signing keys. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - -[Add-DnsServerTrustAnchor](./Add-DnsServerTrustAnchor.md) - -[Get-DnsServerZone](./Get-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Export-DnsServerZone.md b/docset/winserver2012-ps/dnsserver/Export-DnsServerZone.md deleted file mode 100644 index a0b8f41e0d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Export-DnsServerZone.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/export-dnsserverzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-DnsServerZone - -## SYNOPSIS -Exports contents of a zone to a file. - -## SYNTAX - -``` -Export-DnsServerZone [-Name] [-FileName] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Export-DnsServerZone** cmdlet creates a file containing resource records for an Active Directory-integrated zone for troubleshooting purposes. -This file is not in the same format as a file-backed zonefile. -By default, the cmdlet places the file in the DNS directory. - -## EXAMPLES - -### Example 1: Export a zone -``` -PS C:\> Export-DnsServerZone -Name "western.contoso.com" -FileName "exportedcontoso.com" -``` - -This command exports the zone named western.contoso.com to a file called exportedcontoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileName -Specifies a name for the export file. -The file will be created in the default DNS directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of a zone. -The cmdlet exports the records for this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone - -## NOTES - -## RELATED LINKS - -[Get-DnsServerZone](./Get-DnsServerZone.md) - -[Remove-DnsServerZone](./Remove-DnsServerZone.md) - -[Resume-DnsServerZone](./Resume-DnsServerZone.md) - -[Suspend-DnsServerZone](./Suspend-DnsServerZone.md) - -[Sync-DnsServerZone](./Sync-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServer.md b/docset/winserver2012-ps/dnsserver/Get-DnsServer.md deleted file mode 100644 index a98d0dd633..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServer.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServer - -## SYNOPSIS -Retrieves a DNS server configuration. - -## SYNTAX - -``` -Get-DnsServer [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServer** cmdlet retrieves a Domain Name System (DNS) server configuration. - -You can pipe the output of the **Get-DnsServer** cmdlet to the **Export-Clixml** cmdlet, which generates an XML file of the configuration. -You can use the XML file to back up or transfer DNS settings between computers. -For more information about **Export-Clixml**, see [Using the Export-Clixml cmdlet](/powershell/module/microsoft.powershell.utility/export-clixml). - -## EXAMPLES - -### Example 1: Get a DNS server configuration -```powershell -PS C:\>Get-DnsServer -ComputerName "10.255.255.254" -``` - -This command gets a DNS server configuration. - -### Example 2: Get local DNS server configuration and pipe it to Export-Clixml -```powershell -PS C:\>Get-DnsServer | Export-Clixml -Path "c:\config\DnsServerConfig.xml" -``` - -This command gets the DNS server configuration on the local server and pipes it to the **Export-Clixml** cmdlet to be translated into an XML file. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServer - -## NOTES - -## RELATED LINKS - -[Set-DnsServer](./Set-DnsServer.md) - -[Test-DnsServer](./Test-DnsServer.md) diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerCache.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerCache.md deleted file mode 100644 index 41c4d40ab0..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerCache.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsservercache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerCache - -## SYNOPSIS -Retrieves DNS server cache settings. - -## SYNTAX - -``` -Get-DnsServerCache [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerCache** retrieves all cached Domain Name System (DNS) server resource records in the following format: Name, ResourceRecordData, Time-to-Live (TTL). - -## EXAMPLES - -### Example 1: Get DNS server cache properties -``` -PS C:\>Get-DnsServerCache -ComputerName "Win12S-05.DNSServer-01.Contoso.com" -MaxTTL : 1.00:00:00 - -MaxNegativeTTL : 00:15:00 - -MaxKBSize : 10240 - -EnablePollutionProtection : True - -LockingPercent : 100 - -StoreEmptyAuthenticationResponse : True -``` - -This command gets DNS server cache properties on a DNS server that has an FQDN of Win12S-05.DNSServer-01.Contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are:: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerCache - -## NOTES - -## RELATED LINKS - -[Clear-DnsServerCache](./Clear-DnsServerCache.md) - -[Set-DnsServerCache](./Set-DnsServerCache.md) - -[Show-DnsServerCache](./Show-DnsServerCache.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerDiagnostics.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerDiagnostics.md deleted file mode 100644 index 289a1ccd2c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerDiagnostics.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverdiagnostics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerDiagnostics - -## SYNOPSIS -Retrieves DNS event logging details. - -## SYNTAX - -``` -Get-DnsServerDiagnostics [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerDiagnostics** cmdlet retrieves Domain Name System (DNS) server diagnostic and logging parameters. - -## EXAMPLES - -### Example 1: Get DNS event logging details -``` -PS C:\> Get-DnsServerDiagnostics -SaveLogsToPersistentStorage : False - -Queries : False - -Answers : False - -Notifications : False - -Update : False - -QuestionTransactions : False - -UnmatchedResponse : False - -SendPackets : False - -ReceivePackets : False - -TcpPackets : False - -UdpPackets : False - -FullPackets : False - -FilterIPAddressList : - -EventLogLevel : 4 - -UseSystemEventLog : False - -EnableLoggingToFile : True - -EnableLogFileRollover : False - -LogFilePath : - -MaxMBFileSize : 500000000 - -WriteThrough : False - -EnableLoggingForLocalLookupEvent : False - -EnableLoggingForPluginDllEvent : False - -EnableLoggingForRecursiveLookupEvent : False - -EnableLoggingForRemoteServerEvent : False - -EnableLoggingForServerStartStopEvent : False - -EnableLoggingForTombstoneEvent : False - -EnableLoggingForZoneDataWriteEvent : False - -EnableLoggingForZoneLoadingEvent : False -``` - -This command gets DNS event logging details for the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDiagnostics - -## NOTES - -## RELATED LINKS - -[Set-DnsServerDiagnostics](./Set-DnsServerDiagnostics.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerDirectoryPartition.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerDirectoryPartition.md deleted file mode 100644 index 95d3cfd8a0..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerDirectoryPartition.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverdirectorypartition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerDirectoryPartition - -## SYNOPSIS -Gets a DNS application directory partition. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-DnsServerDirectoryPartition [-AsJob] [-CimSession ] [-ComputerName ] [-Custom] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-DnsServerDirectoryPartition [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerDirectoryPartition** cmdlet gets one or more Domain Name System (DNS) application server directory partitions on a DNS server. - -## EXAMPLES - -### Example 1: Get all DNS application directory partitions -``` -PS C:\> Get-DnsServerDirectoryPartition -server.DirectoryPartitionName State Flags ZoneCount - ------------------------------ ----- ----- --------- - -DomainDnsZones.mytest.cont... 0(DNS_DP_OKAY) Enlisted Auto Domain 3 - -ForestDnsZones.mytest.cont... 0(DNS_DP_OKAY) Enlisted Auto Forest 2 -``` - -This command gets all the DNS application directory partitions on the local computer. - -### Example 2: Get all custom application directory partitions -``` -PS C:\>Get-DnsServerDirectoryPartition -Custom -DirectoryPartitionName State Flags ZoneCount - ----------------------- ----- ----- --------- - -DomainDnsZones.mytest.cont... 0(DNS_DP_OKAY) Enlisted Auto Domain 3 -``` - -This command gets all the custom application directory partitions on the local computer. - -### Example 3: Get an application directory partition by using name -``` -PS C:\>Get-DnsServerDirectoryPartition -Name "DomainDnsZones.dept.contoso.com" -``` - -This command gets the DNS application directory partition named DomainDnsZones.dept.contoso.com on the local computer. - -## PARAMETERS - -### -AsJob -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Custom -Returns custom directory partitions. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the FQDN of a DNS application directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDirectoryPartition - -## NOTES - -## RELATED LINKS - -[Add-DnsServerDirectoryPartition](./Add-DnsServerDirectoryPartition.md) - -[Register-DnsServerDirectoryPartition](./Register-DnsServerDirectoryPartition.md) - -[Unregister-DnsServerDirectoryPartition](./Unregister-DnsServerDirectoryPartition.md) - -[Remove-DnsServerDirectoryPartition](./Remove-DnsServerDirectoryPartition.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerDnsSecZoneSetting.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerDnsSecZoneSetting.md deleted file mode 100644 index 9d5581d6cf..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerDnsSecZoneSetting.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverdnsseczonesetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerDnsSecZoneSetting - -## SYNOPSIS -Gets DNSSEC settings for a zone. - -## SYNTAX - -``` -Get-DnsServerDnsSecZoneSetting [-ZoneName] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerDnsSecZoneSetting** cmdlet gets the Domain Name System Security Extensions (DNSSEC) settings for a zone on a Domain Name System (DNS) server. - -## EXAMPLES - -### Example 1: Get DNSSEC settings -``` -PS C:\> Get-DnsServerDnsSecZoneSetting -ZoneName "western.contoso.com" -``` - -This command gets the DNS Security Extensions for the zone named western.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies an array of names of DNS zones. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDnsSecZoneSetting[] - -## NOTES - -## RELATED LINKS - -[Set-DnsServerDnsSecZoneSetting](./Set-DnsServerDnsSecZoneSetting.md) - -[Test-DnsServerDnsSecZoneSetting](./Test-DnsServerDnsSecZoneSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerDsSetting.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerDsSetting.md deleted file mode 100644 index 829c49ace9..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerDsSetting.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverdssetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerDsSetting - -## SYNOPSIS -Retrieves DNS Server Active Directory settings - -## SYNTAX - -``` -Get-DnsServerDsSetting [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerDsSetting** cmdlet retrieves the following Domain Name System (DNS) Server Active Directory settings: PollingInterval, DirectoryPartitionAutoEnlistInterval, LazyUpdateInterval, MinimumBackgroundLoadThreads, and RemoteReplicationDelay. - -## EXAMPLES - -### Example 1: Get Active Directory service settings -``` -PS C:\> Get-DnsServerDsSetting -PollingInterval(s) : 180 - -TombstoneInterval : 14.00:00:00 - -DirectoryPartitionAutoEnlistInterval : 1.00:00:00 - -LazyUpdateInterval(s) : 3 - -MinimumBackgroundLoadThreads : 1 - -RemoteReplicationDelay(s) : 30 -``` - -This command gets the Active Directory service settings of a DNS server. - -PS C:\Users\Administrator\> - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDsSetting - -## NOTES - -## RELATED LINKS - -[Set-DnsServerDsSetting](./Set-DnsServerDsSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerEDns.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerEDns.md deleted file mode 100644 index d5efd6029f..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerEDns.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserveredns?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerEDns - -## SYNOPSIS -Gets EDNS configuration settings on a DNS server. - -## SYNTAX - -``` -Get-DnsServerEDns [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerEDns** cmdlet gets extension mechanisms for DNS (EDNS) configuration settings on a Domain Name System (DNS) server. -This cmdlet gets the EDNS settings for CacheTimeout, EnableProbes, and EnableReception. - -## EXAMPLES - -### Example 1: Get EDNS settings -``` -PS C:\> Get-DnsServerEDns -``` - -This command gets the EDNS settings on a local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerEDns - -## NOTES - -## RELATED LINKS - -[Set-DnsServerEDns](./Set-DnsServerEDns.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerForwarder.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerForwarder.md deleted file mode 100644 index 47ccd528f9..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerForwarder.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverforwarder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerForwarder - -## SYNOPSIS -Gets forwarder configuration settings on a DNS server. - -## SYNTAX - -``` -Get-DnsServerForwarder [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerForwarder** cmdlet gets configuration settings on a DNS server. -A forwarder is a Domain Name System (DNS) server on a network that is used to forward DNS queries for external DNS names to DNS servers outside that network. - -## EXAMPLES - -### Example 1: Get DNS server forwarder settings -``` -PS C:\> Get-DnsServerForwarder -``` - -This command gets the forwarder settings on a local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerForwarder - -## NOTES - -## RELATED LINKS - -[Remove-DnsServerForwarder](./Remove-DnsServerForwarder.md) - -[Set-DnsServerForwarder](./Set-DnsServerForwarder.md) - -[Add-DnsServerForwarder](./Add-DnsServerForwarder.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerGlobalNameZone.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerGlobalNameZone.md deleted file mode 100644 index c3856adf10..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerGlobalNameZone.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverglobalnamezone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerGlobalNameZone - -## SYNOPSIS -Retrieves DNS server GlobalName zone configuration details. - -## SYNTAX - -``` -Get-DnsServerGlobalNameZone [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerGlobalNameZone** cmdlet gets a Domain Name System (DNS) server GlobalNames zone object for the local server or a specified DNS server. -This object contains the following settings: - -- Enable -- GlobalOverLocal -- PreferAAAA -- AlwaysQueryServer -- EnableEDnsProbes -- BlockUpdates -- SendTimeout(s) -- ServerQueryInterval - -## EXAMPLES - -### Example 1: Get GlobalName zone settings -``` -PS C:\> Get-DnsServerGlobalNameZone -``` - -This command gets DNS server GlobalName zone settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerGlobalNameZone - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerGlobalQueryBlockList.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerGlobalQueryBlockList.md deleted file mode 100644 index fe7c443a33..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerGlobalQueryBlockList.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverglobalqueryblocklist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerGlobalQueryBlockList - -## SYNOPSIS -Gets a global query block list. - -## SYNTAX - -``` -Get-DnsServerGlobalQueryBlockList [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerGlobalQueryBlockList** cmdlet gets a global query block list on a Domain Name System (DNS) server. -DNS Server service maintains a list of servers that it does not respond to when the DNS server receives a query to resolve the name in any zone for which the server is authoritative. - -## EXAMPLES - -### Example 1: Get the global query block list -``` -PS C:\> Get-DnsServerGlobalQueryBlockList -``` - -This command gets the global query block list for a local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerGlobalQueryBlockList - -## NOTES - -## RELATED LINKS - -[Set-DnsServerGlobalQueryBlockList](./Set-DnsServerGlobalQueryBlockList.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerRecursion.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerRecursion.md deleted file mode 100644 index a42f129271..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerRecursion.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverrecursion?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerRecursion - -## SYNOPSIS -Retrieves DNS server recursion settings. - -## SYNTAX - -``` -Get-DnsServerRecursion [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerRecursion** cmdlet retrieves Domain Name System (DNS) server recursion settings. -Recursion occurs when a DNS server queries other DNS servers on behalf of a requesting client, and then sends the answer back to the client. - -## EXAMPLES - -### Example 1: Get DNS server recursion settings -``` -PS C:\> Get-DnsServerRecursion -Enable : False - -AdditionalTimeout(s) : 4 - -RetryInterval(s) : 15 - -Timeout(s) : 8 - -SecureResponse : True -``` - -This command gets DNS server recursion settings on the local server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRecursion - -## NOTES - -## RELATED LINKS - -[Set-DnsServerRecursion](./Set-DnsServerRecursion.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerResourceRecord.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerResourceRecord.md deleted file mode 100644 index 78093c9a45..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerResourceRecord.md +++ /dev/null @@ -1,259 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverresourcerecord?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerResourceRecord - -## SYNOPSIS -Gets resource records from a specified DNS zone. - -## SYNTAX - -``` -Get-DnsServerResourceRecord [-ZoneName] [[-Name] ] [[-RRType] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Node] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerResourceRecord** cmdlet gets the following information for a specified resource record from a Domain Name System (DNS) zone: -- HostName -- RecordType -- RecordClass -- TimeToLive -- Timestamp -- RecordData - -## EXAMPLES - -### Example 1: Get all resource records in a specified zone -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "contoso.com" -``` - -This command gets all DNS server resource records in a zone named contoso.com. - -### Example 2: Get all resource records in a zone for a specified node -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "contoso.com" -Name "Admin01" -``` - -This command gets all DNS server resource records in a zone named contoso.com from the node named Admin01. - -### Example 3: Get all resource records in a zone by specified host name -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "contoso.com" -Name "Host02" -``` - -This command gets all DNS server resource records in a zone named contoso.com that have the name Host02. -The command is similar to the one in example 2, but in this case the command uses a host name instead of a node name. - -### Example 4: Get all A records in a zone by specified host nameand specified typeand specified type -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "contoso.com" -Name "Host03" -RRType "A" -``` - -This command gets all A records in a zone named contoso.com that have the name Host03. - -### Example 5: Get all A records in a specified zone -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "contoso.com" -RRType "A" -``` - -This command gets all A records in a zone named contoso.com. - -### Example 6: Get all NS records at the root of a specified zone -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "contoso.com" -RRType "NS" -Node -``` - -This command gets all NS records at the root of a zone named contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a DNS server resource record object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Node -Specifies only the parameters at root of the **Name** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RRType -Specifies the type of resource record. - -The acceptable values for this parameter are: -- HInfo -- Afsdb -- Atma -- Isdn -- Key -- Mb -- Md -- Mf -- Mg -- MInfo -- Mr -- Mx -- NsNxt -- Rp -- Rt -- Wks -- X25 -- A -- AAAA -- CName -- Ptr -- Srv -- Txt -- Wins -- WinsR -- Ns -- Soa -- NasP -- NasPtr -- DName -- Gpos -- Loc -- DhcId -- Naptr -- RRSig -- DnsKey -- DS -- NSec -- NSec3 -- NSec3Param - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS server zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord[] - -## NOTES - -## RELATED LINKS - -[Set-DnsServerResourceRecord](./Set-DnsServerResourceRecord.md) - -[Add-DnsServerResourceRecord](./Add-DnsServerResourceRecord.md) - -[Remove-DnsServerResourceRecord](./Remove-DnsServerResourceRecord.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerRootHint.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerRootHint.md deleted file mode 100644 index bf2eccb89c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerRootHint.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverroothint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerRootHint - -## SYNOPSIS -Gets root hints on a DNS server. - -## SYNTAX - -``` -Get-DnsServerRootHint [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerRootHint** cmdlet gets DNS root hints on a DNS server. - -## EXAMPLES - -### Example 1: Get root hints for a DNS server -``` -PS C:\> Get-DnsServerRootHint -``` - -This command gets root hints for the local DNS server. - -### Example 2: Get root hints by using a resource record -``` -PS C:\>Get-DnsServerRootHint | Where-Object {$_.NameServer.RecordData.NameServer -eq "H.Root-Servers.net."} -``` - -In this example, the **Get-DnsServerRootHint** cmdlet gets a list of all root hints on the local DNS server. -The command then pipes that collection to the **Where-Object** cmdlet. - -**Where-Object** filters the resource record to get the root hint for the DNS server that has the name H.Root-Servers.net. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRootHint[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerRootHint](./Add-DnsServerRootHint.md) - -[Set-DnsServerRootHint](./Set-DnsServerRootHint.md) - -[Remove-DnsServerRootHint](./Remove-DnsServerRootHint.md) - -[Import-DnsServerRootHint](./Import-DnsServerRootHint.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerScavenging.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerScavenging.md deleted file mode 100644 index a82dcd910e..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerScavenging.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverscavenging?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerScavenging - -## SYNOPSIS -Gets DNS aging and scavenging settings. - -## SYNTAX - -``` -Get-DnsServerScavenging [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerScavenging** cmdlet gets aging and scavenging settings on a DNS server. - -## EXAMPLES - -### Example 1: Get scavenging settings -``` -PS C:\> Get-DnsServerScavenging -``` - -This command gets the scavenging settings for the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerScavenging - -## NOTES - -## RELATED LINKS - -[Set-DnsServerScavenging](./Set-DnsServerScavenging.md) - -[Start-DnsServerScavenging](./Start-DnsServerScavenging.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerSetting.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerSetting.md deleted file mode 100644 index 477fddee2a..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerSetting.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserversetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerSetting - -## SYNOPSIS -Retrieves DNS server settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-DnsServerSetting [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-DnsServerSetting [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] - [-All] -``` - -## DESCRIPTION -The **Get-DnsServerSettings** cmdlet retrieves basic Domain Name System (DNS) server settings; that is, the default parameter set. -To get advanced DNS server settings, use the **All** parameter. - -## EXAMPLES - -### Example 1: Get all DNS server settings -``` -PS C:\> Get-DnsServerSetting -All -ComputerName : WIN-OLPN33S5Q3M.mytest.contoso.com - -MajorVersion : 6 - -MinorVersion : 2 - -BuildNumber : 8230 - -IsReadOnlyDC : False - -EnableDnsSec : True - -EnableIPv6 : True - -EnableOnlineSigning : True - -NameCheckFlag : 2 - -AddressAnswerLimit : 0 - -XfrConnectTimeout(s) : 30 - -BootMethod : 3 - -AllowUpdate : True - -UpdateOptions : 783 - -DsAvailable : True - -DisableAutoReverseZone : False - -AutoCacheUpdate : False - -RoundRobin : True - -LocalNetPriority : True - -StrictFileParsing : False - -LooseWildcarding : False - -BindSecondaries : False - -WriteAuthorityNS : False - -ForwardDelegations : False - -AutoConfigFileZones : 1 - -EnableDirectoryPartitions : True - -RpcProtocol : 5 - -EnableVersionQuery : 0 - -EnableDuplicateQuerySuppression : True - -LameDelegationTTL : 00:00:00 - -AutoCreateDelegation : 2 - -AllowCnameAtNs : True - -RemoteIPv4RankBoost : 5 - -RemoteIPv6RankBoost : 0 - -EnableRsoForRodc : True - -MaximumRodcRsoQueueLength : 300 - -MaximumRodcRsoAttemptsPerCycle : 100 - -OpenAclOnProxyUpdates : True - -NoUpdateDelegations : False - -EnableUpdateForwarding : False - -MaxResourceRecordsInNonSecureUpdate : 30 - -EnableWinsR : True - -LocalNetPriorityMask : 255 - -DeleteOutsideGlue : False - -AppendMsZoneTransferTag : False - -AllowReadOnlyZoneTransfer : False - -MaximumUdpPacketSize : 4000 - -TcpReceivePacketSize : 65536 - -EnableSendErrorSuppression : True - -SelfTest : 4294967295 - -XfrThrottleMultiplier : 10 - -SilentlyIgnoreCnameUpdateConflicts : False - -EnableIQueryResponseGeneration : False - -SocketPoolSize : 2500 - -AdminConfigured : True - -SocketPoolExcludedPortRanges : {} - -ForestDirectoryPartitionBaseName : ForestDnsZones - -DomainDirectoryPartitionBaseName : DomainDnsZones - -ServerLevelPluginDll : - -EnableRegistryBoot : - -PublishAutoNet : False - -QuietRecvFaultInterval(s) : 0 - -QuietRecvLogInterval(s) : 0 - -ReloadException : False - -SyncDsZoneSerial : 2 - -EnableDuplicateQuerySuppression : True - -SendPort : Random - -MaximumSignatureScanPeriod : 2.00:00:00 - -MaximumTrustAnchorActiveRefreshInterval : 15.00:00:00 - -ListeningIPAddress : {172.23.90.136} - -AllIPAddress : {172.23.90.136} -``` - -This command gets all settings of a DNS server. - -## PARAMETERS - -### -All -Gets all DNS server settings. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSetting - -## NOTES - -## RELATED LINKS - -[Set-DnsServerSetting](./Set-DnsServerSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerSigningKey.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerSigningKey.md deleted file mode 100644 index 6d2b35110f..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerSigningKey.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserversigningkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerSigningKey - -## SYNOPSIS -Gets zone signing keys. - -## SYNTAX - -``` -Get-DnsServerSigningKey [-ZoneName] [[-KeyId] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DNSServerSigningKey** cmdlet gets and displays all the keys in a zone. -You can use **KeyId** parameter to return specific keys. - -## EXAMPLES - -### Example 1: Get keys for a signed zone -``` -PS C:\> Get-DnsServerSigningKey -ZoneName "sec.contoso.com" -``` - -This command gets keys for the signed zone sec.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies an array of keys. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerSigningKey](./Add-DnsServerSigningKey.md) - -[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - -[Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) - -[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) - -[Remove-DnsServerSigningKey](./Remove-DnsServerSigningKey.md) - -[Set-DnsServerSigningKey](./Set-DnsServerSigningKey.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerStatistics.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerStatistics.md deleted file mode 100644 index 164df55dee..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerStatistics.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverstatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerStatistics - -## SYNOPSIS -Retrieves DNS server statistics. - -## SYNTAX - -``` -Get-DnsServerStatistics [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerStatistics** cmdlet retrieves statistics of a Domain Name System (DNS) server. - -## EXAMPLES - -### Example 1: Get server statistics for a DNS server -``` -PS C:\> Get-DnsServerStatistics -``` - -This command gets server statistics for the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -class DNS_statistic - -{ - -string DnsServerName; // Indicates the FQDN or IP address of a DNS Server. - -string CollectionName; - -uint32 CollectionId; // Numeric representation of **CollectionName**. -string Name; / - -uint32 Value; - -string StringValue; - -}; - -## OUTPUTS - -### DNSServer01.Infrastructure.CimInstance#DnsServerStatistics -**CacheStatistics** contains: FailedFreePasses, PassesRequiringAggressiveFree, PassesWithNoFrees, and SuccessfulFreePasses. - -**DatabaseStatistics** contains: NodeInUse, NodeMemory, NodeReturn, and NodeUsed. - -**DnssecStatistics** contains: FailedValidations, RecursionFailures, and SuccessfulValidations. - -**DsStatistics** contains: DsNodesAdded, DsNodesDeleted, DsNodesLoaded, DsNodesModified, DsNodesTombstoned, DsRecordsAdded, DsRecordsLoaded, DsRecordsReplaced, DsSerialWrites, DsTombstonesRead, DsTotalNodesRead, DsTotalRecordsRead, DsUpdateNodesRead, DsUpdateRecordsRead, DsUpdateSearches, DsWriteSuppressed, DsWriteType, FailedDeleteDsEntries, FailedLdapAdd, FailedLdapModify, FailedReadRecords, LdapReconnects, LdapSearchTime, LdapTimedWrites, LdapWriteAverage, LdapWriteBucket0, LdapWriteBucket1, LdapWriteBucket2, LdapWriteBucket3, LdapWriteBucket4, LdapWriteBucket5, LdapWriteMax, LdapWriteTimeTotal, PollingPassesWithDsErrors, UpdateAdmin, UpdateAgingOff, UpdateAgingOn, UpdateAginRefresh, UpdateAutoConfig, UpdateLists, UpdateNodes, UpdatePacket, UpdateRecordChange, UpdateScavenge, UpdatePacketPrecon, UpdateSuppressed, UpdateTombstones, and UpdateWrites. - -**ErrorStatistics** contains: BadKey, BadSig, BadTime, FormError, Max, NoError, NotAuthoritative, NotImpl, NotZone, NxDomain, NxRRSet, Refused, ServFail, UnknownError, YxDomain, and YxRRSet. - -**MasterStatistics** contains: AxfrLimit, AxfrRequest, AxfrSuccess, Failure, FormError, IxfrAxfr, IxfrNoVersion, IxfrRequest, IxfrTcpRequest, IxfrTcpSuccess, IxfrUdpForceAxfr, IxfrUdpForceTcp, IxfrUdpRequest, IxfrUdpSuccess, IxfrUpdateSuccess, NameError, NotifySent, Refused, RefuseLoading, RefuseNotAuth, RefuseReadOnly, RefuseSecurity, RefuseServerFailure, RefuseShutdown, RefuseZoneLocked, Request, and StubAxfrRequest. - -**MemoryStatistics** contains: Alloc, Free, Memory, MemTags, StdBlockAlloc, StdBlockFreeList, StdBlockFreeListMemory, StdBlockInUse, StdBlockMemory, StdBlockReturn, StdBlockUsed, StdInUse, StdMemory, StdReturn, StdToHeapAlloc, StdToHeapFree, StdToHeapMemory, and StdUsed. - -**NetBiosStatistics** contains: NbstatAlloc, NbstatFree, NbstatInFreeList, NbstatInUse, NbstatMemory, NbstatNetAllocs, NbstatReturn, NbstatUsed, and PSComputerName. - -**PacketStatistics** contains: PacketsForNsListInUse, PacketsForNsListReturned, PacketsForNsListUsed, RecursePacketReturn, RecursePacketUsed, TcpAlloc, TcpFree, cpMemory, TcpNetAllocs, UdpAlloc, UdpFree, UdpInFreeList, UdpInUse, UdpMemory, UdpNetAllocs, UdpQueryReturn, UdpResponseReturn, UdpReturn, and UdpUsed. - -**PrivateStatistics** contains: SecBigTimeSkewBypass, TcpConnect, TcpDisconnect, TcpQuery, UdpConnResetRetryOverflow, UdpConnResets, UdpErrorMessageSize, UdpGQCSConnReset, UdpGQCSFailure, UdpGQCSFailureWithContext, UdpIndicateRecvFailures, UdpRecvFailure, UdpRestartRecvOnSockets, UdpSocketPnpDelete, ZoneLoadInit, and PSComputerName. - -**Query2Statistics** contains: Notify, Standard, TKeyNego, TotalQueries, TypeA, TypeAll, TypeAxfr, TypeIxfr, TypeMx, TypeNs, TypeOther, TypePtr, TypeSoa, TypeSrv, and Update. - -**QueryStatistics** contains: TcpClientConnections, TcpQueries, TcpQueriesSent, TcpResponses, TcpResponsesReceived, UdpQueries, UdpQueriesSent, UdpResponses, and UdpResponsesReceived. - -**RecordStatistics** contains: CacheCurrent, CacheTimeouts, CacheTotal, InUse, Memory, Return, SlowFreeFinished, SlowFreeQueued, and Used. - -**RecursionStatistics** contains: AdditionalRecursed, CacheLockingDiscards, CacheUpdateAlloc, CacheUpdateFailure, CacheUpdateFree, CacheUpdateResponse, CacheUpdateRetry, ContinueCurrentLookup, ContinueCurrentRecursion, ContinueNextLookup, DiscardedDuplicateQueries, DuplicateCoalesedQueries, FailureReachAuthority, FailureReachPreviousResponse, FinalTimeoutExpired, FinalTimeoutQueued, Forwards, GnzLocalQuery, GnzRemoteQuery, GnzRemoteResponse, GnzRemoteResponseCacheFailure, GnzRemoteResponseCacheSuccess, LookupPasses, OriginalQuestionRecursed, PartialFailure, QueriesRecursed, RecursePassFailure, RecursionFailure, ReferalPasses, ResponseAnswer, ResponseAuthoritative, ResponseBadPacket, ResponseDelegation, ResponseEmpty, ResponseFromForwarder, ResponseNameError, ResponseNonZoneData, ResponseNotAuthoritative, ResponseRCode, Responses, ResponsesMismatched, ResponsesUnmatched, ResponseUnsecure, ResumeSuspendedQuery, Retries, RootNsQuery, RootNsResponse, SendResponseDirect, Sends, ServerFailure, SuspendedQuery, TcpConnect, TcpDisconnect, TcpQuery, TcpResponse, TcpTry, TimedoutQueries, and TotalQuestionsRecursed. - -**SecondaryStatistics** contains: AxfrInvalid, AxfrRefused, AxfrRequest, AxfrResponse, AxfrSuccess, IxfrTcpAxfr, IxfrTcpFormError, IxfrTcpInvalid, IxfrTcpRefused, IxfrTcpRequest, IxfrTcpResponse, IxfrTcpSuccess, IxfrUdpFormError, xfrUdpInvalid, IxfrUdpNewPrimary, IxfrUdpNoUpdate, IxfrUdpRefused, IxfrUdpRequest, IxfrUdpResponse, IxfrUdpSuccess, IxfrUdpUseAxfr, IxfrUdpUseTcp, IxfrUdpWrongServer, NotifyCurrentVersion, NotifyInvalid, NotifyMasterUnknown, NotifyNewVersion, NotifyNonPrimary, NotifyNoVersion, NotifyOldVersion, NotifyPrimary, NotifyReceived, SoaRequest, SoaResponse, SoaResponseInvalid, StubAxfrInvalid, StubAxfrRefused, StubAxfrRequest, StubAxfrResponse, and StubAxfrSuccess. - -**SecurityStatistics** contains: SecurityContextCreate, SecurityContextDequeue, SecurityContextFree, SecurityContextQueue, SecurityContextQueueInNego, SecurityContextQueueInNegoComplete, SecurityContextQueueLength, SecurityContextTimeout, SecurityPackAlloc, SecurityPackFree, SecurityTKeyBadTime, SecurityTKeyInvalid, SecurityTSigBadKey, SecurityTSigEcho, SecurityTSigFormError, SecurityTSigVerifyFailed, and SecurityTSigVerifySuccess. - -**TimeoutStatistics** contains: ActiveRecord, AlreadyInSystem, ArrayBlocksCreated, ArrayBlocksDeleted, CanNotDelete, Checks, DelayedFreesExecuted, DelayedFreesExecutedWithFunction, DelayedFreesQueued, DelayedFreesQueuedWithFunction, Deleted, RecentAccess, SetDirect, SetFromChildDelete, SetFromDereference, and SetTotal. - -**TimeStatistics** contains: LastClearTime, ServerStartTime, TimeElapsedSinceLastClearedStatistics, TimeElapsedSinceLastClearedStatisticsBetweenRestart, TimeElapsedSinceServerStart, and TimeElapsedSinceServerStartBetweenRestart. - -**UpdateStatistics** contains: Completed, DsSuccess, DsWriteFailure, Empty, FormError, ForwardInQueue, ForwardResponses, Forwards, ForwardTimeouts, InQueue, NoOps, NotAuthoritative, NotImplemented, NotZone, NxDomain, NxRRset, Queued, Received, Refused, RefusedAccessDenied, RefusedNonSecure, Rejected, SecureDsWriteFailure, SecureFailure, SecureSuccess, TcpForwards, Timeout, UpdateType, YxDomain, and YxRRset. - -**WinsStatistics** contains: WinsLookups, WinsResponses, WinsReverseLookups, and WinsReverseResponses. - -## NOTES - -## RELATED LINKS - -[Clear-DnsServerStatistics](./Clear-DnsServerStatistics.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerTrustAnchor.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerTrustAnchor.md deleted file mode 100644 index ea3ed60caa..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerTrustAnchor.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsservertrustanchor?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerTrustAnchor - -## SYNOPSIS -Gets trust anchors on a DNS server. - -## SYNTAX - -``` -Get-DnsServerTrustAnchor [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerTrustAnchor** cmdlet gets trust anchors on a DNS server. -If you do not specify the name of a trust anchor to get, the cmdlet returns all trust anchors. - -## EXAMPLES - -### Example 1: Get all trust anchors for a trust zone -``` -PS C:\> Get-DnsServerTrustAnchor -Name "sec.contoso.com" -``` - -This command gets the trust anchors for a trust zone named sec.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -The acceptable values for this parameter are: an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a trust anchor on a DNS server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustAnchor[] - -## NOTES - -## RELATED LINKS - -[Import-DnsServerTrustAnchor](./Import-DnsServerTrustAnchor.md) - -[Add-DnsServerTrustAnchor](./Add-DnsServerTrustAnchor.md) - -[Remove-DnsServerTrustAnchor](./Remove-DnsServerTrustAnchor.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerTrustPoint.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerTrustPoint.md deleted file mode 100644 index e1faf01be5..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerTrustPoint.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsservertrustpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerTrustPoint - -## SYNOPSIS -Gets trust points on a DNS server. - -## SYNTAX - -``` -Get-DnsServerTrustPoint [[-Name] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerTrustPoint** gets one or more trust points on a DNS server. -If you do not specify a trust point name, all trust points are enumerated. - -## EXAMPLES - -### Example 1: Get a list of trust points on a DNS server -``` -PS C:\> Get-DnsServerTrustPoint -``` - -This command gets a list of all trust points on the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of trust anchor zones on a DNS server. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustPoint[] - -## NOTES - -## RELATED LINKS - -[Update-DnsServerTrustPoint](./Update-DnsServerTrustPoint.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerZone.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerZone.md deleted file mode 100644 index 58e06890ba..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerZone.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerZone - -## SYNOPSIS -Gets details of DNS zones on a DNS server. - -## SYNTAX - -``` -Get-DnsServerZone [[-Name] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerZone** cmdlet gets the zones that exist on a Domain Name System (DNS) server. - -## EXAMPLES - -### Example 1: Get GlobalName zone settings -``` -PS C:\>Get-DnsServerZone -``` - -This command gets details of all zones on the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of zones. -If you do not specify one or more names, the cmdlet gets all the zones for the server. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone[] - -## NOTES - -## RELATED LINKS - -[Export-DnsServerZone](./Export-DnsServerZone.md) - -[Remove-DnsServerZone](./Remove-DnsServerZone.md) - -[Resume-DnsServerZone](./Resume-DnsServerZone.md) - -[Suspend-DnsServerZone](./Suspend-DnsServerZone.md) - -[Sync-DnsServerZone](./Sync-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerZoneAging.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerZoneAging.md deleted file mode 100644 index bc039d9bdd..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerZoneAging.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverzoneaging?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerZoneAging - -## SYNOPSIS -Gets DNS aging settings for a zone. - -## SYNTAX - -``` -Get-DnsServerZoneAging [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerZoneAging** cmdlet gets zone aging related information for a Domain Name System (DNS) zone. - -A resource record can remain after the resource is no longer part of the network. -Aging settings determine when a record can be removed as stale. -After that time, designated DNS servers can remove, or scavenge, a stale record. - -## EXAMPLES - -### Example 1: Get aging settings -``` -PS C:\> Get-DnsServerZoneAging -Name west01.contoso.com -``` - -This command gets the aging settings for a zone named west01.contoso.com on the local server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of zones. -This cmdlet is relevant only for DNS primary zones. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneAging[] - -## NOTES - -## RELATED LINKS - -[Set-DnsServerZoneAging](./Set-DnsServerZoneAging.md) - diff --git a/docset/winserver2012-ps/dnsserver/Get-DnsServerZoneDelegation.md b/docset/winserver2012-ps/dnsserver/Get-DnsServerZoneDelegation.md deleted file mode 100644 index 8b90fa2ca0..0000000000 --- a/docset/winserver2012-ps/dnsserver/Get-DnsServerZoneDelegation.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/get-dnsserverzonedelegation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DnsServerZoneDelegation - -## SYNOPSIS -Gets the zone delegations of a DNS server zone. - -## SYNTAX - -``` -Get-DnsServerZoneDelegation [-Name] [[-ChildZoneName] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DnsServerZoneDelegation** cmdlet gets the zone delegation objects for a Domain Name System (DNS) server zone. -You can specify a child zone name or get all child zones of a zone. - -## EXAMPLES - -### Example 1: Get delegations from a zone -``` -PS C:\> Get-DnsServerZoneDelegation -Name "contoso.com" -``` - -This command gets all the child zones for zone named contoso.com. -You could pipe the output of this command to related cmdlet instead of viewing the object in the console. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChildZoneName -Specifies a name of a child zone. -If you do not specify a name, the cmdlet gets all the child zones for the DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. -This is the parent DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerZoneDelegation](./Add-DnsServerZoneDelegation.md) - -[Remove-DnsServerZoneDelegation](./Remove-DnsServerZoneDelegation.md) - -[Set-DnsServerZoneDelegation](./Set-DnsServerZoneDelegation.md) - diff --git a/docset/winserver2012-ps/dnsserver/Import-DnsServerResourceRecordDS.md b/docset/winserver2012-ps/dnsserver/Import-DnsServerResourceRecordDS.md deleted file mode 100644 index ae37aab71f..0000000000 --- a/docset/winserver2012-ps/dnsserver/Import-DnsServerResourceRecordDS.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/import-dnsserverresourcerecordds?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-DnsServerResourceRecordDS - -## SYNOPSIS -Imports DS resource record information from a file. - -## SYNTAX - -``` -Import-DnsServerResourceRecordDS [-ZoneName] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] -DSSetFile [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Import-DnsServerResourceRecordDS** cmdlet imports a Delegation Signer (DS) resource record to a Domain Name System (DNS) server from a file. - -## EXAMPLES - -### Example 1: Import DS records from one zone to another -``` -PS C:\>Import-DnsServerResourceRecordDS -ZoneName "contoso.com" -DSSetFile "c:\windows\system32\dns\dsset-finance.contoso.com" -``` - -This command imports DS records for zone named finance.contoso.com into the zone contoso.com - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DSSetFile -Specifies an absolute path for a dsset file. -The cmdlet imports the DS record from this file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Import-DnsServerRootHint.md b/docset/winserver2012-ps/dnsserver/Import-DnsServerRootHint.md deleted file mode 100644 index 089850a4e4..0000000000 --- a/docset/winserver2012-ps/dnsserver/Import-DnsServerRootHint.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/import-dnsserverroothint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-DnsServerRootHint - -## SYNOPSIS -Copies root hints from a DNS server. - -## SYNTAX - -``` -Import-DnsServerRootHint [-NameServer] [-AsJob] [-CimSession ] [-ComputerName ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Import-DnsServerRootHint** cmdlet copies root hints from a DNS server. -The root hints that you copy will not overwrite any existing root hints. - -## EXAMPLES - -### Example 1: Copy root hints by using an IP address -``` -PS C:\> Import-DnsServerRootHint -NameServer "172.23.90.136" -PassThru -Verbose -``` - -This command copies root hints from the DNS server that has the IP address 172.23.90.136. - -### Example 2: Copy root hints by using a DNS server name -``` -PS C:\>Import-DnsServerRootHint -NameServer "dept01.server01.contoso.com" -PassThru -``` - -This command copies root hints from the DNS server that is named dept01.server01.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NameServer -Specifies a DNS name server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRootHint[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerRootHint](./Add-DnsServerRootHint.md) - -[Remove-DnsServerRootHint](./Remove-DnsServerRootHint.md) - -[Get-DnsServerRootHint](./Get-DnsServerRootHint.md) - -[Set-DnsServerRootHint](./Set-DnsServerRootHint.md) - diff --git a/docset/winserver2012-ps/dnsserver/Import-DnsServerTrustAnchor.md b/docset/winserver2012-ps/dnsserver/Import-DnsServerTrustAnchor.md deleted file mode 100644 index efa40e1c6a..0000000000 --- a/docset/winserver2012-ps/dnsserver/Import-DnsServerTrustAnchor.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/import-dnsservertrustanchor?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-DnsServerTrustAnchor - -## SYNOPSIS -Imports a trust anchor for a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Import-DnsServerTrustAnchor [-KeySetFile] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Import-DnsServerTrustAnchor [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -DSSetFile [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Import-DnsServerTrustAnchor** cmdlet imports a trust anchor from a specified file for a Domain Name System (DNS) server. -If you specify a key set file, the cmdlet imports the DNS public key (DNSKEY) record set from the input key set file. -This is the default parameter set. - -If you specify a delegation signer (DS) set file, the cmdlet imports the DS record set from the input dsset file. -If no trust anchor exists, the cmdlet creates one before it imports a trust anchor. - -## EXAMPLES - -### Example 1: Import a trust anchor by using a key set file -``` -PS C:\> Import-DnsServerTrustAnchor -KeySetFile "C:\Windows\System32\dns\keyset-west.contoso.com" -PassThru -Verbose -``` - -This command imports a trust anchor for the zone named west.contoso.com by using a specified key set file. - -### Example 2: Import a trust record by using a DS set file -``` -PS C:\>Import-DnsServerTrustAnchor -DSSetFile "C:\Windows\System32\dns\dsset-west.contoso.com" -PassThru -Verbose -``` - -This command imports a trust anchor (DS record) for the zone named west.contoso.com by using a specified DS set file. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify The acceptable values for this parameter are: an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DSSetFile -Specifies the path of a DS set file. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeySetFile -Specifies the path of a key set file. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustAnchor[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerTrustAnchor](./Add-DnsServerTrustAnchor.md) - -[Get-DnsServerTrustAnchor](./Get-DnsServerTrustAnchor.md) - -[Remove-DnsServerTrustAnchor](./Remove-DnsServerTrustAnchor.md) - diff --git a/docset/winserver2012-ps/dnsserver/Invoke-DnsServerSigningKeyRollover.md b/docset/winserver2012-ps/dnsserver/Invoke-DnsServerSigningKeyRollover.md deleted file mode 100644 index fe31715cc1..0000000000 --- a/docset/winserver2012-ps/dnsserver/Invoke-DnsServerSigningKeyRollover.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/invoke-dnsserversigningkeyrollover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-DnsServerSigningKeyRollover - -## SYNOPSIS -Initiates rollover of signing keys for the zone. - -## SYNTAX - -``` -Invoke-DnsServerSigningKeyRollover [-ZoneName] [-KeyId] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Invoke-DnsServerSigningKeyRollover** initiates rollover of input keys for the specified Domain Name System (DNS) zone. -For more information about DNS server signing keys, see the **Key Management** section of Overview of DNSSEChttp://technet.microsoft.com/en-us/library/jj200221.aspx. - -## EXAMPLES - -### Example 1: -``` -PS C:\> Get-DnsServerSigningKey -ZoneName "DNSServer06.Contoso.com" | Invoke-DnsServerSigningKeyRollover -PassThru -Verbose -Force -``` - -This command gets keys for the DNSServer06.Contoso.com zone and invokes rollover for each key. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP v4 address, an IP v6 address, and any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Instructs the cmdlet to perform the operation without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies a key ID. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey[] - -## NOTES - -## RELATED LINKS - -[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - -[Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) - diff --git a/docset/winserver2012-ps/dnsserver/Invoke-DnsServerZoneSign.md b/docset/winserver2012-ps/dnsserver/Invoke-DnsServerZoneSign.md deleted file mode 100644 index cd1c5c6ba5..0000000000 --- a/docset/winserver2012-ps/dnsserver/Invoke-DnsServerZoneSign.md +++ /dev/null @@ -1,233 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/invoke-dnsserverzonesign?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-DnsServerZoneSign - -## SYNOPSIS -Signs a DNS server zone. - -## SYNTAX - -``` -Invoke-DnsServerZoneSign [-ZoneName] [-AsJob] [-CimSession ] [-ComputerName ] - [-DoResign] [-Force] [-PassThru] [-SignWithDefault] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Invoke-DnsServerZoneSign** cmdlet signs a Domain Name System (DNS) server zone. - -If the zone is not already signed, use the **SignWithDefault** parameter, which results in the zone being signed with one Zone Signing Keys (ZSK) and one Key Signing Key (KSK) using default DNS Security (DNSSEC) settings. -If the zone is already signed, use the **DoResign** parameter. -If you use both the **SignWithDefault** parameter and the **DoResign** parameter on a signed zone, the cmdlet removes the existing zone signing keys, and re-signs the zone using default settings. - -## EXAMPLES - -### Example 1: Sign a zone with default values -``` -PS C:\> Invoke-DnsServerZoneSign -ZoneName "contoso.com" -SignWithDefault -PassThru -Verbose -``` - -This command signs the contoso zone using new KSK and ZSK keys and default DNSSEC settings. - -### Example 2: Re-sign a zone -``` -PS C:\>Invoke-DnsServerZoneSign "contoso.com" -DoResign -PassThru -Verbose -``` - -This command signs the contoso.com zone again. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DoResign -Re-signs a DNSSEC-signed zone. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Signs the DNS Server zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SignWithDefault -Signs a zone with default settings. -If a zone is already signed, this parameter removes the existing KSK and ZSK values for the zone, and configures DNSSEC settings to default values. -A new KSK and a new ZSK are used to resign the zone. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies a name of a primary zone. -The cmdlet signs this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerPrimaryZone - -## NOTES - -## RELATED LINKS - -[Invoke-DnsServerZoneUnsign](./Invoke-DnsServerZoneUnsign.md) - diff --git a/docset/winserver2012-ps/dnsserver/Invoke-DnsServerZoneUnsign.md b/docset/winserver2012-ps/dnsserver/Invoke-DnsServerZoneUnsign.md deleted file mode 100644 index e1801362e7..0000000000 --- a/docset/winserver2012-ps/dnsserver/Invoke-DnsServerZoneUnsign.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/invoke-dnsserverzoneunsign?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-DnsServerZoneUnsign - -## SYNOPSIS -Unsigns a DNS server zone. - -## SYNTAX - -``` -Invoke-DnsServerZoneUnsign [-ZoneName] [-AsJob] [-CimSession ] [-ComputerName ] - [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Invoke-DnsServerZoneUnsign** cmdlet unsigns a DNS Security Extensions (DNSSEC)-signed Domain Name System (DNS) zone. - -## EXAMPLES - -### Example 1: Unsign a zone -``` -PS C:\> Invoke-DnsServerZoneUnsign -ZoneName contoso.com -PassThru -Verbose -``` - -This command unsigns the zone named contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Unsigns a DNS zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone to unsign. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerPrimaryZone - -## NOTES - -## RELATED LINKS - -[Invoke-DnsServerZoneSign](./Invoke-DnsServerZoneSign.md) - diff --git a/docset/winserver2012-ps/dnsserver/Register-DnsServerDirectoryPartition.md b/docset/winserver2012-ps/dnsserver/Register-DnsServerDirectoryPartition.md deleted file mode 100644 index 807cfd0b93..0000000000 --- a/docset/winserver2012-ps/dnsserver/Register-DnsServerDirectoryPartition.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/register-dnsserverdirectorypartition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Register-DnsServerDirectoryPartition - -## SYNOPSIS -Registers a DNS server in a DNS application directory partition. - -## SYNTAX - -``` -Register-DnsServerDirectoryPartition [-Name] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Register-DnsServerDirectoryPartition** cmdlet registers a Domain Name System (DNS) server in a DNS application directory partition. -After you create a Domain Name System (DNS) application directory partition to store a zone, you must register the DNS server that hosts the zone in the application directory partition. -After you register a DNS server in a DNS application directory partition, the DNS server adds itself the to the replication scope of the DNS application directory partitions. - -## EXAMPLES - -### Example 1: Register a DNS server to a directory application partition -``` -PS C:\> Register-DnsServerDirectoryPartition -Name "ADpart" -``` - -This command adds the local DNS server to the directory application partition named ADpart. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the FQDN of a DNS application directory partition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDirectoryPartition - -## NOTES - -## RELATED LINKS - -[Add-DnsServerDirectoryPartition](./Add-DnsServerDirectoryPartition.md) - -[Get-DnsServerDirectoryPartition](./Get-DnsServerDirectoryPartition.md) - -[Unregister-DnsServerDirectoryPartition](./Unregister-DnsServerDirectoryPartition.md) - -[Remove-DnsServerDirectoryPartition](./Remove-DnsServerDirectoryPartition.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerDirectoryPartition.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerDirectoryPartition.md deleted file mode 100644 index 63887670f0..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerDirectoryPartition.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserverdirectorypartition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerDirectoryPartition - -## SYNOPSIS -Removes a DNS application directory partition. - -## SYNTAX - -``` -Remove-DnsServerDirectoryPartition [-Name] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerDirectoryPartition** cmdlet removes a Domain Name System (DNS). -You cannot remove a DNS server from the DomainDnsZones or ForestDnsZones application directory partitions. - -## EXAMPLES - -### Example 1: Remove a directory partition from the local DNS server -``` -PS C:\> Remove-DnsServerDirectoryPartition -Name "ADpart" -PassThru -Force -``` - -This command removes the DNS server from a DNS application directory partition named ADpart. -This command removes the directory partition without prompting you for confirmation and returns information about the DNS application directory partition that the command removed. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a DNS server from a DNS application directory partition without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the FQDN of a DNS application directory partition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDirectoryPartition - -## NOTES - -## RELATED LINKS - -[Add-DnsServerDirectoryPartition](./Add-DnsServerDirectoryPartition.md) - -[Get-DnsServerDirectoryPartition](./Get-DnsServerDirectoryPartition.md) - -[Register-DnsServerDirectoryPartition](./Register-DnsServerDirectoryPartition.md) - -[Unregister-DnsServerDirectoryPartition](./Unregister-DnsServerDirectoryPartition.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerForwarder.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerForwarder.md deleted file mode 100644 index 434babaaa4..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerForwarder.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserverforwarder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerForwarder - -## SYNOPSIS -Removes server level forwarders from a DNS server. - -## SYNTAX - -``` -Remove-DnsServerForwarder [-IPAddress] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerForwarder** cmdlet removes one or more forwarders from a DNS server's forwarders list. -After you remove a forwarder from a DNS server, the DNS server stops forwarding the queries they cannot resolve locally to the DNS server. - -## EXAMPLES - -### Example 1: Remove a forwarder from a DNS server -``` -PS C:\> Remove-DnsServerForwarder -IPAddress 10.0.0.8 -PassThru -``` - -This command removes the IP address 10.0.0.8 from the forwarders list on a DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes the forwarder without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IP addresses of the DNS servers to remove from the DNS server's forwarders list. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerForwarder - -## NOTES - -## RELATED LINKS - -[Get-DnsServerForwarder](./Get-DnsServerForwarder.md) - -[Add-DnsServerForwarder](./Add-DnsServerForwarder.md) - -[Set-DnsServerForwarder](./Set-DnsServerForwarder.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerResourceRecord.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerResourceRecord.md deleted file mode 100644 index bdab0a59de..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerResourceRecord.md +++ /dev/null @@ -1,337 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserverresourcerecord?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerResourceRecord - -## SYNOPSIS -Removes specified DNS server resource records from a zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DnsServerResourceRecord [-ZoneName] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DnsServerResourceRecord [-ZoneName] [-Name] [-RRType] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-RecordData ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerResourceRecord** removes resource record objects from a DNS zone. - -You can either use the **Get-DnsServerResourceRecord** cmdlet to specify an object, or you can specify the **RRtype**, **Name** and **RecordData** of the resource record you want to remove. -If you specify an **RRtype** or name and there are multiple resource records, you can specify the **RecordData** to delete a specific record. -If you do not specify **RecordData**, the cmdlet deletes all records that match **RRtype** and **Name** for the specified zone. - -## EXAMPLES - -### Example 1: Remove all root hints -``` -PS C:\>Get-DnsServerResourceRecord -ZoneName "..roothints" | Remove-DnsServerResourceRecord -Force -ZoneName "..roothints" -``` - -This command removes all root hints for a DNS server. - -### Example 2: Remove multiple A records -``` -PS C:\>Remove-DnsServerResourceRecord -ZoneName "contoso.com" -RRType "A" -Name "Host01" -Confirm - -Removing DNS resource record Host01 of type A from zone contoso.com on ROOT server. Do you want to continue? - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): n -``` - -This command removes all A resource records in the contoso.com zone that have the name Host01. - -### Example 3: Remove a named A record -``` -PS C:\>Remove-DnsServerResourceRecord -ZoneName "contoso.com" -RRType "A" -Name "Host01" -RecordData "10.17.1.41" -``` - -This command removes the A resource record from a zone named contoso.com that has the name Host01 and the IP address 10.17.1.41. - -### Example 4: Remove multiple SRV records -``` -PS C:\> Remove-DnsServerResourceRecord -RRType SRV -Name "_misc._tcp" -ZoneName "_msdcs.contoso.com" -RecordData "0","10","1234","1.1.1.1." -``` - -This command removes all SRV records in the _msdcs.contoso.com zone that have the name _misc._tcp. - - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a record or records without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a DNS server resource record object. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecordData -Specifies the data contained in the resource record you want to delete. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RRType -Specifies the type of resource record. - -The acceptable values for this parameter are: -- HInfo -- Afsdb -- Atma -- Isdn -- Key -- Mb -- Md -- Mf -- Mg -- MInfo -- Mr -- Mx -- NsNxt -- Rp -- Rt -- Wks -- X25 -- A -- AAAA -- CName -- Ptr -- Srv -- Txt -- Wins -- WinsR -- Ns -- Soa -- NasP -- NasPtr -- DName -- Gpos -- Loc -- DhcId -- Naptr -- RRSig -- DnsKey -- DS -- NSec -- NSec3 -- NSec3Param - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance# DnsServerResourceRecord[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord[] - -## NOTES - -## RELATED LINKS - -[Get-DnsServerResourceRecord](./Get-DnsServerResourceRecord.md) - -[Set-DnsServerResourceRecord](./Set-DnsServerResourceRecord.md) - -[Add-DnsServerResourceRecord](./Add-DnsServerResourceRecord.md) diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerRootHint.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerRootHint.md deleted file mode 100644 index 820b655d6c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerRootHint.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserverroothint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerRootHint - -## SYNOPSIS -Removes root hints from a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DnsServerRootHint [-InputObject] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DnsServerRootHint [-NameServer] [[-IPAddress] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerRootHint** cmdlet removes root hints from the list of root hints on a Domain Name System (DNS) server. -When you remove a root hint from a DNS server, the DNS server cannot contact the root DNS server on startup and cannot answer queries for names outside its own authoritative zones. - -## EXAMPLES - -### Example 1: Remove all root hints on a DNS server -``` -PS C:\> Get-DnsServerRootHint | Remove-DnsServerRootHint -``` - -This command removes all root hints on the local DNS server. -The **Get-DnsServerRootHint** cmdlet gets all root hints on the local DNS server and pipes the results to the **Remove-DnsServerRootHint** cmdlet. - -### Example 2: Remove a root hint by using a resource record -``` -PS C:\>Get-DnsServerRootHint | Where-Object {$_.NameServer.RecordData.NameServer -eq "H.Root-Servers.net."} | Remove-DnsServerRootHint -``` - -In this example, the **Get-DnsServerRootHint** cmdlet gets a list of all root hints on the local DNS server. -The command then pipes that collection to the **Where-Object** cmdlet. - -**Where-Object** filters out the resource record to get the root hint for the DNS name server that is named H.Root-Servers.net. -**Where-Object** then pipes the filtered **DnsServerRootHint** object to the **Remove-DnsServerRootHint** cmdlet, which removes the root hint. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes the root hints without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IPv4 or IPv6 addresses of DNS servers to remove. -If you do not specify **IPAddress**, this cmdlet removes all root hints on the specified DNS server. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServer -Specifies the name of a root hint to remove. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRootHint - -## NOTES - -## RELATED LINKS - -[Get-DnsServerRootHint](./Get-DnsServerRootHint.md) - -[Add-DnsServerRootHint](./Add-DnsServerRootHint.md) - -[Set-DnsServerRootHint](./Set-DnsServerRootHint.md) - -[Import-DnsServerRootHint](./Import-DnsServerRootHint.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerSigningKey.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerSigningKey.md deleted file mode 100644 index b64f2c236b..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerSigningKey.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserversigningkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerSigningKey - -## SYNOPSIS -Removes signing keys. - -## SYNTAX - -``` -Remove-DnsServerSigningKey [-ZoneName] [-KeyId] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerSigningKey** cmdlet removes one or more signing keys from the specified zone. -This cmdlet removes signing keys on an unsigned zone that you incorrectly configured. -This cmdlet cannot remove active signing keys from a signed zone. - -## EXAMPLES - -### Example 1: Remove signing keys for a zone -``` -PS C:\> Get-DnsServerSigningKey -ZoneName "west.contoso.com" | Remove-DnsServerSigningKey -``` - -This first part of the command gets the DNS server signing keys for the west.contoso.com zone and passes the results to the **Remove-DnsServerSigningKey** cmdlet by using the pipe operator. -The second part of the command removes DNS server signing keys. - -### Example 2: Remove a single signing key for a zone -``` -PS C:\>Remove-DnsServerSigningKey -ZoneName contoso.com -KeyId "6ff2c4b3-3eeb-4074-908f-bca0cca153c7" -``` - -This command removes the signing key that has the ID 6ff2c4b3-3eeb-4074-908f-bca0cca153c7 from the zone named contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes the signing keys without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies an array of key identifiers. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerSigningKey](./Add-DnsServerSigningKey.md) - -[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - -[Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) - -[Get-DnsServerSigningKey](./Get-DnsServerSigningKey.md) - -[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) - -[Set-DnsServerSigningKey](./Set-DnsServerSigningKey.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerTrustAnchor.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerTrustAnchor.md deleted file mode 100644 index f827c45404..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerTrustAnchor.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsservertrustanchor?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerTrustAnchor - -## SYNOPSIS -Removes a trust anchor from a DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DnsServerTrustAnchor [-Name] [[-Type] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DnsServerTrustAnchor [-AsJob] [-CimSession ] [-ComputerName ] [-Force] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerTrustAnchor** cmdlet removes a trust anchor from a Domain Name System (DNS) server. -If you specify an anchor type, the cmdlet removes the specified type of trust anchor. -You can also use the **InputObject** parameter to specify the trust anchor to delete. - -## EXAMPLES - -### Example 1: Remove trust anchors from a DNS server -``` -PS C:\> Remove-DnsServerTrustAnchor -Name "Dept06.contoso.com" -Type DnsKey -PassThru -Verbose -``` - -This command removes all the trust anchors that are associated with the trust point named Dept06.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -The acceptable values for this parameter are: an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a trust anchor without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies one or more objects as input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a trust anchor on a DNS server. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the trust anchor type. -If you do not specify this parameter, the server removes all trust anchors that match the other parameters that you specify. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustAnchor[] - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustAnchor[] - -## NOTES - -## RELATED LINKS - -[Add-DnsServerTrustAnchor](./Add-DnsServerTrustAnchor.md) - -[Get-DnsServerTrustAnchor](./Get-DnsServerTrustAnchor.md) - -[Import-DnsServerTrustAnchor](./Import-DnsServerTrustAnchor.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerZone.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerZone.md deleted file mode 100644 index 86ae774ee9..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerZone.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserverzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerZone - -## SYNOPSIS -Removes a zone from a DNS server. - -## SYNTAX - -``` -Remove-DnsServerZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerZone** removes a zone from a Domain Name System (DNS) server. -You can use this cmdlet to remove any type of zone, primary, secondary, stub, or conditional forwarder. - -## EXAMPLES - -### Example 1: Remove a zone -``` -PS C:\> Remove-DnsServerZone "western.contoso.com" -PassThru -Verbose -``` - -This command removes a zone named western.contoso.com. -The command uses the **PassThru** parameter to create output. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes a zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name of a zone. -The cmdlet removes this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone - -## NOTES - -## RELATED LINKS - -[Export-DnsServerZone](./Export-DnsServerZone.md) - -[Get-DnsServerZone](./Get-DnsServerZone.md) - -[Resume-DnsServerZone](./Resume-DnsServerZone.md) - -[Suspend-DnsServerZone](./Suspend-DnsServerZone.md) - -[Sync-DnsServerZone](./Sync-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Remove-DnsServerZoneDelegation.md b/docset/winserver2012-ps/dnsserver/Remove-DnsServerZoneDelegation.md deleted file mode 100644 index 7cf92e710b..0000000000 --- a/docset/winserver2012-ps/dnsserver/Remove-DnsServerZoneDelegation.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/remove-dnsserverzonedelegation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DnsServerZoneDelegation - -## SYNOPSIS -Removes a name server or delegation from a DNS zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DnsServerZoneDelegation [-InputObject] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DnsServerZoneDelegation [-Name] [-ChildZoneName] [[-NameServer] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DnsServerZoneDelegation** cmdlet removes a name server or delegation from a Domain Name System (DNS) zone. - -If you specify a DNS server for the child in this cmdlet, the cmdlet removes that server from the delegation. -If you remove the last DNS server, or if you do not specify a DNS server, the cmdlet removes the delegation from the zone, after confirmation. - -## EXAMPLES - -### Example 1: Remove a delegation -``` -PS C:\> Remove-DnsServerZoneDelegation -Name "contoso.com" -ChildZoneName "west05" -PassThru -Verbose -``` - -This command removes delegation west05 from the domain contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChildZoneName -Specifies the name of a child zone. -The cmdlet removes the delegation for this zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Removes the name server or delegation without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. -This is a Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation object. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the parent zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServer -Specifies the name of the DNS server for the child zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation - -## NOTES - -## RELATED LINKS - - - -[Add-DnsServerZoneDelegation](./Add-DnsServerZoneDelegation.md) - -[Get-DnsServerZoneDelegation](./Get-DnsServerZoneDelegation.md) - -[Set-DnsServerZoneDelegation](./Set-DnsServerZoneDelegation.md) - diff --git a/docset/winserver2012-ps/dnsserver/Reset-DnsServerZoneKeyMasterRole.md b/docset/winserver2012-ps/dnsserver/Reset-DnsServerZoneKeyMasterRole.md deleted file mode 100644 index fd5206e554..0000000000 --- a/docset/winserver2012-ps/dnsserver/Reset-DnsServerZoneKeyMasterRole.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/reset-dnsserverzonekeymasterrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-DnsServerZoneKeyMasterRole - -## SYNOPSIS -Transfers the role of Key Master for a DNS zone. - -## SYNTAX - -``` -Reset-DnsServerZoneKeyMasterRole [-ZoneName] [[-KeyMasterServer] ] [-AsJob] - [-CimSession ] [-Force] [-PassThru] [-SeizeRole] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Reset-DnsServerZoneKeyMasterRole** cmdlet transfers the role of DNS Security (DNSSEC) Key Master server. -Any authoritative Domain Name System (DNS) server that hosts a primary copy of the zone can be the Key Master server. - -This cmdlet attempts to connect to the current Key Master server. -If it cannot connect to that server, the cmdlet does not make the change unless you specify **SeizeRole**. - -This cmdlet prompts the user for confirmation before it transfers the role unless you use the **Force** switch. - -## EXAMPLES - -### Example 1: Transfer the role -``` -PS C:\> Reset-DnsServerZoneKeyMasterRole -ZoneName "west01.contoso.com" -KeyMasterServer "root.contoso.com" -``` - -This command transfers the Key Master role for the zone named west01.contoso.com to the server named keys.contoso.com. -If the cmdlet cannot verify with the current Key Master server, it does not transfer the role. - -### Example 2: Transfer the role, required -``` -PS C:\>Reset-DnsServerZoneKeyMasterRole -ZoneName "west01.contoso.com" -KeyMasterServer "keys.contoso.com" -SeizeRole -``` - -This command transfers the Key Master role for the zone named west01.contoso.com to a server named keys.contoso.com. -If the cmdlet cannot verify with the current Key Master server, the cmdlet nevertheless transfers the role. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Transfers the role without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyMasterServer -Specifies the name of a DNS server. -Use a NetBIOS name, IP address, or fully qualified domain name. -The cmdlet makes this server the Key Master server for the specified zone. -The specified zone must be present on the DNS server as a primary zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SeizeRole -Seizes the Key Master role. -Unless this switch is specified, the cmdlet does not make a change if it cannot reach the current Key Master server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies a name of a zone. -The cmdlet transfers the Key Master role for this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Restore-DnsServerPrimaryZone.md b/docset/winserver2012-ps/dnsserver/Restore-DnsServerPrimaryZone.md deleted file mode 100644 index 0672ae0b5c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Restore-DnsServerPrimaryZone.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/restore-dnsserverprimaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-DnsServerPrimaryZone - -## SYNOPSIS -Restores primary DNS zone contents from Active Directory or from a file. - -## SYNTAX - -``` -Restore-DnsServerPrimaryZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Restore-DnsServerPrimaryZone** cmdlet restores a Domain Name System (DNS) primary zone's contents. - -For Active Directory-integrated DNS zones, the cmdlet reloads from Active Directory Domain Services (AD DS). -For file-backed zones, it reloads from the zone file. - -## EXAMPLES - -### Example 1: Restore a domainzonezone -``` -PS C:\> Restore-DnsServerPrimaryZone -Name "western.contoso.com" -PassThru -``` - -This command reloads a DNS zone named western.contoso.com. -The **PassThru** parameter causes the command to produce output. -You can skip the default confirmation message by using the **Force** parameter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Restores DNS zone information without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerPrimaryZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerPrimaryZone](./Add-DnsServerPrimaryZone.md) - -[ConvertTo-DnsServerPrimaryZone](./ConvertTo-DnsServerPrimaryZone.md) - -[Set-DnsServerPrimaryZone](./Set-DnsServerPrimaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Restore-DnsServerSecondaryZone.md b/docset/winserver2012-ps/dnsserver/Restore-DnsServerSecondaryZone.md deleted file mode 100644 index 5d0bc30893..0000000000 --- a/docset/winserver2012-ps/dnsserver/Restore-DnsServerSecondaryZone.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/restore-dnsserversecondaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-DnsServerSecondaryZone - -## SYNOPSIS -Restores secondary zone information from its source. - -## SYNTAX - -``` -Restore-DnsServerSecondaryZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Restore-DnsServerSecondaryZone** cmdlet copies secondary zone information from its source. -For secondary zones, this information is always stored in a file. - -## EXAMPLES - -### Example 1: Restore a zone -``` -PS C:\>Restore-DnsServerSecondaryZone -Name "western.contoso.com" -PassThru -``` - -This command reloads a DNS zone named western.contoso.com. -The **PassThru** parameter causes the command to produce output. -You can skip the default confirmation message by using the **Force** parameter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Updates the DNS zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the secondary zone to restore. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSecondaryZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerSecondaryZone](./Add-DnsServerSecondaryZone.md) - -[ConvertTo-DnsServerSecondaryZone](./ConvertTo-DnsServerSecondaryZone.md) - -[Set-DnsServerSecondaryZone](./Set-DnsServerSecondaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Resume-DnsServerZone.md b/docset/winserver2012-ps/dnsserver/Resume-DnsServerZone.md deleted file mode 100644 index 3c4ecada76..0000000000 --- a/docset/winserver2012-ps/dnsserver/Resume-DnsServerZone.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/resume-dnsserverzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-DnsServerZone - -## SYNOPSIS -Resumes name resolution on a suspended zone. - -## SYNTAX - -``` -Resume-DnsServerZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Resume-DnsServerZone** cmdlet resumes name resolution on a suspended Domain Name System (DNS) zone. -You can use the **Suspend-DnsServerZone** cmdlet to temporarily prevent a DNS server from responding to queries for a zone. - -## EXAMPLES - -### Example 1: Resume a suspended zone -``` -PS C:\> Resume-DnsServerZone "western.contoso.com" -Verbose -PassThru -``` - -This command resumes a suspended zone named western.contoso.com. -This command uses the **PassThru** parameter to produce output. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Resumes name resolution without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone - -## NOTES - -## RELATED LINKS - -[Export-DnsServerZone](./Export-DnsServerZone.md) - -[Get-DnsServerZone](./Get-DnsServerZone.md) - -[Remove-DnsServerZone](./Remove-DnsServerZone.md) - -[Suspend-DnsServerZone](./Suspend-DnsServerZone.md) - -[Sync-DnsServerZone](./Sync-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServer.md b/docset/winserver2012-ps/dnsserver/Set-DnsServer.md deleted file mode 100644 index 448a7683e6..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServer.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServer - -## SYNOPSIS -Overwrites a DNS server configuration. - -## SYNTAX - -``` -Set-DnsServer [-InputObject] [-AsJob] [-CimSession ] [-ComputerName ] - [-CreateFileBackedPrimaryZones] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServer** cmdlet uses an input object to overwrite a specified Domain Name System (DNS) server configuration. -You can generate the input object by using an XML file that is exported by using any of the following cmdlets: **Get-DnsServer**, **Export-Clixml**, or **Import-Clixml**. - -For more information about **Export-Clixml**, see Export-Clixmlhttp://technet.microsoft.com/en-us/library/hh849916.aspx. -For more information about **Import-Clixml**, see Import-Clixmlhttp://technet.microsoft.com/en-us/library/hh849906.aspx. - -## EXAMPLES - -### Example 1: Overwrite a DNS server configuration by using an input object -``` -PS C:\>Get-DnsServer -ComputerName "DNSServer13.Contoso.com" | Export-Clixml -Path "c:\DnsServerConfig.xml" -PS C:\>$x = Import-Clixml "c:\DnsServerConfig.xml" -PS C:\>Set-DnsServer -InputObject $x -ComputerName "DNSServer22.Contoso.com" -``` - -This set of commands uses an input object to overwrite a DNS server configuration. - -As shown in the code block, the first command gets DNS server configuration by using the **Get-DnsServer** cmdlet. -It then pipes the information to the **Export-Clixml** cmdlet, which exports the data into an XML file. - -The second command gets and stores the XML file data in variable $x. - -The third command uses the data that is stored in variable $x to overwrite an existing DNS server configuration. - -### Example 2: Set DNS server configuration by using the Cimsession parameter -``` -PS C:\>Get-DnsServer -CimSession 172.22.50.137 | Set-DnsServer -``` - -This command gets DNS server configuration from a server that has an IP address of 172.22.50.137 and applies it to the server on which the **Set-DnsServer cmdlet** is run. - -### Example 3: Migrate DNS server configuration by using IP addresses -``` -PS C:\>Get-DnsServer -CimSession 172.22.50.137 | Set-DnsServer -ComputerName 172.22.50.138 -``` - -This command migrates DNS server configuration from a server that has an IP address of 172.22.50.137 to a server that has an IP address of 172.22.50.138. - -### Example 4: Create a file-backed primary zone -``` -PS C:\>Get-DnsServer -CimSession 172.22.50.137 | Set-DnsServer -CreateFileBackedPrimaryZones -``` - -This command creates file-backed primary zones on the specified local DNS server. -The file that contains resource records must exist in the **%windir%\system32\dns** directory. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP v4 address; an IP v6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CreateFileBackedPrimaryZones -Indicates that you must create new file-backed primary zones in the input object. -The files that contains the resource records must exist in the %windir%\system32\dns directory. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Overrides the default confirmation setting before the cmdlet performs the action. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -ps_cimcommon_asjob - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServer - -## NOTES - -## RELATED LINKS - -[Get-DnsServer](./Get-DnsServer.md) - -[Test-DnsServer](./Test-DnsServer.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerCache.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerCache.md deleted file mode 100644 index e2e51a303c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerCache.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsservercache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerCache - -## SYNOPSIS -Modifies cache settings for a DNS server. - -## SYNTAX - -``` -Set-DnsServerCache [-AsJob] [-CimSession ] [-ComputerName ] [-LockingPercent ] - [-MaxKBSize ] [-MaxNegativeTtl ] [-MaxTtl ] [-PassThru] - [-PollutionProtection ] [-StoreEmptyAuthenticationResponse ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerCache** cmdlet modifies cache settings for a Domain Name System (DNS) server. - -## EXAMPLES - -### Example 1: Set the maximum cache size on a DNS server -``` -PS C:\> Set-DnsServerCache -MaxKBSize 10240 -ComputerName "Win12S-05.DNSServer-01.Contoso.com" -``` - -This command sets the maximum cache size to 10,240 kilobytes on a DNS server that has an FQDN of Win12S-05.DNSServer-01.Contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IPv4 address, an IPv6 address, and any other value that resolves to an IP address, such as fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LockingPercent -Specifies a percentage of the original Time to Live (TTL) value that caching can consume. - -Cache locking is configured as a percent value. -For example, if the cache locking value is set to 50, the DNS server does not overwrite a cached entry for half of the duration of the TTL. -By default, the cache locking percent value is 100. -This value means that the DNS server will not overwrite cached entries for the entire duration of the TTL. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxKBSize -Specifies the maximum size, in kilobytes, of the memory cache of a DNS server. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxNegativeTtl -Specifies how many seconds (0x1-0xFFFFFFFF) an entry that records a negative answer to a query remains stored in the DNS cache. -The default setting is 0x384 (900) seconds - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxTtl -Determines how many seconds (0x0-0xFFFFFFFF) a record is saved in cache. -If you use the 0x0 setting, the DNS server does not cache records. -The default setting is 0x15180 (86,400 seconds, or one day). - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PollutionProtection -Determines whether DNS filters name service (NS) resource records that are cached. -Valid values are zero, which caches all responses to name queries and is the default value; and one, which caches only the records that belong to the same DNS subtree. - -When you set this parameter value to False, cache pollution protection is disabled. -A DNS server caches the Host (A) record and all queried NS resources that are in the DNS server zone. -In this case, DNS can also cache the NS record of an unauthorized DNS server. -This event causes name resolution to fail or to be appropriated for subsequent queries in the specified domain. - -When you set the value for this parameter to True, the DNS server enables cache pollution protection and ignores the Host (A) record. -The DNS server performs a cache update query to resolve the address of the NS if the NS is outside the zone of the DNS server. -The additional query minimally affects DNS server performance. - -For more information about DNS cache locking, see DNS Cache Lockinghttp://technet.microsoft.com/en-us/library/ee683892(v=WS.10).aspx. -For more information about cache pollution protection, see Securing the DNS Server Servicehttp://technet.microsoft.com/en-us/library/cc731367. -For more information about NS resource records, see Managing resource recordshttp://technet.microsoft.com/en-us/library/cc783389(v=WS.10).aspx. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StoreEmptyAuthenticationResponse -Specifies whether a DNS server stores empty authoritative responses in the cache (RFC-2308). -We recommend that you limit this value to either 0x00000000 or 0x00000001, but you can specify any value. -The default value is 0x00000001. -You must allow and treat literally the value zero. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -Class DNSServerCache - -{ - -uint32 MaxCacheTTL; // Maximum time, in seconds, that the record of a recursive name query can remain in the DNS server cache. -The DNS server deletes records from the cache when the value of this entry expires, even if the value of the TTL field in the record is greater. -The default value of this property is 86,400 seconds (one day). - -uint32 MaxNegativeCacheTTL; // Maximum time, in seconds, that a name error result from a recursive query can remain in the DNS server cache. -The DNS server deletes records from the cache when this timer expires, even if the TTL field is greater. -Default value is 86,400 (one day). - -boolean AutoCacheUpdate // Indicates whether the DNS Server attempts to update its cache entries by using data from root servers. -When a DNS server starts, it needs a list of root server hints and Host A records for the server cache file. -Microsoft DNS servers have a feature that enables them to attempt to write back a new cache file based on the responses from root servers. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerCache - -## NOTES - -## RELATED LINKS - -[RFC 2308](http://www.rfc-editor.org/rfc/rfc2308.txt) - -[Clear-DnsServerCache](./Clear-DnsServerCache.md) - -[Get-DnsServerCache](./Get-DnsServerCache.md) - -[Show-DnsServerCache](./Show-DnsServerCache.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerConditionalForwarderZone.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerConditionalForwarderZone.md deleted file mode 100644 index a6da42ad8e..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerConditionalForwarderZone.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverconditionalforwarderzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerConditionalForwarderZone - -## SYNOPSIS -Changes settings for a DNS conditional forwarder. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DnsServerConditionalForwarderZone [-Name] [[-MasterServers] ] - [[-ForwarderTimeout] ] [[-UseRecursion] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DnsServerConditionalForwarderZone [-Name] [-AsJob] [-CimSession ] - [-ComputerName ] [-DirectoryPartitionName ] [-PassThru] [-ThrottleLimit ] - -ReplicationScope [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerConditionalForwarderZone** cmdlet changes settings of an existing conditional forwarder on a Domain Name System (DNS) server. -You can change the master servers, forwarder time-out, recursion, recursion scope, and directory partition name for a conditional forwarder zone. - -## EXAMPLES - -### Example 1: Change forwarder time-out for a zone -``` -PS C:\> Set-DnsServerConditionalForwarderZone -Name "contoso.com" -ForwarderTimeout 15 -``` - -This command changes the forwarder time-out for a forwarder zone named contoso.com. - -### Example 2: Change replication scope for a zone -``` -PS C:\>Set-DnsServerConditionalForwarderZone -Name "contoso.com" -ReplicationScope "Domain" -PassThru -``` - -This command changes the replication scope of contoso.com to a value of Domain, which means all DNS servers in the domain. -This example uses the **PassThru** parameter to create output. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server to host the forwarder. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the forwarder. -Conditional forwarders are internally stored as zones. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ForwarderTimeout -Specifies a length of time, in seconds, that a DNS server waits for the forwarder to resolve a query. -After the DNS server tries all forwarders, it can attempt to resolve the query itself. -The minimum value is 0. -The maximum value is 15. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -Conditional forwarders are stored as zones. -You can use both IPv4 and IPv6 addresses. -Specify at least one master server. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone that has conditional forwarding configured. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies the replication scope for the conditional forwarder. -Conditional forwarders are stored internally as zones. -The acceptable values for this parameter are: - -- Custom. -Replicate the conditional forwarder to all DNS servers running on domain controllers enlisted in a custom directory partition. -- Domain. -Replicate the conditional forwarder to all DNS servers that run on domain controllers in the domain. -- Forest. -Replicate the conditional forwarder to all DNS servers that run on domain controllers in the forest. -- Legacy. -Replicate the conditional forwarder to all domain controllers in the domain. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseRecursion -Specifies whether a DNS server attempts to resolve a query after the forwarder fails to resolve it. -A value of $False prevents a DNS server from attempting resolution using other DNS servers. -This parameter overrides the Use Recursion setting for a DNS server. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerConditionalForwarderZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerConditionalForwarderZone](./Add-DnsServerConditionalForwarderZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerDiagnostics.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerDiagnostics.md deleted file mode 100644 index 4142644703..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerDiagnostics.md +++ /dev/null @@ -1,743 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverdiagnostics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerDiagnostics - -## SYNOPSIS -Sets debugging and logging parameters. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DnsServerDiagnostics [-Answers ] [-AsJob] [-CimSession ] [-ComputerName ] - [-EnableLogFileRollover ] [-EnableLoggingForLocalLookupEvent ] - [-EnableLoggingForPluginDllEvent ] [-EnableLoggingForRecursiveLookupEvent ] - [-EnableLoggingForRemoteServerEvent ] [-EnableLoggingForServerStartStopEvent ] - [-EnableLoggingForTombstoneEvent ] [-EnableLoggingForZoneDataWriteEvent ] - [-EnableLoggingForZoneLoadingEvent ] [-EnableLoggingToFile ] [-EventLogLevel ] - [-FullPackets ] [-IPFilterList ] [-LogFilePath ] [-MaxMBFileSize ] - [-Notifications ] [-PassThru] [-Queries ] [-QuestionTransactions ] - [-ReceivePackets ] [-SaveLogsToPersistentStorage ] [-SendPackets ] - [-TcpPackets ] [-ThrottleLimit ] [-UdpPackets ] [-UnmatchedResponse ] - [-Updates ] [-UseSystemEventLog ] [-WriteThrough ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DnsServerDiagnostics [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] -All [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-DnsServerDiagnostics [-AsJob] [-CimSession ] [-ComputerName ] - [-DebugLogging ] [-OperationLogLevel1 ] [-OperationLogLevel2 ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerDiagnostics** cmdlet sets debugging and logging parameters on a Domain Name System (DNS) server. - -If you enable debug logging (set the **FullPackets** parameter to $True), you must satisfy the following conditions: - -1. Set the **ReceivePackets** parameter or the **SendPackets** parameter to $True., and: - -2. Set the **TcpPackets** parameter or the **UdpPackets** parameter to $True, and: - -3. Set the **Notifications** parameter, the **Queries** parameter, or the **Updates** parameter to $True, and: - -4. Set the **QuestionTransactions** parameter or the **Answers** parameter to $True. - -If you use the first parameter set, you must specify at least one of the options in each of the following entries: - -1. **ReceivePackets**, **SendPackets** - -2. **TcpPackets**, **UdpPackets** - -3. **Notifications**, **Updates**, **Queries** - -4. **QuestionTransactions**, **Answers** - -The **All** parameter set enables all options except for the following: **LogFilePath**, **MaxMBFileSize**, **EventLogLevel**, **FilterIpAddrList**, **UseSystemEventLog**, and **EnableLogFileRollover**. - -Use the third parameter to enable diagnostics at a more detailed level. - -## EXAMPLES - -### Example 1: Enable diagnostics for outgoing TCP responses for updates -``` -PS C:\>Set-DnsServerDiagnostics -SendPackets $true -TcpPackets $true -Answers $true -Updates $true -``` - -This command enables the diagnostics of outgoing TCP responses for updates. - -### Example 2: Enable all diagnostic options except for LogFilePath -``` -PS C:\>Set-DnsServerDiagnostics -All $true -``` - -This command enables all options for DNS server diagnostics except for **LogFilePath**. - -### Example 3: Log send packets -``` -PS C:\>Set-DnsServerDiagnostics -DebugLogging 0x10000 -``` - -This command logs send packages. - -### Example 4: Reset debugging settings -``` -PS C:\>Get-DnsServerDiagnostics -ComputerName "DNSServer01" | select -TcpPackets, -UdpPackets | Set-DnsServerDiagnostics -ComputerName "DNSServer02" -``` - -This command resets the TCP packet debugging and UDP packet debugging options on DNSServer02 to their values on DNSServer01. - -## PARAMETERS - -### -All -Controls whether the DNS server logs all events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Answers -Enables the logging of DNS responses when you set the value to $True. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IPv4 address, an IPv6 address, and any other value that resolves to an IP address, such as fully qualified domain name (FQDN), Hostname, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DebugLogging -Specifies the bitmask for debug logging. -Valid values are: - -- 0x00000001. The server logs query packet exchanges. -- 0x00000010. The server logs packet exchanges that are related to zone exchanges. -- 0x00000020. The server logs packet exchanges that are related to zone updates. -- 0x00000100. The server logs packets that contain questions. -- 0x00000200. The server logs packets that contain answers. -- 0x00001000. The server logs packets that it sends. -- 0x00002000. The server logs packets that it receives. -- 0x00004000. The server logs User Datagram Protocol (UDP) packet exchanges. -- 0x00008000. The server logs Transmission Control Protocol (TCP) packet exchanges. -- 0x0000FFFF. The server logs operations if you set the following fields to $True: 0x00001000, 0x00002000, 0x00008000, 0x00004000, 0x00000001, 0x00000001, 0x00000020, 0x00000100, and 0x00000200S. -- 0x00010000. Independent of other field values, this bitmap logs Active Directory write operations. -- 0x00020000. Independent of other field values, this bitmap logs Active Directory polling operations and operations that occur during DNS updates (secure and not secure) on Active Directory-integrated zones. -- 0x01000000. If other field values allow it, the server logs the entire packet to the log file. -- 0x02000000. If other field values allow it, the server logs response packets that do not match any outstanding queries. -- 0x80000000. If other field values allow it, the server saves packet logging information to persistent storage. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: 0xFFFFFFFF -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLogFileRollover -Sets a bit flag to enable log file rollover. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForLocalLookupEvent -Controls whether the DNS server logs local lookup events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForPluginDllEvent -Controls whether the DNS server logs dynamic link library (DLL) plug-in events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForRecursiveLookupEvent -Controls whether the DNS server logs recursive lookup events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForRemoteServerEvent -Controls whether the DNS server logs remote server events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForServerStartStopEvent -Controls whether the DNS server logs server start and stop events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForTombstoneEvent -Controls whether the DNS server logs tombstone events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForZoneDataWriteEvent -Controls whether the DNS server logs zone data write events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingForZoneLoadingEvent -Controls whether the DNS server logs zone load events. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableLoggingToFile -Controls whether the DNS server logs logging-to-file. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLogLevel -Specifies an event log level. Valid values are: - -- 0: No Events -- 1: Errors Only -- 2: Errors and warnings -- 3-7: All Events - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FullPackets -Controls whether the DNS server logs full packets. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPFilterList -Specifies an array of IP addresses to filter. -When you enable logging, traffic to and from these IP addresses is logged. -If you do not specify any IP addresses, traffic to and from all IP addresses is logged. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LogFilePath -Specifies a log file path. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxMBFileSize -Specifies the maximum size of the log file. -This parameter is relevant if you set **EnableLogFileRollover** and **EnableLoggingToFile** to $True. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Notifications -Controls whether the DNS server logs notifications. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationLogLevel1 -Sets a bit flag for the logging level. -Valid values are: - -- 0x00000001. The DNS server saves operational logging information to persistent storage. -- 0x00000010. The DNS server logs event logging information to a log file. -- 0x00000020. The DNS server logs operational logging information for server start and stop activities to the log file. -- 0x00002000. The DNS server logs operational logging information for activities that are related to loading a zone from a directory server to the log file. -- 0x00004000. The DNS server logs operational logging information for activities that are related to writing zone data to the directory server to the log file. -- 0x00020000. The DNS server logs operational logging information for activities that are related to updating nodes that have exceeded the tombstone lifetime to the log file. -- 0x00100000. The DNS server logs operational logging information for local resource lookup activities to the log file. -- 0x00200000. The DNS server logs operational logging information for activities that occur during recursive query lookup to the log file. -- 0x00400000. The DNS server logs operational logging information for activities that are related to interaction with remote name servers to the log file. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OperationLogLevel2 -Specifies the additional operations that the DNS server logs. -The default valid value is: - -0x01000000. -Valid values for this parameter are: 0x01, 0x02, and 0x03.The DNS server logs operational logging information for activities that are related to interaction with plug-in DLLs to the log file. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queries -Controls whether the DNS server allows query packet exchanges to pass through the content filter, such as the *IPFilterList* parameter. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -QuestionTransactions -Controls whether the DNS server logs queries. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReceivePackets -Controls whether the DNS server logs receive packets. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SaveLogsToPersistentStorage -Controls whether the DNS server saves logs to persistent storage. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SendPackets -Controls whether the DNS server logs send packets. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TcpPackets -Controls whether the DNS server logs TCP packets. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpPackets -Controls whether the DNS server logs UDP packets. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UnmatchedResponse -Controls whether the DNS server logs unmatched responses. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Updates -Controls whether the DNS server logs updates. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseSystemEventLog -Controls whether the DNS server uses the system event log for logging. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WriteThrough -Controls whether the DNS server logs write-throughs. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDiagnostics - -## RELATED LINKS - -[Get-DnsServerDiagnostics](./Get-DnsServerDiagnostics.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerDnsSecZoneSetting.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerDnsSecZoneSetting.md deleted file mode 100644 index 374b610488..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerDnsSecZoneSetting.md +++ /dev/null @@ -1,436 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverdnsseczonesetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerDnsSecZoneSetting - -## SYNOPSIS -Changes settings for DNSSEC for a zone. - -## SYNTAX - -``` -Set-DnsServerDnsSecZoneSetting [-ZoneName] [[-DenialOfExistence] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-DistributeTrustAnchor ] - [-DnsKeyRecordSetTtl ] [-DSRecordGenerationAlgorithm ] [-DSRecordSetTtl ] - [-EnableRfc5011KeyRollover ] [-NSec3HashAlgorithm ] [-NSec3Iterations ] - [-NSec3OptOut ] [-NSec3RandomSaltLength ] [-NSec3UserSalt ] - [-ParentHasSecureDelegation ] [-PassThru] [-PropagationTime ] - [-SecureDelegationPollingPeriod ] [-SignatureInceptionOffset ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerDnsSecZoneSetting** cmdlet changes Domain Name System Security Extensions (DNSSEC) settings for the specified zone on a Domain Name System (DNS) server. - -You can select which version of Next Secure (NSEC) to use to provide authenticated denial of existence. -Set the **DenialOfExistence** parameter to NSec or NSec3. -If you use NSec3, you can use either random salt or user-defined salt. - -## EXAMPLES - -### Example 1: Modify RFC 5011 settings -``` -PS C:\> Set-DnsServerDnsSecZoneSetting -ZoneName "west01.contoso.com" -EnableRfc5011KeyRollover $true -PassThru -Verbose -``` - -This command modifies RFC 5011 settings for a zone named west01.contoso.com. -The example uses the **PassThru** parameter to produce output and the **Verbose** parameter to include all output. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DenialOfExistence -Specifies which version of NSEC to use. -A DNS server uses this setting to provide signed proof of an unregistered name. - -The acceptable values for this parameter are: - -- NSec -- NSec3 - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DistributeTrustAnchor -Specifies an array of trust anchors that a DNS server distributes in Active Directory® Domain Services. -DNS servers do not distribute trust anchors by default. -If the DNS server is not also a domain controller, it adds trust anchors only to the local trust anchor store. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DnsKeyRecordSetTtl -Specifies a time-span object that represents the Time to Live (TTL) value of a DNS key record. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DSRecordGenerationAlgorithm -Specifies an array of cryptographic algorithms for domain service records. -The acceptable values for this parameter are: - -- Sha1 -- Sha256 -- Sha384 - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DSRecordSetTtl -Specifies a TTL time span for the set of domain service records. -The default value is the same as the TTL for the zone. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableRfc5011KeyRollover -Specifies whether a server uses RFC 5011 key rollover. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NSec3HashAlgorithm -Specifies an NSEC3 hash algorithm. -The only possible value is RsaSha1. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NSec3Iterations -Specifies a number of NSEC3 hash iterations to perform when it signs a DNS zone. -The default value is 50. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NSec3OptOut -Specifies whether to sign the DNS zone by using NSEC opt-out. -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NSec3RandomSaltLength -Specifies the length of a salt value. -The default length is 8. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NSec3UserSalt -Specifies a user salt string. -The default value is Null or -. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentHasSecureDelegation -Specifies whether a parent has secure delegation for a zone. -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropagationTime -Specifies a propagation time as a time-span object. -This is the expected time required to propagate zone changes. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecureDelegationPollingPeriod -Specifies a delegation polling period as a time-span object. -This is the time between polling attempts for key rollovers for child zones. -The default value is 12 hours. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SignatureInceptionOffset -Specifies the signature inception as a time-span object. -This value is how far in the past DNSSEC signature validity periods begin. -The default value is one hour. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDnsSecZoneSetting - -## NOTES - -## RELATED LINKS - -[Get-DnsServerDnsSecZoneSetting](./Get-DnsServerDnsSecZoneSetting.md) - -[Test-DnsServerDnsSecZoneSetting](./Test-DnsServerDnsSecZoneSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerDsSetting.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerDsSetting.md deleted file mode 100644 index 1ef24c990d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerDsSetting.md +++ /dev/null @@ -1,317 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverdssetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerDsSetting - -## SYNOPSIS -Modifies DNS Active Directory settings. - -## SYNTAX - -``` -Set-DnsServerDsSetting [-AsJob] [-CimSession ] [-ComputerName ] - [-DirectoryPartitionAutoEnlistInterval ] [-LazyUpdateInterval ] - [-MinimumBackgroundLoadThreads ] [-PassThru] [-PollingInterval ] - [-RemoteReplicationDelay ] [-ThrottleLimit ] [-TombstoneInterval ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerDsSetting** cmdlet modifies Domain Name System (DNS) Active Directory settings. - -Note: If any of the set operations fails, the **Set-DnsServerDsSetting** cmdlet must not terminate. -It must continue to set other operations and display the modified settings. - -## EXAMPLES - -### Example 1: Set an auto-enlist interval for a directory partition -``` -PS C:\> Set-DnsServerDsSetting -DirectoryPartitionAutoEnlistInterval 15.00:00:00 -PassThru -PollingInterval(s) : 180 - -TombstoneInterval : 14.00:00:00 - -DirectoryPartitionAutoEnlistInterval : 15.00:00:00 - -LazyUpdateInterval(s) : 3 - -MinimumBackgroundLoadThreads : 1 - -RemoteReplicationDelay(s) : 30 -``` - -This command sets an auto-enlist interval to 15 days for a directory partition. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IPv4 address; an IPv6 address; and any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionAutoEnlistInterval -Specifies the interval, during which a DNS server tries to enlist itself in a DNS domain partition and DNS forest partition, if it is not already enlisted. -We recommend that you limit this value to the range one hour to 180 days, inclusive, but you can use any value. -We recommend that you set the default value to one day. -You must set the value 0 (zero) as a flag value for the default value. -However, you can allow zero and treat it literally. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0x00015180 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LazyUpdateInterval -Specifies a value, in seconds, to determine how frequently the DNS server submits updates to the directory server without specifying the LDAP_SERVER_LAZY_COMMIT_OID control (\[MS-ADTS\] section 3.1.1.3.4.1.7) at the same time that it processes DNS dynamic update requests. -We recommend that you limit this value to the range 0x00000000 to 0x0000003c. -You must set the default value to 0x00000003. -You must set the value zero to indicate that the DNS server does not specify the LDAP_SERVER_LAZY_COMMIT_OID control at the same time that it processes DNS dynamic update requests. -For more information about LDAP_SERVER_LAZY_COMMIT_OID, see LDAP_SERVER_LAZY_COMMIT_OID control codehttp://technet.microsoft.com/en-us/library/aa366982. - -The LDAP_SERVER_LAZY_COMMIT_OID control instructs the DNS server to return the results of a directory service modification command after it is completed in memory but before it is committed to disk. -In this way, the server can return results quickly and save data to disk without sacrificing performance. - -The DNS server must send this control only to the directory server that is attached to an LDAP update that the DNS server initiates in response to a DNS dynamic update request. - -If the value is nonzero, LDAP updates that occur during the processing of DNS dynamic update requests must not specify the LDAP_SERVER_LAZY_COMMIT_OID control if a period of less than DsLazyUpdateInterval seconds has passed since the last LDAP update that specifies this control. -If a period that is greater than DsLazyUpdateInterval seconds passes, during which time the DNS server does not perform an LDAP update that specifies this control, the DNS server must specify this control on the next update. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0x00000003 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MinimumBackgroundLoadThreads -Specifies the minimum number of background threads that the DNS server uses to load zone data from the directory service. -You must limit this value to the range 0x00000000 to 0x00000005, inclusive. -You must set the default value to 0x00000001, and you must treat the value zero as a flag value for the default value. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0x00000001 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PollingInterval -Specifies how frequently the DNS server polls Active Directory Domain Services (AD DS) for changes in Active Directory-integrated zones. -You must limit the value to the range 30 seconds to 3,600 seconds, inclusive. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RemoteReplicationDelay -Specifies the minimum interval, in seconds, that the DNS server waits between the time that it determines that a single object has changed on a remote directory server, to the time that it tries to replicate a single object change. -You must limit the value to the range 0x00000005 to 0x00000E10, inclusive. -You must set the default value to 0x0000001E, and you must treat the value zero as a flag value for the default value. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0x1E -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TombstoneInterval -Specifies the amount of time that DNS keeps tombstoned records alive in Active Directory. -We recommend that you limit this value to the range three days to eight weeks, inclusive, but you can set it to any value in the range 82 hours to 8 weeks. -We recommend that you set the default value to 14 days and treat the value zero as a flag value for the default. -However, you can allow the value zero and treat it literally. - -At 2:00 A.M. -local time every day, the DNS server must search all directory service zones for nodes that have the Active Directory **dnsTombstoned** attribute set to True, and for a directory service **EntombedTime** (section 2.2.2.2.3.23 of MS-DNSP) value that is greater than previous directory service **DSTombstoneInterval** seconds. -You must permanently delete all such nodes from the directory server. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -Class dnsServerDSSettings - -{ - -ulong dsPollingInterval; //Interval, in seconds, to poll the directory service-integrated zones. - -ulong dsTombstoneInterval; // Time of tombstoned records in directory service-integrated zones, expressed in seconds. - -ulong adsLazyUpdateInterval; - -ulong dsMinimumBackgroundLoadThreads; - -ulong dsRemoteReplicationDelay; - -ulong dsDirectoryPartitionAutoEnlistInterval; - -boolean DefaultDirectoryPartitions - -} - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDsSetting - -## NOTES - -## RELATED LINKS - -[DNS Server Integer Properties](https://msdn.microsoft.com/en-us/library/cc422472(v=prot.10)) - -[[MS-DNSP]: Domain Name Service (DNS) Server Management Protocol Specification](https://msdn.microsoft.com/en-us/library/cc448821(v=prot.10)) - -[Get-DnsServerDsSetting](./Get-DnsServerDsSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerEDns.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerEDns.md deleted file mode 100644 index 3cdde019cf..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerEDns.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserveredns?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerEDns - -## SYNOPSIS -Changes EDNS settings on a DNS server. - -## SYNTAX - -``` -Set-DnsServerEDns [-AsJob] [-CacheTimeout ] [-CimSession ] [-ComputerName ] - [-EnableProbes ] [-EnableReception ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerEDns** cmdlet changes extension mechanisms for DNS (EDNS) settings on a Domain Name System (DNS) server. - -## EXAMPLES - -### Example 1: Change the EDNS cache setting -``` -PS C:\> Set-DnsServerEDns -CacheTimeout 00:30:00 -PassThru -``` - -This command changes the EDNS cache setting on a local DNS server. -This command specifies that the DNS server caches EDNS information for 30 minutes. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CacheTimeout -Specifies the number of seconds that the DNS server caches EDNS information. -The default value is 604,800 seconds (one week). - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableProbes -Disables or enables the server to probe other servers to determine whether they support EDNS. -The acceptable values for this parameter are: - -- 0: Disables active support for EDNS probes. -- 1: Enables active support for EDNS probes. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableReception -Specifies whether the DNS server accepts queries that contain an EDNS record. -The acceptable values for this parameter are: - -- 0: Disables EDNS reception. -- 1: Enables EDNS reception. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerEDns - -## NOTES - -## RELATED LINKS - -[Get-DnsServerEDns](./Get-DnsServerEDns.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerForwarder.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerForwarder.md deleted file mode 100644 index 2c1c95f1cc..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerForwarder.md +++ /dev/null @@ -1,258 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverforwarder?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerForwarder - -## SYNOPSIS -Changes forwarder settings on a DNS server. - -## SYNTAX - -``` -Set-DnsServerForwarder [[-IPAddress] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-EnableReordering ] [-PassThru] [-ThrottleLimit ] - [-Timeout ] [-UseRootHint ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerForwarder** cmdlet changes forwarder settings on a Domain Name System (DNS) server. -This cmdlet sets or resets IP addresses to which the DNS server forwards DNS queries when it cannot solve them locally. -This cmdlet overwrites existing server level forwarders. - -Setting IP addresses by using this cmdlet causes the DNS server to perform recursive queries to the DNS servers at the specified IP addresses. -By default, the DNS server waits five seconds for a response from one forwarder IP address before it tries another forwarder IP address. -You can use the **Timeout** parameter to change the number of seconds that the DNS server waits. -When the server has exhausted all forwarders, it attempts standard recursion. -By default, a DNS server performs iterative queries when it cannot resolve a query. - -## EXAMPLES - -### Example 1: Set a forwarder on a DNS server -``` -PS C:\> Set-DnsServerForwarder -IPAddress "10.0.0.1" -PassThru -``` - -This command overwrites the list of existing forwarders on a DNS server and specifies the IP address of a DNS server where queries are forwarded. - -### Example 2: Disable reordering of forwarders on a DNS server -``` -PS C:\>Set-DnsServerForwarder -EnableReordering $false -PassThru -``` - -This command disables dynamic reordering of forwarders on a DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableReordering -Enables the DNS server to reorder forwarders dynamically. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IP addresses of DNS servers where queries are forwarded. -Specify the forwarders in the order that you want them to be configured. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Sets the number of seconds that the DNS server waits for a response from the forwarder. -The minimum value is 0, and the maximum value is 15. -The default value is 5. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UseRootHint -Prevents the DNS server from performing iterative queries. -If you set **UseRootHint** to $false, the DNS server forwards unresolved queries only to the DNS servers in the forwarders list and does not try iterative queries if the forwarders do not resolve the queries. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -Class DNSForwarderSettings - -{ - -uint32 ForwardDelegations; // Specifies whether the DNS server forwards queries to delegated subzones. - -DNSForwarders Forwarders\[\]; //Enumerates the list of IP addresses of forwarders to which the DNS server forwards queries. - -uint32 ForwardingTimeout; // Time, in seconds, that a DNS server that is forwarding a query will wait for resolution from the forwarder before it attempts to resolve the query itself. -This value is meaningless if the forwarding server is not set to use recursion. -To determine this, check the **IsSlave** Boolean property. - -boolean IsSlave; //True if the DNS server does not use recursion when name resolution through forwarders fails. - -} - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerForwarder - -## NOTES - -## RELATED LINKS - -[Get-DnsServerForwarder](./Get-DnsServerForwarder.md) - -[Add-DnsServerForwarder](./Add-DnsServerForwarder.md) - -[Remove-DnsServerForwarder](./Remove-DnsServerForwarder.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerGlobalNameZone.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerGlobalNameZone.md deleted file mode 100644 index 9c4709dcaf..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerGlobalNameZone.md +++ /dev/null @@ -1,326 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverglobalnamezone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerGlobalNameZone - -## SYNOPSIS -Changes configuration settings for a GlobalNames zone. - -## SYNTAX - -``` -Set-DnsServerGlobalNameZone [-AlwaysQueryServer ] [-AsJob] [-BlockUpdates ] - [-CimSession ] [-ComputerName ] [-Enable ] [-EnableEDnsProbes ] - [-GlobalOverLocal ] [-PassThru] [-PreferAaaa ] [-SendTimeout ] - [-ServerQueryInterval ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerGlobalNameZone** cmdlet enables or disables single-label Domain Name System (DNS) queries. -It also changes configuration settings for a GlobalNames zone. - -The GlobalNames zone supports short, easy-to-use names instead of fully qualified domain names (FQDNs) without using Windows Internet Name Service (WINS) technology. -For instance, DNS can query SarahJonesDesktop instead of SarahJonesDesktop.contoso.com. - -## EXAMPLES - -### Example 1: Enable a GlobalNames zone -``` -PS C:\> Set-DnsServerGlobalNameZone -Enable $true -PassThru -``` - -This command enables a GlobalNames zone on the current server. - -## PARAMETERS - -### -AlwaysQueryServer -Specifies whether a DNS server attempts to use cache values to update a list of DNS servers. -This value has no effect if the DNS server hosts a GlobalNames zone. - -If the value is $True, a DNS server queries a remote DNS server for an update to the list of remote DNS servers that are hosting a GlobalNames zone. - -If the value is $False, a DNS server attempts to use cached local service records for a GlobalNames zone to get an update to the list. - -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockUpdates -Specifies whether a DNS server blocks updates in authoritative zones for FQDNs that conflict with labels in a GlobalNames zone. -If the value is $True, a DNS server checks for a conflict and blocks an update when it finds a conflict. -If the value is $False, the server does not check. -The default value is $True. - -To check for conflicts, the DNS server removes the zone name (rightmost labels) and performs a search that is not case sensitive on its locally hosted GlobalNames zone. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Specifies whether to use a GlobalNames zone to resolve single-label names. -A value of $True enables the use of GlobalNames. -A value of $False disables the use of GlobalNames. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableEDnsProbes -Specifies whether a DNS server honors the EnableEDnsProbes value for a remote GlobalNames zone. -A DNS server can allow or refuse queries on Extended DNS (EDNS) information. - -If this value is $True, the server attempts EDNS queries for remote GlobalNames zones if the zones permit. - -If this value is $False, a DNS server does not attempt ENDS queries for remote GlobalNames zones. - -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -GlobalOverLocal -Specifies whether a DNS server first attempts to resolve names through a query of zones for which it is authoritative. -If the value is $True, a DNS server queries locally and then queries the GlobalNames zone. -If the value is $False, the server queries the GlobalNames zone and then queries globally. -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreferAaaa -Specifies whether a DNS server prefers IPv6 (AAAA) address records over IPv4 (A) address records for queries to a remote DNS server that hosts a GlobalNames zone. - -If this value is $True, a DNS server uses IPv6 addresses, unless no IPv6 value is available. - -If this value is $False, a DNS server uses IPv4 addresses, unless no IPv4 value is available. - -The default value is $False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SendTimeout -Specifies the number of seconds that a DNS server waits for a response to a query to a remote GlobalNames zone. - -The minimum value is 1. -The maximum value is 15. - -The default value is 3. -A DNS server interprets a value of 0 as the default value, 3. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServerQueryInterval -Specifies an interval, as a time-span object, between queries to refresh the set of remote DNS servers that are hosting the GlobalNames zone. - -The minimum value is 60 seconds. -The maximum value is 30 days. - -The default value is six hours. -A DNS server interprets a value of 0 as the default value, six hours. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerGlobalNameZone - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerGlobalQueryBlockList.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerGlobalQueryBlockList.md deleted file mode 100644 index 82fe57bca9..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerGlobalQueryBlockList.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverglobalqueryblocklist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerGlobalQueryBlockList - -## SYNOPSIS -Changes settings of a global query block list. - -## SYNTAX - -``` -Set-DnsServerGlobalQueryBlockList [[-List] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-Enable ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerGlobalQueryBlockList** cmdlet changes settings of a global query block list on a Domain Name System (DNS) server. -This cmdlet replaces all names in the list of names that the DNS server does not resolve with the names that you specify. - -If you need the DNS server to resolve names such as ISATAP and WPAD, remove these names from the list. -Web Proxy Automatic Discovery Protocol (WPAD) and Intra-site Automatic Tunnel Addressing Protocol (ISATAP) are two commonly deployed protocols that are particularly vulnerable to hijacking. - -## EXAMPLES - -### Example 1: Replace the names in a global query block list -``` -PS C:\> Set-DnsServerGlobalQueryBlockList -List "Isatap" -PassThru -Verbose -VERBOSE: Setting DNS server GlobalQueryBlockList on Fabrikam01 server. - -VERBOSE: GlobalQueryBlockList successfully set on server Fabrikam01. -Enable : True - -List : {isatap} -``` - -This command replaces the existing host names in a global query block list that has the host name Isatap. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Enables or disables support for the global query block list that blocks name resolution for names in the list. -The DNS Server service creates and enables the global query block list by default the first time that the service starts. - -When you disable the global query block list, the DNS Server service responds to queries for names in the block list. -When you enable the global query block list, the DNS Server service does not respond to queries for names in the block list. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -List -Specifies an array of host names. - -This cmdlet replaces the current global query block list with a list of the names that you specify. -To add a name to the list, you must also include all existing names in the list. -If you do not specify any names, the cmdlet clears the block list. - -By default, the global query block list contains the following items: ISATAP and WPAD. -The DNS Server service removes these names when it starts the first time if it finds these names in an existing zone. -If you need the DNS server to resolve names such as ISATAP and WPAD, remove them from the list. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -{ - -boolean EnableGlobalQueryBlockList; //Enables or disables support for the global query block list that blocks name resolution for names in the list. -The DNS Server service creates and enables the global query block list by default when the service starts the first time. - -string\[\] Names; //Replaces the current global query block list with a list of the names that you specify. -If you do not specify any names, this command clears the block list. - -} - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerGlobalQueryBlockList - -## NOTES - -## RELATED LINKS - -[Get-DnsServerGlobalQueryBlockList](./Get-DnsServerGlobalQueryBlockList.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerPrimaryZone.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerPrimaryZone.md deleted file mode 100644 index 446d518875..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerPrimaryZone.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverprimaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerPrimaryZone - -## SYNOPSIS -Changes settings for a DNS primary zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DnsServerPrimaryZone [-Name] [-AllowedDcForNsRecordsAutoCreation ] [-AsJob] - [-CimSession ] [-ComputerName ] [-DynamicUpdate ] [-Notify ] - [-NotifyServers ] [-PassThru] [-SecondaryServers ] [-SecureSecondaries ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DnsServerPrimaryZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-DirectoryPartitionName ] [-PassThru] [-ThrottleLimit ] -ReplicationScope [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-DnsServerPrimaryZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-PassThru] [-ThrottleLimit ] -ZoneFile [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerPrimaryZone** cmdlet changes settings for an existing Domain Name System (DNS) primary zone. -You can change values that are relevant for either Active Directory-integrated zones or file-backed zones. - -## EXAMPLES - -### Example 1: Change the dynamic update setting -``` -PS C:\> Set-DnsServerPrimaryZone -Name "western.contoso.com" -DynamicUpdate "NonsecureAndSecure" -PassThru -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -western.contoso.com Primary False True False False -``` - -This command changes the dynamic update setting to NonsecureAndSecure for the zone named western.contoso.com. -The example uses the **PassThru** parameter to return output. - -### Example 2: Change the replication scope -``` -PS C:\>Set-DnsServerPrimaryZone -Name "western.contoso.com" -ReplicationScope "Forest" -PassThru -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -western.contoso.com Primary False True False False -``` - -This command changes the replication scope of the zone named western.contoso.com. -The example uses the **PassThru** parameter to return output. - -### Example 3: Change the path name for the zone filename -``` -PS C:\>Set-DnsServerPrimaryZone -Name "western.contoso.com" -ZoneFile "tet23.dns" -PassThru -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -western.contoso.com Primary False False False False -``` - -This command changes the file name for the zone file for the zone western.contoso.com. -The example uses the **PassThru** parameter to return output. - -## PARAMETERS - -### -AllowedDcForNsRecordsAutoCreation -Specifies IP addresses of domain controllers that add their names in Name Server (NS) resource records for the zone. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the zone. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DynamicUpdate -Specifies how a zone accepts dynamic updates. -Servers that accept dynamic updates can receive client registration requests. -The acceptable values for this parameter are: - -- None -- Secure -- NonsecureAndSecure - -DNS update security is available only for Active Directory-integrated zones. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Notify -Specifies how a DNS master server notifies secondary servers of changes to resource records. -The acceptable values for this parameter are: - -- NoNotify. -The zone does not send change notifications to secondary servers. -- Notify. -The zone sends change notifications to all secondary servers. -- NotifyServers. -The zone sends change notifications to some secondary servers. -If you choose this option, specify the list of secondary servers in the **NotifyServers** parameter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NotifyServers -Specifies an array of IP addresses of secondary DNS servers that the DNS master server notifies of changes to resource records. -You need this parameter only if you selected the value NotifyServers for the **Notify** parameter. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies a partition on which to store an Active Directory-integrated zone. -The acceptable values for this parameter are: - -- Custom. -Any custom directory partition that a user creates. -Specify a custom directory partition by using the **DirectoryPartitionName** parameter. -- Domain. -The domain directory partition. -- Forest. -The ForestDnsZone directory partition. -- Legacy. -A legacy directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecondaryServers -Specifies an array of IP addresses of DNS servers that are allowed to receive this zone through zone transfers. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecureSecondaries -Specifies how a DNS master server allows zone transfers to secondary servers. -You can configure the DNS server to send zone transfers only certain servers. -If other servers request zone transfers, the DNS server rejects the requests. - -The acceptable values for this parameter are: - -- NoTransfer. -Zone transfers are not allowed on this DNS server for this zone. -- TransferAnyServer. -Zone transfers are allowed to any DNS server. -- TransferToZoneNameServer. -Zone transfers are allowed only to servers in the name servers (NS) records for this zone. -- TransferToSecureServers. -Zone transfers are allowed only for secondary servers. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies the name of a the zone file. -This parameter is relevant only for file-backed DNS. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerPrimaryZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerPrimaryZone](./Add-DnsServerPrimaryZone.md) - -[ConvertTo-DnsServerPrimaryZone](./ConvertTo-DnsServerPrimaryZone.md) - -[Restore-DnsServerPrimaryZone](./Restore-DnsServerPrimaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md deleted file mode 100644 index 2f01260790..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerRecursion.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverrecursion?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerRecursion - -## SYNOPSIS -Modifies recursion settings for a DNS server. - -## SYNTAX - -``` -Set-DnsServerRecursion [-AdditionalTimeout ] [-AsJob] [-CimSession ] - [-ComputerName ] [-Enable ] [-PassThru] [-RetryInterval ] [-SecureResponse ] - [-ThrottleLimit ] [-Timeout ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerRecursion** cmdlet modifies recursion settings for a Domain Name System (DNS) server. -Recursion occurs when a DNS server queries other DNS servers on behalf of a requesting client, and then sends the answer back to the client. - -## EXAMPLES - -### Example 1: Set the retry interval -``` -PS C:\> Set-DnsServerRecursion -RetryInterval 3 -PassThru -Enable : False - -AdditionalTimeout(s) : 4 - -RetryInterval(s) : 15 - -Timeout(s) : 8 - -SecureResponse : True -``` - -This command sets the retry interval to 3 seconds. - -## PARAMETERS - -### -AdditionalTimeout -Specifies the time interval, in seconds, that a DNS server waits as it uses recursion to get resource records from a remote DNS server. -We recommend that you limit the value to the range 0x00000000 to 0x0000000F (0 seconds to 15 seconds), inclusive. -However, you can use any value. -We recommend that you set the default value to 4. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IPv4 address; an IPv6 address; and any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enable -Enables or disables recursion. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetryInterval -Specifies elapsed seconds before a DNS server retries a recursive lookup. -If the parameter is undefined or zero, the DNS server retries after three seconds. -Valid values are in the range of 1 second to 15 seconds. - -We recommend that in general, you do not change the value of this parameter. -However, under a few circumstances you should consider changing the parameter value. -For example, if a DNS server contacts a remote DNS server over a slow link and retries the lookup before it gets a response, you can raise the retry interval to be slightly longer than the observed response time. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecureResponse -Indicates whether a DNS server screens DNS records against the zone of authority for the remote server, to prevent cache pollution. -If you set this to $True, the DNS server caches only those records that are in the zone of authority for the queried remote server. -Otherwise, the server caches all records in the remote server cache. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Determines the number of seconds that a DNS server waits before it stops trying to contact a remote server. -The valid value is in the range of 0x1 to 0xFFFFFFFF (1 second to 15 seconds). -The default setting is 0x8 (8 seconds). -We recommend that you increase this value when recursion occurs over a slow link. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRecursion - -## NOTES - -## RELATED LINKS - -[Get-DnsServerRecursion](./Get-DnsServerRecursion.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerResourceRecord.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerResourceRecord.md deleted file mode 100644 index 3e0c5d0f0c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerResourceRecord.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverresourcerecord?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerResourceRecord - -## SYNOPSIS -Changes a resource record in a DNS zone. - -## SYNTAX - -``` -Set-DnsServerResourceRecord [-ZoneName] [-OldInputObject] - [-NewInputObject] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerResourceRecord** cmdlet changes a resource record object located in a Domain Name System (DNS) zone. -You can use the **OldInputObject** parameter to specify a resource record object that you want to change and **NewInputObject** to specify a new resource record. -This cmdlet cannot change the Name or Type of a DNS server resource record object. - -## EXAMPLES - -### Example 1: Change the settings of a resource record -``` -PS C:\> $NewObj = $OldObj = Get-DnsServerResourceRecord -Name "Host01" -ZoneName "contoso.com" -RRType "A" - -PS C:\> $NewObj.TimeToLive = [System.TimeSpan]::FromHours(2) - -PS C:\> Set-DnsServerResourceRecord -NewInputObject $NewObj -OldInputObject $OldObj -ZoneName "contoso.com" -PassThru -HostName RecordType Timestamp TimeToLive RecordData - --------- ---------- --------- ---------- ---------- - -Host01 A 0 02:00:00 2.2.2.2 -``` - -In this example, the time to live (TTL) value of the resource record named Host01 in the zone named contoso.com is changed to 2 hours. - -The first command assigns a resource record named Host01 in the zone named contoso.com to the variables $NewObj and $OldObj. - -The second command sets the TTL time span for $NewObj to 2 hours. - -The third command changes the properties of $OldObj to the settings specified for $NewObj in the previous command. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewInputObject -Specifies a DNS server resource record object to overwrite the **OldInputObject** parameter value. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OldInputObject -Specifies a DNS server resource record object. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord - -## NOTES - -## RELATED LINKS - -[Get-DnsServerResourceRecord](./Get-DnsServerResourceRecord.md) - -[Add-DnsServerResourceRecord](./Add-DnsServerResourceRecord.md) - -[Remove-DnsServerResourceRecord](./Remove-DnsServerResourceRecord.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerResourceRecordAging.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerResourceRecordAging.md deleted file mode 100644 index 0ff1db8d05..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerResourceRecordAging.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverresourcerecordaging?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerResourceRecordAging - -## SYNOPSIS -Begins aging of resource records in a specified DNS zone. - -## SYNTAX - -``` -Set-DnsServerResourceRecordAging [-ZoneName] [[-NodeName] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-Force] [-Recurse] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerResourceRecordAging** cmdlet ages Domain Name System (DNS) resource records in a DNS zone. -You must enable aging at the zone level by using the Set-DnsServerZoneAging cmdlet. - -A resource record can remain after the resource is no longer part of the network. -Aging settings determine when a record can be removed as stale. -After that time, designated DNS servers can remove, or scavenge, a stale record. - -This cmdlet sets a time stamp to the current time for records in a specified zone on the specified DNS server, if you have enabled aging for the zone. - -## EXAMPLES - -### Example 1: Age records in a zone -``` -PS C:\> Set-DnsServerResourceRecordAging -ZoneName "contoso.com" -Force -Recurse -``` - -This command ages all the records under contoso.com, recursively. -The **Force** parameter overrides the default confirmation message. - -### Example 2: Age records under a node -``` -PS C:\>Set-DnsServerResourceRecordAging -NodeName "three.two" -ZoneName "contoso.com" -``` - -This command ages all the records under the three.two node in the zone contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Performs the action without a confirmation message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeName -Specifies a node or subtree in DNS zone. -The acceptable values for this parameter are: - -- @ for root node. -- The FQDN of a node (the name with a period (.) at the end). -- A single label for the name relative to the zone root. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that the DNS server ages all the nodes under the specified node. -Use this parameter to age all records in a zone. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DnsServerZoneAging](./Get-DnsServerZoneAging.md) - -[Set-DnsServerZoneAging](./Set-DnsServerZoneAging.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerRootHint.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerRootHint.md deleted file mode 100644 index af725db6b3..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerRootHint.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverroothint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerRootHint - -## SYNOPSIS -Replaces a list of root hints. - -## SYNTAX - -``` -Set-DnsServerRootHint [-InputObject] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerRootHint** cmdlet replaces the list of root hints on a Domain Name System (DNS) server. -This cmdlet overwrites the list of root hints with the list of root hints that you specify by using the **InputObject** parameter. - -## EXAMPLES - -### Example 1: Change the IP address of a root hint -``` -The first command adds a root hint for the DNS name server that is named H.Root-Servers.net and the IP address 172.24.60.128. -PS C:\>Add-DnsServerRootHint -NameServer "H.Root-Servers.net" -IPAddress 172.24.60.128 - -The second command assigns the value that is returned by the **Get-DnsServerRootHint** cmdlet to the variable $a. **Get-DnsServerRootHint** gets a list of all root hints on the local DNS server. The command then pipes that collection to the **Where-Object** cmdlet. **Where-Object** filters the resource record to get the root hint for the DNS name server that is named H.Root-Servers.net. -PS C:\>$a = (Get-DnsServerRootHint | Where-Object {$_.NameServer.RecordData.NameServer -eq "H.Root-Servers.net."} ) - -The third command sets the value of the IP address of the root hint to 172.24.60.132 for the DNS name server H.Root-Servers.net. -PS C:\>$a.IPAddress[0].RecordData.Ipv4address = "172.24.60.132" - -The fourth command replaces the list of root hints on the local DNS server with the root hint for the DNS name server H.Root-Servers.net. -PS C:\>Set-DnsServerRootHint $a -``` - -This example adds a root hint to the list of root hints on a DNS server and changes the IP address of the root hint. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerRootHint - -## NOTES - -## RELATED LINKS - -[Get-DnsServerRootHint](./Get-DnsServerRootHint.md) - -[Import-DnsServerRootHint](./Import-DnsServerRootHint.md) - -[Add-DnsServerRootHint](./Add-DnsServerRootHint.md) - -[Remove-DnsServerRootHint](./Remove-DnsServerRootHint.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerScavenging.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerScavenging.md deleted file mode 100644 index c3fa67fd87..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerScavenging.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverscavenging?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerScavenging - -## SYNOPSIS -Changes DNS server scavenging settings. - -## SYNTAX - -``` -Set-DnsServerScavenging [[-ScavengingState] ] [[-RefreshInterval] ] - [[-NoRefreshInterval] ] [[-ScavengingInterval] ] [-ApplyOnAllZones] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerScavenging** cmdlet changes scavenging settings on a DNS server. -If any of the set operations fail, the cmdlet continues to configure other settings. -The cmdlet displays the settings that it changed and the settings that it did not change. - -## EXAMPLES - -### Example 1: Change the refresh interval for a resource record -``` -PS C:\> Set-DnsServerScavenging -RefreshInterval 1.00:00:00 -Verbose -PassThru -``` - -This command changes the refresh interval to 1 day for scavenging on a local DNS server. - -## PARAMETERS - -### -ApplyOnAllZones -Applies the server settings on all zones. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoRefreshInterval -Specifies a length of time as a TimeSpan object. -**NoRefreshInterval** sets a period of time in which no refreshes are accepted for dynamically updated records. -Zones on the server inherit this value automatically. - -This value is the interval between the last update of a timestamp for a record and the earliest time when the timestamp can be refreshed. -The minimum value is 0. -The maximum value is 8760 hours (seven days). - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshInterval -Specifies the refresh interval as a TimeSpan object. -During this interval, a DNS server can refresh a resource record that has a non-zero time stamp. -Zones on the server inherit this value automatically. - -If a DNS server does not refresh a resource record that has a non-zero time stamp, the DNS server can remove that record during the next scavenging. - -Do not select a value smaller than the longest refresh period of a resource record registered in the zone. - -The minimum value is 0. -The maximum value is 8760 hours (seven days). -The default value is the same as the **DefaultRefreshInterval** property of the zone DNS server. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScavengingInterval -Specifies a length of time as a TimeSpan object. -**ScavengingInterval** determines whether the scavenging feature for the DNS server is enabled and sets the number of hours between scavenging cycles. - -The default setting is 0, which disables scavenging for the DNS server. -A setting greater than 0 enables scavenging for the server and sets the number of hours between scavenging cycles. -The minimum value is 0. -The maximum value is 8760 hours (seven days). - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScavengingState -Enables or disables automatic scavenging of stale records. -**ScavengingState** determines whether the DNS scavenging feature is enabled by default on newly created zones. -The acceptable values for this parameter are: -- $False. -Disables scavenging. -This is the default setting. -- $True. -Enables scavenging - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerScavenging - -## NOTES - -## RELATED LINKS - -[Get-DnsServerScavenging](./Get-DnsServerScavenging.md) - -[Start-DnsServerScavenging](./Start-DnsServerScavenging.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerSecondaryZone.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerSecondaryZone.md deleted file mode 100644 index d21460606c..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerSecondaryZone.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserversecondaryzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerSecondaryZone - -## SYNOPSIS -Change settings for a DNS secondary zone. - -## SYNTAX - -``` -Set-DnsServerSecondaryZone [-Name] [[-MasterServers] ] [[-ZoneFile] ] [-AsJob] - [-CimSession ] [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerSecondaryZone** cmdlet changes settings for an existing secondary zone on a Domain Name System (DNS) server. - -## EXAMPLES - -### Example 1: Change master servers for secondary zone -``` -PS C:\> Set-DnsServerSecondaryZone "west03.contoso.com" -MasterServers 172.23.90.124,2001:4898:7020:f100:458f:e6a2:fcaf:698c -PassThru -``` - -This command changes the master servers of the secondary domain named west03.contoso.com to 172.23.90.124 and 2001:4898:7020:f100:458f:e6a2:fcaf:698c. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -You can use both IPv4 and IPv6. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneFile -Specifies the name of the zone file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSecondaryZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerSecondaryZone](./Add-DnsServerSecondaryZone.md) - -[ConvertTo-DnsServerSecondaryZone](./ConvertTo-DnsServerSecondaryZone.md) - -[Restore-DnsServerSecondaryZone](./Restore-DnsServerSecondaryZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerSetting.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerSetting.md deleted file mode 100644 index b849077d9d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerSetting.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserversetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerSetting - -## SYNOPSIS -Modifies DNS server settings. - -## SYNTAX - -``` -Set-DnsServerSetting [[-InputObject] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerSetting** cmdlet modifies Domain Name System (DNS) server settings. - -## EXAMPLES - -### Example 1: Copy DNS server settings from one DNS server to another -``` -PS C:\>Get-DnsServerSetting -ComputerName "172.23.90.136" -All | Set-DnsServerSetting -``` - -This command copies DNS server settings from the DNS server that has an IP address of 172.23.90.136 to the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -Valid values are an IPv4 address; an IPv6 address; and any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -"Class: DNSServerSettings { - -string Name; //Specifies the FQDN or IP address of a DNS server. -This specification should be common across roles. - -uint32 Version; //Specifies the read-only version of the DNS server. - -sint32 RpcProtocol; //Specifies the remote procedure call (RPC) protocol or protocols over which administrative RPC runs. - -uint32 NameCheckFlag; //Specifies the set of eligible characters to use in DNS server names. - -uint32 AddressAnswerLimit; //Specifies the maximum number of host records that are returned in response to an address request. -Values of 5 through 28 are valid. - -uint32 BootMethod; //Specifies the initialization method for a DNS server. - -boolean DsAvailable; //Indicates whether an available directory service is on the DNS server. - -boolean DisableAutoReverseZones; //Indicates whether the DNS server automatically creates standard reverse lookup zones. - -boolean RoundRobin; //Indicates whether the DNS server uses the round robin mechanism to rotate the order of multiple address (A) records. - -boolean LooseWildcarding ;//Indicates whether the DNS server uses loose wildcards. -If undefined or zero, the server follows the wildcard behavior that is specified in the DNS RFC. -In this case, an administrator should include mail exchanger (MX) records for all hosts that cannot receive mail. -If nonzero, the server seeks the closest wildcard node and an administrator should put MX records at the zone root and in a wildcard node (*) directly below the zone root. -Administrators should also put self-referencing MX records on hosts that receive their own mail. - -boolean WriteAuthorityNS; //Indicates whether the DNS server writes name server (NS) and start of authority (SOA) records to the authority section on successful response. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSetting - -## NOTES - -## RELATED LINKS - -[Get-DnsServerSetting](./Get-DnsServerSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerSigningKey.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerSigningKey.md deleted file mode 100644 index 05422fd8a4..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerSigningKey.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserversigningkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerSigningKey - -## SYNOPSIS -Changes settings of a signing key. - -## SYNTAX - -``` -Set-DnsServerSigningKey [-ZoneName] [-KeyId] [-AsJob] [-CimSession ] - [-ComputerName ] [-DnsKeySignatureValidityPeriod ] [-DSSignatureValidityPeriod ] - [-NextRolloverAction ] [-PassThru] [-RolloverPeriod ] [-ThrottleLimit ] - [-ZoneSignatureValidityPeriod ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerSigningKey** cmdlet changes settings of a signing key for a zone. -You must specify the **ZoneName** parameter and at least one of the optional parameters. - -## EXAMPLES - -### Example 1: Retire signing keys during the next rollover -``` -PS C:\> Get-DnsServerSigningKey -ZoneName "sec.contoso.com" | Set-DnsServerSigningKey -NextRolloverAction "Retire" -``` - -This command retires the signing keys of a zone during the next rollover. -The **Get-DnsServerSigningKey** cmdlet gets the signing keys for the zone that is named sec.contoso.com and pipes the results to the **Set-DnsServerSigningKey** cmdlet. - -**Set-DnsServerSigningKey** specifies that the signing keys will be retired during the next rollover. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DnsKeySignatureValidityPeriod -Specifies the amount of time that signatures that cover DNSKEY record sets are valid. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DSSignatureValidityPeriod -Specifies the amount of time that signatures that cover DS record sets are valid. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeyId -Specifies the unique identifier of a key. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NextRolloverAction -Specifies the next rollover action. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RolloverPeriod -Specifies the amount of time between scheduled key rollovers. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone in which DNS Security Extensions (DNSSEC) operations are performed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ZoneSignatureValidityPeriod -Specifies the amount of time that signatures that cover all other record sets are valid. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerSigningKey - -## NOTES - -## RELATED LINKS - -[Get-DnsServerSigningKey](./Get-DnsServerSigningKey.md) - -[Add-DnsServerSigningKey](./Add-DnsServerSigningKey.md) - -[Remove-DnsServerSigningKey](./Remove-DnsServerSigningKey.md) - -[Disable-DnsServerSigningKeyRollover](./Disable-DnsServerSigningKeyRollover.md) - -[Enable-DnsServerSigningKeyRollover](./Enable-DnsServerSigningKeyRollover.md) - -[Invoke-DnsServerSigningKeyRollover](./Invoke-DnsServerSigningKeyRollover.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerStubZone.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerStubZone.md deleted file mode 100644 index b578066bc4..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerStubZone.md +++ /dev/null @@ -1,276 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverstubzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerStubZone - -## SYNOPSIS -Changes settings for a DNS server stub zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DnsServerStubZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-LocalMasters ] [-MasterServers ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DnsServerStubZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-DirectoryPartitionName ] [-PassThru] [-ThrottleLimit ] -ReplicationScope [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerStubZone** cmdlet changes settings for an existing stub zone. -A stub zone is a copy of a Domain Name System (DNS) zone that contains only resource records that identify the authoritative DNS servers for that zone. - -The stub zone can be a forward lookup zone or a reverse lookup zone. -The stub zone can be an Active Directory-integrated zone or a file-backed zone. - -## EXAMPLES - -### Example 1: Change master servers for a stub zone -``` -PS C:\> Set-DnsServerStubZone -Name "west03.contoso.com" -MasterServers 172.23.90.124,2001:4898:7020:f100:458f:e6a2:fcaf:698c -``` - -This command changes the master servers for a stub zone named west03.contoso.com. - -### Example 2: Change replication scope for a stub zone -``` -PS C:\>Set-DnsServerStubZone -Name "west04.contoso.com" -ReplicationScope "Domain" -PassThru -ZoneName ZoneType IsAutoCreated IsDsIntegrated IsReverseLookupZone IsSigned - --------- -------- ------------- -------------- ------------------- -------- - -west04.contoso.com Stub False True False -``` - -This command changes the replication scope for a stub zone named west04.contoso.com to all DNS servers in the domain. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), Hostname, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DirectoryPartitionName -Specifies a directory partition on which to store the zone. -Use this parameter when the **ReplicationScope** parameter has a value of Custom. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalMasters -Specifies list of master DNS servers stored in the Windows Registry on the local server. -If it exists, this list overrides the list of master servers stored in Active Directory. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MasterServers -Specifies an array of IP addresses of the master servers of the zone. -You can use both IPv4 and IPv6. - -The DNS server stores this list in the Windows Registry of the local server. -If it exists, this list overrides the list of master servers stored in Active Directory. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. -The cmdlet modifies settings for this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationScope -Specifies a partition on which to store an Active Directory-integrated zone. -The acceptable values for this parameter are: - -- Custom. -Any custom directory partition that a user creates. -Specify a custom directory partition by using the **DirectoryPartitionName** parameter. -- Domain. -The domain directory partition. -- Forest. -The ForestDnsZone directory partition. -- Legacy. -A legacy directory partition. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerStubZone - -## NOTES - -## RELATED LINKS - -[Add-DnsServerStubZone](./Add-DnsServerStubZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerZoneAging.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerZoneAging.md deleted file mode 100644 index 59c949a225..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerZoneAging.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverzoneaging?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerZoneAging - -## SYNOPSIS -Configures DNS aging settings for a zone. - -## SYNTAX - -``` -Set-DnsServerZoneAging [-Name] [[-Aging] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-NoRefreshInterval ] [-PassThru] [-RefreshInterval ] - [-ScavengeServers ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerZoneAging** cmdlet configures aging settings for a Domain Name System (DNS) server zone. - -A resource record can remain on a DNS server after the resource is no longer part of the network. -Aging settings determine when a record can be removed, or scavenged, as a stale record. - -## EXAMPLES - -### Example 1: Set a scavenging server -``` -PS C:\> Set-DnsServerZoneAging west01.contoso.com -Aging $true -ScavengeServers 172.18.1.1 -PassThru -Verbose -``` - -This command enables aging for a domain named west01.contoso.com and specifies a scavenging server. - -## PARAMETERS - -### -Aging -Indicates whether to enable aging and scavenging for a zone. -Aging and scavenging are not enabled by default. - -For a value of $True, a DNS server refreshes time stamps for resource records when the server receives a dynamic update request. -This enables DNS servers to scavenge resource records. - -For a value of $False, DNS servers do not refresh time stamps for resource records and do not scavenge resource records. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. -This cmdlet is relevant only for primary zones. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NoRefreshInterval -Specifies the length of time as a TimeSpan object. -This value is the interval between the last update of a timestamp for a record and the earliest time when the timestamp can be refreshed. -The minimum value is 0. -The maximum value is 8760 hours. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RefreshInterval -Specifies the refresh interval as a TimeSpan object. -During this interval, a DNS server can refresh a resource record that has a non-zero time stamp. - -If a resource record that has a non-zero time stamp is not refreshed for a period of the sum the values defined in the **NoRefreshInterval** parameter and the **RefreshInterval** parameter, a DNS server can remove that record during the next scavenging. - -Do not select a value smaller than the longest refresh period of a resource record registered in the zone. - -The minimum value is 0. -The maximum value is 8760 hours. -The default value is the same as the **DefaultRefreshInterval** property of the zone DNS server. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ScavengeServers -Specifies an array of IP addresses for DNS servers. -These servers can scavenge records in this zone. -If you do not specify any scavenge servers, any primary DNS server that is authoritative for the zone can scavenge. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneAging - -## NOTES - -## RELATED LINKS - - - -[Get-DnsServerZoneAging](./Get-DnsServerZoneAging.md) - diff --git a/docset/winserver2012-ps/dnsserver/Set-DnsServerZoneDelegation.md b/docset/winserver2012-ps/dnsserver/Set-DnsServerZoneDelegation.md deleted file mode 100644 index 207b9630bf..0000000000 --- a/docset/winserver2012-ps/dnsserver/Set-DnsServerZoneDelegation.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/set-dnsserverzonedelegation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DnsServerZoneDelegation - -## SYNOPSIS -Changes delegation settings for a child zone. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DnsServerZoneDelegation [-InputObject] [-AsJob] [-CimSession ] - [-ComputerName ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DnsServerZoneDelegation [-Name] [-ChildZoneName] [-NameServer] - [-IPAddress] [-AsJob] [-CimSession ] [-ComputerName ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DnsServerZoneDelegation** cmdlet changes delegation settings for a Domain Name System (DNS) server child zone. -For instance, you can change IP addresses for name servers for the delegated zone. - -## EXAMPLES - -### Example 1: Set delegation IP address -``` -PS C:\> Set-DnsServerZoneDelegation -Name "contoso.com" -ChildZoneName "west01" -NameServer "wserver.west01.contoso.com" -IPAddress 172.23.90.136,2001:4898:7020:f100:7ce3:4bb6:7f26:27c1 -PassThru -Verbose -``` - -This command sets the IP addresses for name servers for the delegated zone west01.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChildZoneName -Specifies a name for the child zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. -This parameter takes a Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation object. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of IP addresses for DNS servers for the child zone. -This value replaces any previously specified values. - -```yaml -Type: IPAddress[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of a zone. -The child zone is part of this zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NameServer -Specifies a name for the DNS server that hosts the child zone. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDelegation - -## NOTES - -## RELATED LINKS - -[Add-DnsServerZoneDelegation](./Add-DnsServerZoneDelegation.md) - -[Get-DnsServerZoneDelegation](./Get-DnsServerZoneDelegation.md) - -[Remove-DnsServerZoneDelegation](./Remove-DnsServerZoneDelegation.md) - diff --git a/docset/winserver2012-ps/dnsserver/Show-DnsServerCache.md b/docset/winserver2012-ps/dnsserver/Show-DnsServerCache.md deleted file mode 100644 index d971ae8662..0000000000 --- a/docset/winserver2012-ps/dnsserver/Show-DnsServerCache.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/show-dnsservercache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Show-DnsServerCache - -## SYNOPSIS -Shows the records in a DNS Server Cache. - -## SYNTAX - -``` -Show-DnsServerCache [-AsJob] [-CimSession ] [-ComputerName ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Show-DNSServerCache** shows all cached Domain Name System (DNS) server resource records in the following format: Name, ResourceRecordData, Time-to-Live (TTL). - -## EXAMPLES - -### Example 1: Show all resource records in a DNS server cache -``` -PS C:\> Show-DnsServerCache -ComputerName "Win12S-05.DNSServer-01.Contoso.com" -HostName RecordType Timestamp TimeToLive RecordData - --------- ---------- --------- ---------- ---------- - -@ NS 0 00:00:00 a.root-servers.net. - -@ NS 0 00:00:00 b.root-servers.net. - -@ NS 0 00:00:00 c.root-servers.net. - -@ NS 0 00:00:00 d.root-servers.net. - -@ NS 0 00:00:00 e.root-servers.net. - -@ NS 0 00:00:00 f.root-servers.net. - -@ NS 0 00:00:00 g.root- - -Win12S-05.DNSServer-01.... A 0 00:46:48 172.23.90.136 - -localhost A 0 17089.09:29:04 127.0.0.1 - -a.root-servers.net A 0 00:00:00 198.41.0.4 - -b.root-servers.net A 0 00:00:00 -``` - -This command shows all resource records that exist in a specified DNS server cache. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord[] - -## NOTES - -## RELATED LINKS - -[Clear-DnsServerCache](./Clear-DnsServerCache.md) - -[Get-DnsServerCache](./Get-DnsServerCache.md) - -[Set-DnsServerCache](./Set-DnsServerCache.md) - diff --git a/docset/winserver2012-ps/dnsserver/Show-DnsServerKeyStorageProvider.md b/docset/winserver2012-ps/dnsserver/Show-DnsServerKeyStorageProvider.md deleted file mode 100644 index 4575deda44..0000000000 --- a/docset/winserver2012-ps/dnsserver/Show-DnsServerKeyStorageProvider.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/show-dnsserverkeystorageprovider?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Show-DnsServerKeyStorageProvider - -## SYNOPSIS -Returns a list of key storage providers. - -## SYNTAX - -``` -Show-DnsServerKeyStorageProvider [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Show-DnsServerKeyStorageProvider** cmdlet returns a list key storage providers that are available on a DNS server. -You can use the key storage providers to create a zone signing key (ZSK) and a key signing key (KSK). - -## EXAMPLES - -### Example 1: Return key storage providers -``` -PS C:\> Show-DnsServerKeyStorageProvider -``` - -This command returns the key storage providers on the local DNS server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### System.String[] - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Start-DnsServerScavenging.md b/docset/winserver2012-ps/dnsserver/Start-DnsServerScavenging.md deleted file mode 100644 index a9d2e5017d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Start-DnsServerScavenging.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/start-dnsserverscavenging?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-DnsServerScavenging - -## SYNOPSIS -Notifies a DNS server to attempt a search for stale resource records. - -## SYNTAX - -``` -Start-DnsServerScavenging [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-DnsServerScavenging** cmdlet notifies a Domain Name System (DNS) server to attempt a search for stale resource records. -The successful completion of this command triggers an immediate start to a scavenge. - -Although this command to start a scavenge appears to complete successfully, the scavenge does not start unless the following preconditions are met: - -- Scavenging is enabled for both the server and the zone. -- The zone is started. -- The resource records have a time stamp. - -You can use the **Verbose** parameter to display all the records that the command deletes. -You can press Ctrl + C to end a scavenge that is running on a DNS server. -If the DNS server cannot run scavenging, the cmdlet displays the reasons why the scavenge did not start. - -## EXAMPLES - -### Example 1: Start a DNS server scavenge -``` -PS C:\> Start-DnsServerScavenging -Verbose -``` - -This command notifies the local DNS server to attempt an immediate search for stale resource records. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Notifies the DNS server to attempt an scavenge without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-DnsServerScavenging](./Set-DnsServerScavenging.md) - -[Get-DnsServerScavenging](./Get-DnsServerScavenging.md) - diff --git a/docset/winserver2012-ps/dnsserver/Start-DnsServerZoneTransfer.md b/docset/winserver2012-ps/dnsserver/Start-DnsServerZoneTransfer.md deleted file mode 100644 index 70aa8edc40..0000000000 --- a/docset/winserver2012-ps/dnsserver/Start-DnsServerZoneTransfer.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/start-dnsserverzonetransfer?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-DnsServerZoneTransfer - -## SYNOPSIS -Starts a zone transfer for a secondary DNS zone from master servers. - -## SYNTAX - -``` -Start-DnsServerZoneTransfer [-Name] [-AsJob] [-CimSession ] [-ComputerName ] - [-FullTransfer] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-DnsServerZoneTransfer** cmdlet starts a zone transfer of a secondary zone from the master servers. -You can do a full transfer, where the secondary Domain Name System (DNS) server gets a copy of all the resource records for the zone. -You can also do an incremental transfer, where the secondary DNS server gets new and changed resource records. - -A zone transfer forces a check of the version number in the master server Start of Authority (SOA) record. -If the version number on the master server is higher than the secondary server version number, then a zone transfer begins that updates the secondary server. -If the version number is the same, no zone transfer begins. - -## EXAMPLES - -### Example 1: Start a zone transfer -``` -PS C:\> Start-DnsServerZoneTransfer -Name "contoso.com" -``` - -This command starts a zone transfer on the local DNS server for the secondary zone named contoso.com. -The command does not use the **FullTransfer** parameter, so it performs an incremental transfer. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), Hostname, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FullTransfer -Performs a full transfer. -Without this parameter, the cmdlet does an incremental transfer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. -The cmdlet transfers records for this zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/dnsserver/Suspend-DnsServerZone.md b/docset/winserver2012-ps/dnsserver/Suspend-DnsServerZone.md deleted file mode 100644 index 5bf0ee443d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Suspend-DnsServerZone.md +++ /dev/null @@ -1,200 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/suspend-dnsserverzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-DnsServerZone - -## SYNOPSIS -Suspends a zone on a DNS server. - -## SYNTAX - -``` -Suspend-DnsServerZone [-Name] [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Suspend-DnsServerZone** cmdlet suspends a Domain Name System (DNS) zone. -While suspended, the DNS server ignores all queries for the zone. -Use the **Resume-DnsServerZone** cmdlet to resume a suspended zone. - -## EXAMPLES - -### Example 1: Suspend a server zone -``` -PS C:\> Suspend-DnsServerZone west02.contoso.com -Verbose -PassThru -Force -``` - -This command suspends the zone west02.contoso.com. -The command uses the **PassThru** parameter to create output and the **Force** parameter to skip the confirmation message. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suspends a zone without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone - -## NOTES - -## RELATED LINKS - -[Export-DnsServerZone](./Export-DnsServerZone.md) - -[Get-DnsServerZone](./Get-DnsServerZone.md) - -[Remove-DnsServerZone](./Remove-DnsServerZone.md) - -[Resume-DnsServerZone](./Resume-DnsServerZone.md) - -[Sync-DnsServerZone](./Sync-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Sync-DnsServerZone.md b/docset/winserver2012-ps/dnsserver/Sync-DnsServerZone.md deleted file mode 100644 index 8c8e0a3ec7..0000000000 --- a/docset/winserver2012-ps/dnsserver/Sync-DnsServerZone.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/sync-dnsserverzone?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Sync-DnsServerZone - -## SYNOPSIS -Checks the DNS server memory for changes, and writes them to persistent storage. - -## SYNTAX - -``` -Sync-DnsServerZone [[-Name] ] [-AsJob] [-CimSession ] [-ComputerName ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Sync-DnsServerZone** cmdlet synchronizes zone data and root hint data for a zone to the persistent storage. -The persistent storage can be Active Directory® Domain Services or a file. - -## EXAMPLES - -### Example 1: Sync a DNS server zone -``` -PS C:\> Sync-DnsServerZone -Name "west02.contoso.com" -PassThru -Verbose -``` - -This command synchronizes the contents of the zone named west02.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a zone. -If you do not specify a zone, the cmdlet syncs all zones on the DNS server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZone[] - -## NOTES - -## RELATED LINKS - -[Export-DnsServerZone](./Export-DnsServerZone.md) - -[Get-DnsServerZone](./Get-DnsServerZone.md) - -[Remove-DnsServerZone](./Remove-DnsServerZone.md) - -[Resume-DnsServerZone](./Resume-DnsServerZone.md) - -[Suspend-DnsServerZone](./Suspend-DnsServerZone.md) - diff --git a/docset/winserver2012-ps/dnsserver/Test-DnsServer.md b/docset/winserver2012-ps/dnsserver/Test-DnsServer.md deleted file mode 100644 index ca3ca7a78d..0000000000 --- a/docset/winserver2012-ps/dnsserver/Test-DnsServer.md +++ /dev/null @@ -1,203 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/test-dnsserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-DnsServer - -## SYNOPSIS -Tests that a specified computer is a functioning DNS server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Test-DnsServer [-IPAddress] [[-Context] ] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Test-DnsServer [-IPAddress] [-AsJob] [-CimSession ] [-ComputerName ] - [-ThrottleLimit ] -ZoneName -``` - -## DESCRIPTION -The **Test-DnsServer cmdlet** tests whether a computer is a functioning Domain Name System (DNS) server. -The DNS server must be running Windows Server® 2008 R2 operating system or above. - -When you specify a computer by its IP address only, the cmdlet tests whether the computer is a DNS server. -If you also specify a zone name, the cmdlet validates that the DNS server can resolve the specified zone. - -## EXAMPLES - -### Example 1: Test whether a DNS server is functional -``` -PS C:\>Test-DnsServer -IPAddress "10.123.183.155" -IPAddress Result RoundTripTime TcpTried UdpTried ---------- -------- ------------ -------- -------- -10.123.183.155 Success 00:00:11 False True -``` - -This command tests whether the computer that has an IP address of 10.123.183.155 is a functional DNS server. - -### Example 2: Test whether a DNS server is functional and has valid configured forwarders -``` -PS C:\>Test-DnsServer -IPAddress "10.123.183.155" -Context Forwarder - -IPAddress Result RoundTripTime TcpTried UdpTried ---------- -------- ------------ -------- -------- -10.123.183.155 Success 00:00:11 False True -``` - -This command tests whether the computer that has an IP address of 10.123.183.155 is a functional DNS server that has valid configured forwarders. - -### Example 3: Test whether a DNS server is functional and has valid configured root hints -``` -PS C:\>Test-DnsServer -IPAddress "10.123.183.155" -Context RootHints -IPAddress Result RoundTripTime TcpTried UdpTried ---------- -------- ------------ -------- -------- -10.123.183.155 NoResponse 00:00:12 False True -``` - -This command tests whether the computer that has an IP address of 10.123.183.155 is a functional DNS server that has valid configured root hints. - -### Example 4: Test whether a DNS server is functional and hosts the Contoso.com zone -``` -PS C:\>Test-DnsServer -IPAddress "10.123.183.155" -ZoneName "Contoso.com" -IPAddress Result RoundTripTime TcpTried UdpTried ---------- -------- ------------ -------- -------- -10.123.183.155 Success 00:00:00 False True -``` - -This command tests whether the computer that has an IP address of 10.123.183.155 is a functional DNS server that hosts the Contoso.com zone. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -The acceptable values for this parameter are: an IP V4 address; an IP V6 address; any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Context -Specifies functionalities to test. -Valid values are: DnsServer, Forwarder , and RootHints. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPAddress -Specifies an array of DNS server IP addresses. - -```yaml -Type: IPAddress[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of the zone that the server hosts. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerValidity[] - -## NOTES - -## RELATED LINKS - -[Get-DnsServer](./Get-DnsServer.md) - -[Set-DnsServer](./Set-DnsServer.md) - diff --git a/docset/winserver2012-ps/dnsserver/Test-DnsServerDnsSecZoneSetting.md b/docset/winserver2012-ps/dnsserver/Test-DnsServerDnsSecZoneSetting.md deleted file mode 100644 index 0e6e5677e5..0000000000 --- a/docset/winserver2012-ps/dnsserver/Test-DnsServerDnsSecZoneSetting.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/test-dnsserverdnsseczonesetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-DnsServerDnsSecZoneSetting - -## SYNOPSIS -Validates DNSSEC settings for a zone. - -## SYNTAX - -``` -Test-DnsServerDnsSecZoneSetting [-ZoneName] [-AsJob] [-CimSession ] - [-ComputerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Test-DnsServerDnsSecZoneSetting** cmdlet validates Domain Name System Security Extensions (DNSSEC) settings for a zone on a Domain Name System (DNS) server. -The cmdlet returns a validation object. - -## EXAMPLES - -### Example 1: Validate DNSSEC settings -``` -PS C:\> Test-DnsServerDnsSecZoneSetting -ZoneName "western.contoso.com" -``` - -This command validates DNSSEC settings for the zone named western.contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a DNS server. -If you do not specify this parameter, the command runs on the local system. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ZoneName -Specifies the name of a DNS zone. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerZoneDnsSecValidationResult - -## NOTES - -## RELATED LINKS - -[Get-DnsServerDnsSecZoneSetting](./Get-DnsServerDnsSecZoneSetting.md) - -[Set-DnsServerDnsSecZoneSetting](./Set-DnsServerDnsSecZoneSetting.md) - diff --git a/docset/winserver2012-ps/dnsserver/Unregister-DnsServerDirectoryPartition.md b/docset/winserver2012-ps/dnsserver/Unregister-DnsServerDirectoryPartition.md deleted file mode 100644 index b8dedccd0a..0000000000 --- a/docset/winserver2012-ps/dnsserver/Unregister-DnsServerDirectoryPartition.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/unregister-dnsserverdirectorypartition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Unregister-DnsServerDirectoryPartition - -## SYNOPSIS -Deregisters a DNS server from a DNS application directory partition. - -## SYNTAX - -``` -Unregister-DnsServerDirectoryPartition [-Name] [-AsJob] [-CimSession ] - [-ComputerName ] [-Force] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **UnRegister-DnsServerDirectoryPartition** cmdlet deregisters a Domain Name System (DNS) server from a specified DNS application directory partition. -After you deregister a DNS server from a DNS application directory partition, the DNS server removes itself the from the replication scope of the partition. - -## EXAMPLES - -### Example 1: Deregister a DNS server from a directory application partition -``` -PS C:\> UnRegister-DnsServerDirectoryPartition -Name "ADpart" -Verbose -``` - -This command deregisters a DNS server from the DNS directory application partition named ADpart. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies a remote DNS server. -You can specify an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Deregisters a DNS server from a DNS application directory partition without prompting you for confirmation. -By default, the cmdlet prompts you for confirmation before it proceeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the FQDN of a DNS application directory partition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#DnsServerDirectoryPartition - -## NOTES - -## RELATED LINKS - -[Add-DnsServerDirectoryPartition](./Add-DnsServerDirectoryPartition.md) - -[Get-DnsServerDirectoryPartition](./Get-DnsServerDirectoryPartition.md) - -[Register-DnsServerDirectoryPartition](./Register-DnsServerDirectoryPartition.md) - -[Remove-DnsServerDirectoryPartition](./Remove-DnsServerDirectoryPartition.md) - diff --git a/docset/winserver2012-ps/dnsserver/Update-DnsServerTrustPoint.md b/docset/winserver2012-ps/dnsserver/Update-DnsServerTrustPoint.md deleted file mode 100644 index c39f4ff57f..0000000000 --- a/docset/winserver2012-ps/dnsserver/Update-DnsServerTrustPoint.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: DnsServer_Cmdlets.xml -Module Name: DnsServer -online version: https://learn.microsoft.com/powershell/module/dnsserver/update-dnsservertrustpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-DnsServerTrustPoint - -## SYNOPSIS -Updates all trust points in a DNS trust anchor zone. - -## SYNTAX - -``` -Update-DnsServerTrustPoint [-AsJob] [-CimSession ] [-ComputerName ] [-Force] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Update-DnsServerTrustPoint** updates all trust points that are listed in a DNS trust anchor zone. - -## EXAMPLES - -### Example 1: Refresh all trust points on a specified DNS server -``` -PS C:\> Update-DnsServerTrustPoint -ComputerName "ContosoServer01" -Verbose -``` - -This command updates all trust points on a DNS server named ContosoServer01. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -The acceptable values for this parameter are: an IP address or any value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Refreshes a DNS server trust point object without prompting you for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DnsServerTrustPoint](./Get-DnsServerTrustPoint.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterCheckpoint.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterCheckpoint.md deleted file mode 100644 index 083eaab886..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterCheckpoint.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustercheckpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterCheckpoint - -## SYNOPSIS -Adds a cryptographic key checkpoint or registry checkpoint for a resource. - -## SYNTAX - -``` -Add-ClusterCheckpoint [[-ResourceName] ] [-Cluster ] [-CryptoCheckpointKey ] - [-CryptoCheckpointName ] [-CryptoCheckpointType ] [-InputObject ] - [-RegistryCheckpoint ] -``` - -## DESCRIPTION -The **Add-ClusterCheckpoint** cmdlet adds a cryptographic key checkpoint or registry checkpoint for a resource. - -Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. -Applications might store information locally in two ways. -One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterCheckpoint -ResourceName "cluster name" -RegistryCheckpoint "software\clusname" -Resource Name --------- ---- -cluster name software\clusname -``` - -This example adds a registry checkpoint called software\clusname for the resource named cluster name. - -### Example 2 -``` -PS C:\>Get-ClusterResource -Name "Cluster Name" | Add-ClusterCheckpoint -CryptoCheckpointName "Microsoft Base Cryptographic Provider v1.0" -CryptoCheckpointType 1 -CryptoCheckpointKey "Crypto" -Resource Name Type Key --------- ---- ---- --- -Cluster Name Microsoft Base Cryptograph... 1 Crypto -``` - -This example adds a cryptographic checkpoint for the resource named Cluster Name. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoCheckpointKey -Specifies the key of a cryptographic key checkpoint to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoCheckpointName -Specifies the name of a cryptographic key checkpoint to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoCheckpointType -Specifies the type of a cryptographic key checkpoint to add. -Options depend on the cryptographic provider. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to run the cmdlet or the cluster resource for which the checkpoint should be added. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RegistryCheckpoint -Specifies the name of the registry checkpoint to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the resource for which a checkpoint should be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Get-ClusterCheckpoint](./Get-ClusterCheckpoint.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Remove-ClusterCheckpoint](./Remove-ClusterCheckpoint.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterDisk.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterDisk.md deleted file mode 100644 index 2c3358dc9d..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterDisk.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterDisk - -## SYNOPSIS -Makes a new disk available for use in a failover cluster. - -## SYNTAX - -``` -Add-ClusterDisk [-InputObject] [-Cluster ] -``` - -## DESCRIPTION -The **Add-ClusterDisk** cmdlet makes a new disk available for use in a failover cluster. -The disk (LUN) must be exposed to all nodes in the failover cluster, and should not be exposed to any other servers. - -When adding a disk, make sure that the configuration of the storage allows the operating system to recognize and mount the disk as needed. -The disk must be a basic disk (not a dynamic disk) and should not be exposed to servers outside the cluster. -The Get-ClusterAvailableDisk cmdlet gets information about disks that you can add to the cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterAvailableDisk | Add-ClusterDisk -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 7 OnlinePending Available Storage Physical Disk -Cluster Disk 8 OnlinePending Available Storage Physical Disk -``` - -This example identifies the disks that are ready to be added to the cluster, and then adds them to Available Storage cluster group. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterAvailableDisk | Where-Object -FilterScript { $_.ScsiAddress -Eq 50331651 } | Add-ClusterDisk -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 4 OnlinePending Available Storage Physical Disk -``` - -This example examines disks that are ready to be added to the cluster, finds the disk with a specific SCSI address, and adds it to Available Storage cluster group. - -### EXAMPLE 3 -``` -PS C:\>Get-Disk -Number 11 | Add-Clusterdisk -Name State OwnerGroup ResourceType ----- ----- ---------- ------------ -Cluster Disk 5 OnlinePending Available Storage Physical Disk -``` - -This example clusters a physical disk; this cmdlet adds a physical disk to the **Available Storage** for the cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the list of shared disks to add to the cluster. -The list of disks is generated with the Get-ClusterAvailableDisk cmdlet. - -```yaml -Type: PSObject[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterDiskInfo - -### Microsoft.Management.Infrastructure.CimInstance -This object is output from the Get-Disk and the Get-VirtualDisk cmdlets. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_Disk -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_VirtualDisk -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Get-ClusterAvailableDisk](./Get-ClusterAvailableDisk.md) - -[Test-Cluster](./Test-Cluster.md) - -[Get-Disk](../storage/Get-Disk.md) - -[Get-VirtualDisk](../storage/Get-VirtualDisk.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterFileServerRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterFileServerRole.md deleted file mode 100644 index 39ad1bb128..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterFileServerRole.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterfileserverrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterFileServerRole - -## SYNOPSIS -Creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users). - -## SYNTAX - -``` -Add-ClusterFileServerRole [[-Name] ] [-Cluster ] [-IgnoreNetwork ] - [-InputObject ] [-StaticAddress ] [-Wait ] -Storage -``` - -## DESCRIPTION -The **Add-ClusterFileServerRole** cmdlet creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users). - -When adding a clustered file server, specify a name for the file server, any IP address information that is not automatically supplied by your DHCP settings, and the storage volume or volumes that the clustered file server should use. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 8" -Name OwnerNode State ----- --------- ----- -cluster1FS node1 Online -``` - -This example creates a clustered file server using Cluster Disk 8, and assigns a default name. - -### Example 2 -``` -PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 6" -Name cluster1FS12 -Name OwnerNode State ----- --------- ----- -cluster1FS12 node1 Online -``` - -This example creates a clustered file server using Cluster Disk 6, and assigns the name cluster1FS12. - -### Example 3 -``` -PS C:\>Add-ClusterFileServerRole -Storage "Cluster Disk 8" -Wait 0 -Name OwnerNode State ----- --------- ----- -cluster1FS node1 Pending -``` - -This example creates a clustered file server using Cluster Disk 8, and assigns a default name. -The cmdlet completes without waiting for all resources to come online. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available file server. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available file server to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available file server. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterScaleOutFileServerRole](./Add-ClusterScaleOutFileServerRole.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericApplicationRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericApplicationRole.md deleted file mode 100644 index b19492ac0a..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericApplicationRole.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergenericapplicationrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterGenericApplicationRole - -## SYNOPSIS -Configures high availability for an application that was not originally designed to run in a failover cluster. - -## SYNTAX - -``` -Add-ClusterGenericApplicationRole [[-Name] ] [-CheckpointKey ] [-Cluster ] - [-IgnoreNetwork ] [-InputObject ] [-Parameters ] - [-StaticAddress ] [-Storage ] [-Wait ] -CommandLine -``` - -## DESCRIPTION -The **Add-ClusterGenericApplicationRole** cmdlet configures high availability for an application that was not originally designed to run in a failover cluster. - -If an application is run as a Generic Application, the cluster software will start the application, then periodically query the operating system to see whether the application appears to be running. -If so, then it is presumed to be online and will not be restarted or failed over. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Name OwnerNode State ----- --------- ----- -cluster1GenApp node2 Online -``` - -This example configures NewApplication.exe as a generic clustered application. -A default name will be used for client access and this application requires no storage. - -### Example 2 -``` -PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Storage "Cluster Disk 4" -Name NewApplication -Name OwnerNode State ----- --------- ----- -NewApplication node2 Online -``` - -This example configures NewApplication.exe as a generic clustered application using Cluster Disk 4, and assigns the name NewApplication. - -### Example 3 -``` -PS C:\>Add-ClusterGenericApplicationRole -CommandLine NewApplication.exe -Wait 0 -Name OwnerNode State ----- --------- ----- -cluster1GenApp node2 Pending -``` - -This example configures NewApplication.exe as a generic clustered application and assigns the name NewApplication. -The cmdlet completes without waiting for all resources to come online. - -## PARAMETERS - -### -CheckpointKey -Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. -All registry paths are relative to HKEY_LOCAL_MACHINE. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommandLine -Specifies the Windows PowerShell® command line to use for the highly available generic application. -If the full path is specified, then the current directory is parsed out of the Windows PowerShell command line. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available application. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available application to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies the parameters to use for the highly available generic application. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available application. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterGenericScriptRole](./Add-ClusterGenericScriptRole.md) - -[Add-ClusterGenericServiceRole](./Add-ClusterGenericServiceRole.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericScriptRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericScriptRole.md deleted file mode 100644 index 994cb0d67d..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericScriptRole.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergenericscriptrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterGenericScriptRole - -## SYNOPSIS -Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster. - -## SYNTAX - -``` -Add-ClusterGenericScriptRole [[-Name] ] [-Cluster ] [-IgnoreNetwork ] - [-InputObject ] [-StaticAddress ] [-Storage ] [-Wait ] - -ScriptFilePath -``` - -## DESCRIPTION -The **Add-ClusterGenericScriptRole** cmdlet configures an application controlled by a script that runs in Windows Script Host, within a failover cluster. - -The script provides the cluster software with information about the current state of the application. -As needed, the cluster software will restart or fail over the script (and through it, the application will be restarted or failed over). - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Name OwnerNode State ----- --------- ----- -cluster1GenScript node2 Online -``` - -This example configures the script named script1.vbs to run within a failover cluster, using defaults for the name and IP address, and does not assign a disk. - -### Example 2 -``` -PS C:\>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Storage "Cluster Disk 4" -Name script1 -Name OwnerNode State ----- --------- ----- -script1 node2 Online -``` - -This example configures the script named script1.vbs to run within a failover cluster and use Cluster Disk 4. -The cmdlet assigns the clustered script the name script1. - -### Example 3 -``` -PS C:\>Add-ClusterGenericScriptRole -ScriptFilePath script1.vbs -Wait 0 -Name OwnerNode State ----- --------- ----- -cluster1GenScript node2 Pending -``` - -This example configures the script called script1.vbs to run within a failover cluster, using defaults for the name and IP address, and does not assign a disk. -The cmdlet completes without waiting for all resources to come online. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available script. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available script to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ScriptFilePath -Specifies the path of the script file to use for the highly available script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available script. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterGenericApplicationRole](./Add-ClusterGenericApplicationRole.md) - -[Add-ClusterGenericServiceRole](./Add-ClusterGenericServiceRole.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericServiceRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericServiceRole.md deleted file mode 100644 index 7e9838fbd3..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterGenericServiceRole.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergenericservicerole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterGenericServiceRole - -## SYNOPSIS -Configures high availability for a service that was not originally designed to run in a failover cluster. - -## SYNTAX - -``` -Add-ClusterGenericServiceRole [[-Name] ] [-CheckpointKey ] [-Cluster ] - [-IgnoreNetwork ] [-InputObject ] [-StaticAddress ] - [-Storage ] [-Wait ] -ServiceName -``` - -## DESCRIPTION -The **Add-ClusterGenericServiceRole** cmdlet configures high availability for a service that was not originally designed to run in a failover cluster. -The cluster software will start the service, then periodically query the Service Controller (a feature of the operating system) to determine whether the service appears to be running. -If so, then it is presumed to be online, and will not be restarted or failed over. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterGenericServiceRole -ServiceName Service1 -Name OwnerNode State ----- --------- ----- -cluster1GenSvc node1 Online -``` - -This example configures Service1 as a generic clustered service, using defaults for the name and IP address, and does not assign a disk. - -### Example 2 -``` -PS C:\>Add-ClusterGenericServiceRole -ServiceName Service1 -Storage "Cluster Disk 6" -Name OwnerNode State ----- --------- ----- -cluster1GenSvc node1 Online -``` - -This example configures Service1 as a generic clustered service using Cluster Disk 6, and assigns defaults for the name and IP address. - -## PARAMETERS - -### -CheckpointKey -Specifies a comma-separated list of registry checkpoint keys to add for this highly available generic application. -All registry paths are relative to HKEY_LOCAL_MACHINE. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available service. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available service to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServiceName -Specifies the service name to use for the highly available service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available service. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the `Wait` parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterGenericApplicationRole](./Add-ClusterGenericApplicationRole.md) - -[Add-ClusterGenericScriptRole](./Add-ClusterGenericScriptRole.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterGroup.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterGroup.md deleted file mode 100644 index 31a58dc9b6..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterGroup.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustergroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterGroup - -## SYNOPSIS -Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. - -## SYNTAX - -``` -Add-ClusterGroup [-Name] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Add-ClusterGroup** cmdlet adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. -A resource group, or a clustered role, is the unit of failover. -During failover, all resources in the resource group move together. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-ClusterGroup -Name Group1 -Name OwnerNode State ----- --------- ----- -Group1 node1 Online -``` - -This example adds an empty resource group called Group1 to the failover cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the resource group. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group to add. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterNode.md deleted file mode 100644 index afa662434e..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterNode.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterNode - -## SYNOPSIS -Adds a node (server) to a failover cluster. - -## SYNTAX - -``` -Add-ClusterNode [[-Name] ] [-Cluster ] [-InputObject ] [-NoStorage] -``` - -## DESCRIPTION -The **Add-ClusterNode** cmdlet adds a node, or server, to a failover cluster. -Before adding the new node, you should run validation tests on the existing nodes together with the proposed new node. - -Before adding the new node, you should run validation tests on the existing nodes together with the proposed new node. -By running the validation tests, you can confirm that the server to be added is connected correctly to the networks and storage and that it contains the same software updates. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-ClusterNode -Name node4 -Name State ----- ----- -node4 Up -``` - -This example adds node named node4 to the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-Cluster -Name cluster1 | Add-ClusterNode -Name node3 -Name State ----- ----- -node3 Up -``` - -This example adds the node named node3 to cluster called cluster1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster to which to add the new cluster node. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node to add. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStorage -Ensures that shared storage, on the node being joined to the cluster, will not be added to the cluster during the join operation. -Shared storage can be added by piping the ClusterDiskInfo object from the Get-ClusterAvailableDisk cmdlet into the Add-ClusterDisk cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## NOTES - -## RELATED LINKS - -[Add-ClusterDisk](./Add-ClusterDisk.md) - -[Get-ClusterAvailableDisk](./Get-ClusterAvailableDisk.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[New-Cluster](./New-Cluster.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - -[Resume-ClusterNode](./Resume-ClusterNode.md) - -[Start-ClusterNode](./Start-ClusterNode.md) - -[Stop-ClusterNode](./Stop-ClusterNode.md) - -[Suspend-ClusterNode](./Suspend-ClusterNode.md) - -[Test-Cluster](./Test-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterPrintServerRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterPrintServerRole.md deleted file mode 100644 index 2d166f6d02..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterPrintServerRole.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterprintserverrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterPrintServerRole - -## SYNOPSIS -Creates a clustered print server, a resource group that includes a printer and a disk for storing print job information and printer drivers. - -## SYNTAX - -``` -Add-ClusterPrintServerRole [[-Name] ] [-Cluster ] [-IgnoreNetwork ] - [-InputObject ] [-StaticAddress ] [-Storage ] [-Wait ] -``` - -## DESCRIPTION -The **Add-ClusterPrintServerRole** cmdlet creates a clustered print server (a resource group that includes a printer and a disk for storing print job information and printer drivers). - -When adding a clustered print server, specify a name for the print server, any IP address information that is not automatically supplied by your DHCP settings, and the storage volume or volumes that the clustered print server should use for print job information and printer drivers. - -Note: This cmdlet has been deprecated and is only supported on firstref_server_7 and lower. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterPrintServerRole -Storage "Cluster Disk 5" -Name OwnerNode State ----- --------- ----- -cluster1PS node1 Online -``` - -This example creates a clustered print server using Cluster Disk 5, and assigns a default name. - -### Example 2 -``` -PS C:\>Add-ClusterPrintServerRole -Storage "Cluster Disk 5" -Name MyPrintServer -Name OwnerNode State ----- --------- ----- -MyPrintServer node1 Online -``` - -This example creates a clustered print server using Cluster Disk 5, and assigns the name MyPrintServer. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available print server. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available print server to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available print server. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterResource.md deleted file mode 100644 index 67fe04d938..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterResource.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterResource - -## SYNOPSIS -Adds a resource to a clustered role, or resource group, in a failover cluster. - -## SYNTAX - -``` -Add-ClusterResource [-Name] [[-Group] ] [-ResourceType] [-Cluster ] - [-InputObject ] [-SeparateMonitor] -``` - -## DESCRIPTION -The **Add-ClusterResource** cmdlet adds a resource to a clustered role, or resource group, in a failover cluster. -Before adding the resource, obtain the resource type and the name of the group to which to add the resource. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-ClusterResource -Name resource1 -ResourceType "IP Address" -Group ClusterSrv1 -Name State Group ResourceType ----- ----- ----- ------------ -resource1 Offline ClusterSrv1 IP Address -``` - -This example creates a new IP Address resource called resource1 on the local cluster. -The cmdlet configures the resource as part of the clustered role, or resource group, called ClusterSrv1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the name of the clustered role where the new resource is added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the clustered role where the new resource is added. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the name of the cluster resource type for the new cluster resource. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: restype, type - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SeparateMonitor -Specifies that the new resource should run in a separate resource monitor. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterResourceDependency.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterResourceDependency.md deleted file mode 100644 index 1edcae234e..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterResourceDependency.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterresourcedependency?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterResourceDependency - -## SYNOPSIS -Adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster. - -## SYNTAX - -``` -Add-ClusterResourceDependency [[-Resource] ] [[-Provider] ] [-Cluster ] - [-InputObject ] -``` - -## DESCRIPTION -The **Add-ClusterResourceDependency** cmdlet adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster. Existing dependencies will remain on the list. If you specify the *InputObject* parameter, the *Resource* parameter will be ignored. - -A dependent resource is brought online after the resources on which it depends. -A dependent resource is taken offline before the resources on which it depends. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Add-ClusterResourceDependency -Resource "FileServer-(cluster1FS12)" -Provider "Cluster Disk 4" -Name State Group ResourceType ----- ----- ----- ------------ -FileServer-(clus... Online cluster1FS12 File Server -``` - -This example adds the resource named "Cluster Disk 4" to the list of resources on which the resource called "FileServer-(cluster1FS12)" depends, using AND as the connector. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource for which to add the dependency. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Provider -Specifies the cluster resource to add as a dependency. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource for which to add the dependency. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Get-ClusterResourceDependency](./Get-ClusterResourceDependency.md) - -[Get-ClusterResourceDependencyReport](./Get-ClusterResourceDependencyReport.md) - -[Remove-ClusterResourceDependency](./Remove-ClusterResourceDependency.md) - -[Set-ClusterResourceDependency](./Set-ClusterResourceDependency.md) diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterResourceType.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterResourceType.md deleted file mode 100644 index bc233688fc..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterResourceType.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterresourcetype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterResourceType - -## SYNOPSIS -Adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type. - -## SYNTAX - -``` -Add-ClusterResourceType [-Name] [-Dll] [[-DisplayName] ] [-Cluster ] - [-InputObject ] -``` - -## DESCRIPTION -The **Add-ClusterResourceType** cmdlet adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type. - -The failover cluster software provides Resource DLL files for the most common types of resources. -Using the application programming interface (API) provided in the Microsoft Platform Software Development Kit (SDK), other vendors can add support for other resource types. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-ClusterResourceType -Name ResType3 -InputObject C:\res3.dll -Name DisplayName ----- ----------- -ResType3 ResType3 -``` - -This example creates ResType3 on the local cluster using res3.dll located on the provided resource DLL file path C:\. - -### EXAMPLE 2 -``` -PS C:\>Add-ClusterResourceType -Name ResType4 -InputObject C:\res4.dll -DisplayName "Resource Type 4" -Name DisplayName ----- ----------- -ResType4 Resource Type 4 -``` - -This example creates ResType4 on the local cluster using res4.dll located on the provided resource DLL file path C:\. -The display name of the resource type is Resource Type 4. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name for the resource type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dll -Specifies the DLL file path for the resource type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to register the new resource type. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource type to register. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceType - -## NOTES - -## RELATED LINKS - -[Get-ClusterResourceType](./Get-ClusterResourceType.md) - -[Remove-ClusterResourceType](./Remove-ClusterResourceType.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterScaleOutFileServerRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterScaleOutFileServerRole.md deleted file mode 100644 index 89f0bec473..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterScaleOutFileServerRole.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterscaleoutfileserverrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterScaleOutFileServerRole - -## SYNOPSIS -Creates a clustered file server for scale-out application data. - -## SYNTAX - -``` -Add-ClusterScaleOutFileServerRole [[-Name] ] [-Cluster ] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Add-ClusterScaleOutFileServerRole** cmdlet creates a clustered file server for scale-out application data. -A file server for scale-out application data provides storage for applications or virtual machines that leave files open for extended periods of time. -Client connections are distributed across nodes for better throughput. -This type of file server supports the Server Message Block (SMB) protocol. -It does not support the Network File System (NFS) protocol, or certain role services such as File Server Resource Manager (FSRM) or Distributed File System (DFS) Replication. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterScaleOutFileServerRole -Name OwnerNode State ----- --------- ----- -clusterSOFS CLUSTER-N2 Online -``` - -This example creates a highly available Scale-out file server role. - -### Example 2 -``` -PS C:\>Add-ClusterScaleOutFileServerRole -Wait 0 -Name OwnerNode State ----- --------- ----- -clusterSOFS CLUSTER-N2 Pending -``` - -This example creates a highly available scale out file server role. -The cmdlet completes without waiting for all resources to come online. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available scale-out file server. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available scale-out file server being created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterFileServerRole](./Add-ClusterFileServerRole.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterServerRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterServerRole.md deleted file mode 100644 index 06efcb4fec..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterServerRole.md +++ /dev/null @@ -1,193 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusterserverrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterServerRole - -## SYNOPSIS -Creates a highly available basic server that contains only a client access point and storage. - -## SYNTAX - -``` -Add-ClusterServerRole [[-Name] ] [-Cluster ] [-IgnoreNetwork ] - [-InputObject ] [-StaticAddress ] [-Storage ] [-Wait ] -``` - -## DESCRIPTION -The **Add-ClusterServerRole** cmdlet creates a highly available basic server that contains only a client access point and storage. -After adding the basic server, other resources can be added to create a functional clustered role. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterServerRole -Name OwnerNode State ----- --------- ----- -cluster1Other node2 Online -``` - -This example establishes a default name for a clustered server. -It does not specify any storage. -Storage and other resources can be added later. - -### Example 2 -``` -PS C:\>Add-ClusterServerRole -Storage "Cluster Disk 3" -Name MainSrv1 -Name OwnerNode State ----- --------- ----- -MainSrv1 node2 Online -``` - -This example creates a clustered service or application using Cluster Disk 3, and assigns the name MainSrv1. - -### Example 3 -``` -PS C:\>Add-ClusterServerRole -Storage "Cluster Disk 4","Cluster Disk 5" -Name MainSrv2 -Name OwnerNode State ----- --------- ----- -MainSrv2 node2 Online -``` - -This example creates a clustered service or application using Cluster Disk 4 and Cluster Disk 5, and assigns the name MainSrv2. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available role or application. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available server to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available server. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterSharedVolume.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterSharedVolume.md deleted file mode 100644 index 7ba3d43646..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterSharedVolume.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustersharedvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterSharedVolume - -## SYNOPSIS -Makes a volume available in Cluster Shared Volumes in a failover cluster. - -## SYNTAX - -``` -Add-ClusterSharedVolume [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Add-ClusterSharedVolume** cmdlet makes a volume available in the Cluster Shared Volumes in a failover cluster. -The Cluster Shared Volume must be chosen from the disks in Available Storage (that is, disks that have been added to the cluster but not assigned to a specific use in the cluster). - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterSharedVolume -Name "Cluster Disk 4" -Name State Node ----- ----- ---- -Cluster Disk 4 Online node2 -``` - -This example adds Cluster Disk 4 to the Cluster Shared Volumes on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster disk resource to be added to the Cluster Shared Volumes. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster disk resource to add. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterDisk](./Add-ClusterDisk.md) - -[Get-ClusterSharedVolume](./Get-ClusterSharedVolume.md) - -[Move-ClusterSharedVolume](./Move-ClusterSharedVolume.md) - -[Remove-ClusterSharedVolume](./Remove-ClusterSharedVolume.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md deleted file mode 100644 index 1e8c968e99..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterVMMonitoredItem.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustervmmonitoreditem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterVMMonitoredItem - -## SYNOPSIS -Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. - -## SYNTAX - -``` -Add-ClusterVMMonitoredItem [[-VirtualMachine] ] [-Cluster ] [-EventId ] - [-EventLog ] [-EventSource ] [-InputObject ] [-OverrideServiceRecoveryActions] - [-Service ] -``` - -## DESCRIPTION -The **Add-ClusterVMMonitoredItem** cmdlet configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. -If the service fails or the event occurs, then the system responds by taking an action based on the failover configuration for the virtual machine resource. -For example, the configuration might specify that the virtual machine be restarted. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterVMMonitoredItem -VirtualMachine test-VM11 -EventLog "Microsoft-Windows-FailoverClustering-Manager/Admin" -EventSource "Microsoft-Windows-FailoverClustering-Manager" -EventId 4708 -Name ----- -Microsoft-Windows-FailoverClustering-Manager+Admin,Microsoft-Windows-FailoverClustering-Manager,4708 -``` - -This example adds monitoring for the ETW event ID 4708. - -### Example 2 -``` -PS C:\>Add-ClusterVMMonitoredItem -VirtualMachine test-VM11 -Service spooler -Name ----- -Spooler -``` - -This example configures monitoring for the print spooler service. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventId -Specifies the event identifier (ID) of the event to be monitored. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventLog -Specifies the event log of the event to be monitored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventSource -Specifies the event source of the event to be monitored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to run the cmdlet, the clustered virtual machine on which to configure monitoring, and the cluster virtual machine monitored item object to monitor. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -OverrideServiceRecoveryActions -Specifies that the cluster service will fix, by overriding, the service recovery actions in the event that it is not properly configured for monitoring. -To be configured for monitoring the following conditions need to be met: - -- None of the service recovery actions are set to Restart the computer. - -AND - -- At least one of the service recovery actions are set to Take no action. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Specifies the name of a service to be monitored. -This must be the short name, not the long name, of the service. -For example, specify clussvc instead of Failover Cluster service. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachine -Specifies the name of the clustered virtual machine on which to perform monitoring. -When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the **Cluster** parameter must also be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-ClusterVMMonitoredItem](./Get-ClusterVMMonitoredItem.md) - -[Remove-ClusterVMMonitoredItem](./Remove-ClusterVMMonitoredItem.md) - -[Reset-ClusterVMMonitoredState](./Reset-ClusterVMMonitoredState.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusterVirtualMachineRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusterVirtualMachineRole.md deleted file mode 100644 index 9d77713aff..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusterVirtualMachineRole.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clustervirtualmachinerole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusterVirtualMachineRole - -## SYNOPSIS -Creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster. - -## SYNTAX - -``` -Add-ClusterVirtualMachineRole [[-VMName] ] [-Cluster ] [-InputObject ] - [-Name ] [-VirtualMachine ] [-VMId ] -``` - -## DESCRIPTION -The **Add-ClusterVirtualMachineRole** cmdlet creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster. - -By creating clustered virtual machines, you can consolidate multiple servers on one physical server without causing that server to become a single point of failure. -Instead, if that server, or cluster node, fails or requires scheduled maintenance, then another node begins to run the virtual machines instead through a process known as failover. -The virtual hard disk (VHD) file for the clustered virtual machine must be on the clustered disk used by that virtual machine. - - -**Note:** This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -**Note:** This cmdlet generates a .TMP file under the user temp folder, and you can't have more than 65535 .TMP files generated by this cmdlet, otherwise you will receive an exception "The File Exist". For more information, please go to: https://techcommunity.microsoft.com/t5/ITOps-Talk-Blog/TQA-Add-ClusterVirtualMachineRole-fails-with-the-error-quot-The/ba-p/713344 - - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-ClusterVirtualMachineRole -VirtualMachine VM1 -Name OwnerNode State ----- --------- ----- -Virtual Machine node1 Offline -``` - -This example configures VM1 as a clustered virtual machine, and assigns a default name. - -### Example 2 -``` -PS C:\>Add-ClusterVirtualMachineRole -VirtualMachine VM1 -Name "MainServer1" -Name OwnerNode State ----- --------- ----- -MainServer1 node1 Offline -``` - -This example configures VM1 as a clustered virtual machine, and assigns the name MainServer1. - -### Example 3 -``` -PS C:\>Get-VM -Name *print* | Add-ClusterVirtualMachineRole -Report file location: C:\Windows\cluster\Reports\Highly Available Virtual Machine 0ce88dce-eb6b-4c17-a512-d13bdbe5fcba on2011.11.28 At 15.37.33.mht - -Name OwnerNode State ----- --------- ----- -print-VM1 node1 Online -``` - -This example queries for virtual machines matching the wildcard characters *print* and configures them as clustered virtual machines. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available virtual machine. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available virtual machine to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMId -Specifies the virtual machine identifier (ID). - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to make highly available. -Use either the **VirtualMachine** parameter or the **VMName** parameter to specify the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VirtualMachine -Specifies the name of the virtual machine to make highly available. -Use either the **VirtualMachine** parameter or the **VMName** parameter to specify the name of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: vm - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Move-ClusterVirtualMachineRole](./Move-ClusterVirtualMachineRole.md) - -[Update-ClusterVirtualMachineConfiguration](./Update-ClusterVirtualMachineConfiguration.md) - -[Get-VM](../hyper-v/Get-VM.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Add-ClusteriSCSITargetServerRole.md b/docset/winserver2012-ps/failoverclusters/Add-ClusteriSCSITargetServerRole.md deleted file mode 100644 index 79489a5780..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Add-ClusteriSCSITargetServerRole.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/add-clusteriscsitargetserverrole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-ClusteriSCSITargetServerRole - -## SYNOPSIS -Creates a highly available iSCSI Target server. - -## SYNTAX - -``` -Add-ClusteriSCSITargetServerRole [[-Name] ] [-Cluster ] [-IgnoreNetwork ] - [-InputObject ] [-StaticAddress ] [-Wait ] -Storage -``` - -## DESCRIPTION -The **Add-ClusteriSCSITargetServerRole** cmdlet creates a highly available iSCSI Target server. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-ClusteriSCSITargetServerRole -Storage "Cluster Disk 5" -Name OwnerNode State ----- --------- ----- -CLiSCSITarget node1 Online -``` - -This example creates a clustered iSCSI Target server using Cluster Disk 5, and assigns a default name. - -### EXAMPLE 2 -``` -PS C:\>Add-ClusteriSCSITargetServerRole -Storage "Cluster Disk 5" -Name MyiSCSITarget -Name OwnerNode State ----- --------- ----- -MyiSCSITarget node1 Online -``` - -This example creates a clustered iSCSI Target server using Cluster Disk 5, and assigns the name MyiSCSITarget. - -### EXAMPLE 3 -``` -PS C:\>Add-ClusteriSCSITargetServerRole -Storage "Cluster Disk 5" -Wait 0 -Name OwnerNode State ----- --------- ----- -CLiSCSITarget node1 Pending -``` - -This example creates a clustered iSCSI Target server using Cluster Disk 5, and assigns a default name. -The cmdlet completes without waiting for all resources to come online. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to create the highly available iSCSI Target server. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the highly available iSCSI Target server to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Storage -Specifies the cluster disk resource to be added to the created highly available iSCSI Target server. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Get-ClusterResource](./Get-ClusterResource.md) - -[New-IscsiServerTarget](../iscsitarget/New-IscsiServerTarget.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Block-ClusterAccess.md b/docset/winserver2012-ps/failoverclusters/Block-ClusterAccess.md deleted file mode 100644 index 2d55d0a98d..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Block-ClusterAccess.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/block-clusteraccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Block-ClusterAccess - -## SYNOPSIS -Prevents the specified user or users from accessing a failover cluster. - -## SYNTAX - -``` -Block-ClusterAccess [-User] [-Cluster ] [-InputObject ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Block-ClusterAccess** cmdlet prevents the specified user or users from accessing a failover cluster. -If you do not want to completely block access and instead want to limit a user to using Windows PowerShell® to view cluster settings (not change settings), then use the Grant-ClusterAccess cmdlet with the **Readonly** parameter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Block-ClusterAccess -User contoso\johnj99 -``` - -This example prevents the user named johnj99 on the contoso domain from gaining access to the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to block access for the given user. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -User -Specifies the user for whom to block cluster access. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-ClusterAccess](./Get-ClusterAccess.md) - -[Grant-ClusterAccess](./Grant-ClusterAccess.md) - -[Remove-ClusterAccess](./Remove-ClusterAccess.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Clear-ClusterDiskReservation.md b/docset/winserver2012-ps/failoverclusters/Clear-ClusterDiskReservation.md deleted file mode 100644 index 7a72a319b6..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Clear-ClusterDiskReservation.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/clear-clusterdiskreservation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-ClusterDiskReservation - -## SYNOPSIS -Clears the persistent reservation on a disk in a failover cluster. - -## SYNTAX - -``` -Clear-ClusterDiskReservation [[-Node] ] [-Force] -Disk -``` - -## DESCRIPTION -The **Clear-ClusterDiskReservation** cmdlet clears the persistent reservation on a disk in a failover cluster. -This cmdlet prompts for confirmation unless you specify the **Force** parameter. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Clear-ClusterDiskReservation -Disk 5 -``` - -This example clears the persistent reservation on Disk 5 on the local node after asking for user confirmation. - -### Example 2 -``` -C:\PS>Clear-ClusterDiskReservation -Disk 6 -Node node2 -Force -``` - -This example clears the persistent reservation on Disk 6 on the node named node2 without asking for user confirmation. - -## PARAMETERS - -### -Disk -Specifies the disk number on which to clear the persistent reservations. -This is the disk number as it appears in Disk Management on the node. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -Specifies the name of the cluster node on which to clear the disk reservation. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Clear-ClusterNode](./Clear-ClusterNode.md) - -[Remove-Cluster](./Remove-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Clear-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Clear-ClusterNode.md deleted file mode 100644 index ad855fb03f..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Clear-ClusterNode.md +++ /dev/null @@ -1,169 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/clear-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-ClusterNode - -## SYNOPSIS -Clears the cluster configuration from a node that was evicted from a failover cluster. - -## SYNTAX - -``` -Clear-ClusterNode [[-Name] ] [-Cluster ] [-Force] [-InputObject ] - [-Wait ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Clear-ClusterNode** cmdlet clears the cluster configuration from a node that was evicted from a failover cluster. -This cmdlet helps ensure that the failover cluster configuration has been completely removed from a node that was evicted. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Clear-ClusterNode -Name node4 -Force -``` - -This example removes cluster configuration information from the node named node4 without asking for user confirmation. - -### EXAMPLE 2 -``` -PS C:\>Clear-ClusterNode -``` - -This example removes cluster configuration information from the local node after prompting for confirmation. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster node from which to clear cluster the configuration information. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node for which to clear the cluster configuration. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/FailoverClusters.md b/docset/winserver2012-ps/failoverclusters/FailoverClusters.md deleted file mode 100644 index 486150f919..0000000000 --- a/docset/winserver2012-ps/failoverclusters/FailoverClusters.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: cc3e946b-9141-48c2-95d8-d9e56594416a -Module Name: FailoverClusters ---- - -# FailoverClusters Module -## Description -This reference provides cmdlet descriptions and syntax for all failover cluster-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## FailoverClusters Cmdlets -### [Add-ClusterCheckpoint](./Add-ClusterCheckpoint.md) -Adds a cryptographic key checkpoint or registry checkpoint for a resource. - -### [Add-ClusterDisk](./Add-ClusterDisk.md) -Makes a new disk available for use in a failover cluster. - -### [Add-ClusterFileServerRole](./Add-ClusterFileServerRole.md) -Creates a clustered file server (resource group that includes one or more disks, on which shared folders can be created for users). - -### [Add-ClusterGenericApplicationRole](./Add-ClusterGenericApplicationRole.md) -Configures high availability for an application that was not originally designed to run in a failover cluster. - -### [Add-ClusterGenericScriptRole](./Add-ClusterGenericScriptRole.md) -Configures an application controlled by a script that runs in Windows Script Host, within a failover cluster. - -### [Add-ClusterGenericServiceRole](./Add-ClusterGenericServiceRole.md) -Configures high availability for a service that was not originally designed to run in a failover cluster. - -### [Add-ClusterGroup](./Add-ClusterGroup.md) -Adds an empty resource group to the failover cluster configuration, in preparation for adding clustered resources to the group. - -### [Add-ClusteriSCSITargetServerRole](./Add-ClusteriSCSITargetServerRole.md) -Creates a highly available iSCSI Target server. - -### [Add-ClusterNode](./Add-ClusterNode.md) -Adds a node (server) to a failover cluster. - -### [Add-ClusterPrintServerRole](./Add-ClusterPrintServerRole.md) -Creates a clustered print server, a resource group that includes a printer and a disk for storing print job information and printer drivers. - -### [Add-ClusterResource](./Add-ClusterResource.md) -Adds a resource to a clustered role, or resource group, in a failover cluster. - -### [Add-ClusterResourceDependency](./Add-ClusterResourceDependency.md) -Adds a resource to the list of resources on which a particular resource depends, using AND as the connector, within a failover cluster. - -### [Add-ClusterResourceType](./Add-ClusterResourceType.md) -Adds a resource type to a failover cluster, and specifies information such as the dynamic-link library (DLL) to use with that resource type. - -### [Add-ClusterScaleOutFileServerRole](./Add-ClusterScaleOutFileServerRole.md) -Creates a clustered file server for scale-out application data. - -### [Add-ClusterServerRole](./Add-ClusterServerRole.md) -Creates a highly available basic server that contains only a client access point and storage. - -### [Add-ClusterSharedVolume](./Add-ClusterSharedVolume.md) -Makes a volume available in Cluster Shared Volumes in a failover cluster. - -### [Add-ClusterVirtualMachineRole](./Add-ClusterVirtualMachineRole.md) -Creates a clustered virtual machine, that is, a virtual machine that can be failed over if necessary to a different server in the failover cluster. - -### [Add-ClusterVMMonitoredItem](./Add-ClusterVMMonitoredItem.md) -Configures monitoring for a service or an Event Tracing for Windows (ETW) event so that it is monitored on a virtual machine. - -### [Block-ClusterAccess](./Block-ClusterAccess.md) -Prevents the specified user or users from accessing a failover cluster. - -### [Clear-ClusterDiskReservation](./Clear-ClusterDiskReservation.md) -Clears the persistent reservation on a disk in a failover cluster. - -### [Clear-ClusterNode](./Clear-ClusterNode.md) -Clears the cluster configuration from a node that was evicted from a failover cluster. - -### [Get-Cluster](./Get-Cluster.md) -Gets information about one or more failover clusters in a given domain. - -### [Get-ClusterAccess](./Get-ClusterAccess.md) -Gets information about permissions that control access to a failover cluster. - -### [Get-ClusterAvailableDisk](./Get-ClusterAvailableDisk.md) -Gets information about the disks that can support Failover Clustering and are visible to all nodes, but are not yet part of the set of clustered disks. - -### [Get-ClusterCheckpoint](./Get-ClusterCheckpoint.md) -Retrieves a cryptographic key checkpoint or registry checkpoint for a resource. - -### [Get-ClusterGroup](./Get-ClusterGroup.md) -Gets information about one or more clustered roles (resource groups) in a failover cluster. - -### [Get-ClusterLog](./Get-ClusterLog.md) -Creates a log file for all nodes, or a specific a node, in a failover cluster. - -### [Get-ClusterNetwork](./Get-ClusterNetwork.md) -Gets information about one or more networks in a failover cluster. - -### [Get-ClusterNetworkInterface](./Get-ClusterNetworkInterface.md) -Gets information about one or more network adapters in a failover cluster. - -### [Get-ClusterNode](./Get-ClusterNode.md) -Gets information about one or more nodes, or servers, in a failover cluster. - -### [Get-ClusterOwnerNode](./Get-ClusterOwnerNode.md) -Gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role. - -### [Get-ClusterParameter](./Get-ClusterParameter.md) -Gets detailed information about an object in a failover cluster, such as a cluster resource. - -### [Get-ClusterQuorum](./Get-ClusterQuorum.md) -Gets information about the quorum configuration of a failover cluster. - -### [Get-ClusterResource](./Get-ClusterResource.md) -Gets information about one or more resources in a failover cluster. - -### [Get-ClusterResourceDependency](./Get-ClusterResourceDependency.md) -Gets information about the dependencies that have been configured between clustered resources in a failover cluster. - -### [Get-ClusterResourceDependencyReport](./Get-ClusterResourceDependencyReport.md) -Generates a report that lists the dependencies between resources in a failover cluster. - -### [Get-ClusterResourceType](./Get-ClusterResourceType.md) -Gets information about one or more resource types in a failover cluster. - -### [Get-ClusterSharedVolume](./Get-ClusterSharedVolume.md) -Gets information about Cluster Shared Volumes in a failover cluster. - -### [Get-ClusterVMMonitoredItem](./Get-ClusterVMMonitoredItem.md) -Gets the list of services and events currently being monitored in the virtual machine. - -### [Grant-ClusterAccess](./Grant-ClusterAccess.md) -Grants access to a failover cluster, either full access or read-only access. - -### [Move-ClusterGroup](./Move-ClusterGroup.md) -Moves a clustered role (a resource group) from one node to another in a failover cluster. - -### [Move-ClusterResource](./Move-ClusterResource.md) -Moves a clustered resource from one clustered role to another within a failover cluster. - -### [Move-ClusterSharedVolume](./Move-ClusterSharedVolume.md) -Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster. - -### [Move-ClusterVirtualMachineRole](./Move-ClusterVirtualMachineRole.md) -Moves the ownership of a clustered virtual machine to a different node. - -### [New-Cluster](./New-Cluster.md) -Creates a new failover cluster. - -### [Remove-Cluster](./Remove-Cluster.md) -Destroys an existing failover cluster. - -### [Remove-ClusterAccess](./Remove-ClusterAccess.md) -Removes a user from the access list on the cluster. - -### [Remove-ClusterCheckpoint](./Remove-ClusterCheckpoint.md) -Removes a cryptographic key checkpoint or registry checkpoint for a resource. - -### [Remove-ClusterGroup](./Remove-ClusterGroup.md) -Removes a clustered role, also called a resource group, from a failover cluster. - -### [Remove-ClusterNode](./Remove-ClusterNode.md) -Removes a node from a failover cluster. - -### [Remove-ClusterResource](./Remove-ClusterResource.md) -Removes a clustered resource from the failover cluster. - -### [Remove-ClusterResourceDependency](./Remove-ClusterResourceDependency.md) -Removes a dependency between two resources in a clustered role within a failover cluster. - -### [Remove-ClusterResourceType](./Remove-ClusterResourceType.md) -Removes a resource type from a failover cluster. - -### [Remove-ClusterSharedVolume](./Remove-ClusterSharedVolume.md) -Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. - -### [Remove-ClusterVMMonitoredItem](./Remove-ClusterVMMonitoredItem.md) -Removes monitoring of a service or event that is currently being monitored on a virtual machine. - -### [Repair-ClusterSharedVolume](./Repair-ClusterSharedVolume.md) -Runs repair tools on a Cluster Shared Volume locally on a cluster node. - -### [Reset-ClusterVMMonitoredState](./Reset-ClusterVMMonitoredState.md) -Resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. - -### [Resume-ClusterNode](./Resume-ClusterNode.md) -Resumes a node from the paused state or brings back drained workloads to the node or both. - -### [Resume-ClusterResource](./Resume-ClusterResource.md) -Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. - -### [Set-ClusterLog](./Set-ClusterLog.md) -Sets the size and level of detail for the cluster log. - -### [Set-ClusterOwnerNode](./Set-ClusterOwnerNode.md) -Specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group. - -### [Set-ClusterParameter](./Set-ClusterParameter.md) -Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. - -### [Set-ClusterQuorum](./Set-ClusterQuorum.md) -Configures quorum options for a failover cluster. - -### [Set-ClusterResourceDependency](./Set-ClusterResourceDependency.md) -Specifies the resources that a particular resource depends on within a failover cluster. - -### [Start-Cluster](./Start-Cluster.md) -Starts the Cluster service on all nodes of the cluster on which it is not yet started. - -### [Start-ClusterGroup](./Start-ClusterGroup.md) -Starts one or more clustered roles, also known as resource groups, on a failover cluster. - -### [Start-ClusterNode](./Start-ClusterNode.md) -Starts the Cluster service on a node in a failover cluster. - -### [Start-ClusterResource](./Start-ClusterResource.md) -Brings a resource online in a failover cluster. - -### [Stop-Cluster](./Stop-Cluster.md) -Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. - -### [Stop-ClusterGroup](./Stop-ClusterGroup.md) -Stops one or more clustered roles, also known as resource groups, on a failover cluster. - -### [Stop-ClusterNode](./Stop-ClusterNode.md) -Stops the Cluster service on a node in a failover cluster. - -### [Stop-ClusterResource](./Stop-ClusterResource.md) -Takes a resource offline in a failover cluster. - -### [Suspend-ClusterNode](./Suspend-ClusterNode.md) -Suspends activity on a failover cluster node, that is, pauses the node. - -### [Suspend-ClusterResource](./Suspend-ClusterResource.md) -Turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that you can run a disk maintenance tool without triggering failover. - -### [Test-Cluster](./Test-Cluster.md) -Runs validation tests for failover cluster hardware and settings. - -### [Test-ClusterResourceFailure](./Test-ClusterResourceFailure.md) -Simulates a failure of a cluster resource. - -### [Update-ClusterIPResource](./Update-ClusterIPResource.md) -Renews or releases the DHCP lease for an IP address resource in a failover cluster. - -### [Update-ClusterNetworkNameResource](./Update-ClusterNetworkNameResource.md) -Registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability. - -### [Update-ClusterVirtualMachineConfiguration](./Update-ClusterVirtualMachineConfiguration.md) -Refreshes the configuration of a clustered virtual machine within a failover cluster. - diff --git a/docset/winserver2012-ps/failoverclusters/Get-Cluster.md b/docset/winserver2012-ps/failoverclusters/Get-Cluster.md deleted file mode 100644 index f1e406fc06..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-Cluster.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-cluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-Cluster - -## SYNOPSIS -Gets information about one or more failover clusters in a given domain. - -## SYNTAX - -``` -Get-Cluster [[-Name] ] [-Domain ] -``` - -## DESCRIPTION -The **Get-Cluster** cmdlet gets information about one or more failover clusters in a given domain. - -This cmdlet can obtain a variety of configuration and state information about a failover cluster, including the following items: - - -- State information about whether a backup is in progress. - - -- State information about whether the cluster is in a forced quorum state. - - -- Cross-network settings that are especially relevant for multi-site clusters. - -To set a common property for the cluster, use this cmdlet to get the cluster object and then set the appropriate property on that cluster object directly. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-Cluster | Format-List -Property * -Domain : contoso.com -Name : cluster1 -AddEvictDelay : 60 -BackupInProgress : 0 -ClusSvcHangTimeout : 60 -ClusSvcRegroupOpeningTimeout : 5 -ClusSvcRegroupPruningTimeout : 5 -ClusSvcRegroupStageTimeout : 5 -ClusSvcRegroupTickInMilliseconds : 300 -ClusterGroupWaitDelay : 120 -MinimumNeverPreemptPriority : 3000 -MinimumPreemptorPriority : 1 -ClusterEnforcedAntiAffinity : 0 -ClusterLogLevel : 3 -ClusterLogSize : 300 -CrossSubnetDelay : 1000 -CrossSubnetThreshold : 5 -DefaultNetworkRole : 2 -Description : -FixQuorum : 0 -HangRecoveryAction : 3 -IgnorePersistentStateOnStartup : 0 -LogResourceControls : 0 -PlumbAllCrossSubnetRoutes : 0 -PreventQuorum : 0 -QuorumArbitrationTimeMax : 20 -RequestReplyTimeout : 60 -RootMemoryReserved : 4294967295 -RouteHistoryLength : 0 -SameSubnetDelay : 1000 -SameSubnetThreshold : 5 -SecurityLevel : 1 -SharedVolumeCompatibleFilters : {} -SharedVolumeIncompatibleFilters : {} -SharedVolumesRoot : C:\ClusterStorage -SharedVolumeSecurityDescriptor : {1, 0, 4, 128...} -ShutdownTimeoutInMinutes : 20 -UseNetftForSharedVolumes : 1 -UseClientAccessNetworksForSharedVolumes : 0 -SharedVolumeBlockCacheSizeInMB : 0 -WitnessDatabaseWriteTimeout : 300 -WitnessRestartInterval : 15 -EnableSharedVolumes : Enabled -DynamicQuorum : 1 -Id : af5881ef-0ff7-4b5c-bfed-098decbbf762 -``` - -This example displays state and property information for the local cluster in the form of a list. - -### EXAMPLE 2 -``` -PS C:\>Get-Cluster -Name cluster1 -Name ----- -cluster1 -``` - -This example gets information about a cluster named cluster1. - -### EXAMPLE 3 -``` -PS C:\>Get-Cluster -Domain contoso.com -Name ----- -cluster1 -cluster2 -cluster3 -``` - -This example gets information about each of the clusters in the contoso.com domain. - -### EXAMPLE 4 -``` -PS C:\> Get-Cluster | ForEach-Object -Process {$_.CrossSubnetDelay = 1500} -``` - -This example sets the common property called CrossSubnetDelay for the local cluster to 1500. - -### EXAMPLE 5 -``` -PS C:\>(Get-Cluster).DynamicQuorum = 1 -``` - -This example enables the Dynamic Quorum feature for the cluster. - -## PARAMETERS - -### -Domain -Specifies the name of the domain in which to enumerate clusters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## NOTES - -## RELATED LINKS - -[ForEach-Object](https://go.microsoft.com/fwlink/p/?LinkId=113300) - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkId=113302) - -[New-Cluster](./New-Cluster.md) - -[Remove-Cluster](./Remove-Cluster.md) - -[Start-Cluster](./Start-Cluster.md) - -[Stop-Cluster](./Stop-Cluster.md) - -[Test-Cluster](./Test-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterAccess.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterAccess.md deleted file mode 100644 index a59dbbff50..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterAccess.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusteraccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterAccess - -## SYNOPSIS -Gets information about permissions that control access to a failover cluster. - -## SYNTAX - -``` -Get-ClusterAccess [[-User] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterAccess** cmdlet gets information about permissions that control access to a failover cluster. - -A cluster can allow full access or read-only access. -Read-only access limits the user to Windows PowerShell® cmdlets that provide information about the cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterAccess -IdentityReference AccessControlType ClusterRights ------------------ ----------------- ------------- -CONTOSO\user1 Deny Full -NT AUTHORITY\SYSTEM Allow Full -NT AUTHORITY\NETWORK SE... Allow Full -BUILTIN\Administrators Allow Full -CONTOSO\user2 Allow Read -NT SERVICE\MSDTC Allow Full -``` - -This example lists the level of permissions that have been assigned to users of this cluster, including users who are blocked from access. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate cluster access details. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -User -Specifies the user for which to get cluster access. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterAccessRule - -## NOTES - -## RELATED LINKS - -[Block-ClusterAccess](./Block-ClusterAccess.md) - -[Grant-ClusterAccess](./Grant-ClusterAccess.md) - -[Remove-ClusterAccess](./Remove-ClusterAccess.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterAvailableDisk.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterAvailableDisk.md deleted file mode 100644 index ef5d37ea1a..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterAvailableDisk.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusteravailabledisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterAvailableDisk - -## SYNOPSIS -Gets information about the disks that can support Failover Clustering and are visible to all nodes, but are not yet part of the set of clustered disks. - -## SYNTAX - -``` -Get-ClusterAvailableDisk [[-Cluster] ] [-Disk ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterAvailableDisk** cmdlet gets information about the disks that can support Failover Clustering and are visible to all nodes, but are not yet part of the set of clustered disks. - -If a disk is unexpectedly missing from the list of disks that are available for use in the cluster, then make sure that the configuration of the storage allows the operating system on all clustered servers to recognize and mount the disk as needed. -The disk must be a basic disk, not a dynamic disk, and should not be exposed to any other servers. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterAvailableDisk -Cluster : cluster1 -Id : 2654136007 -Name : Cluster Disk 4 -Number : 7 -ScsiAddress : 50331651 -Size : 2097152000 -Partitions : {\\?\GLOBALROOT\Device\Harddisk7\Partition1\} - -Cluster : cluster1 -Id : 2654136015 -Name : Cluster Disk 5 -Number : 9 -ScsiAddress : 67108867 -Size : 2097152000 -Partitions : {\\?\GLOBALROOT\Device\Harddisk9\Partition1\} -``` - -This example lists the disks that are ready to be added to the cluster. - -### Example 2 -``` -PS C:\>Get-ClusterAvailableDisk | Add-ClusterDisk -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 4 OnlinePending Available Storage Physical Disk -Cluster Disk 5 OnlinePending Available Storage Physical Disk -``` - -This example adds all disks that are ready to be added to the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Specifies the disks on which to enumerate. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate available shared disks. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterDiskInfo - -## NOTES - -## RELATED LINKS - -[Add-ClusterDisk](./Add-ClusterDisk.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterCheckpoint.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterCheckpoint.md deleted file mode 100644 index b84a28b9a1..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterCheckpoint.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustercheckpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterCheckpoint - -## SYNOPSIS -Retrieves a cryptographic key checkpoint or registry checkpoint for a resource. - -## SYNTAX - -``` -Get-ClusterCheckpoint [[-ResourceName] ] [-CheckpointName ] [-Cluster ] - [-CryptoCheckpoint] [-InputObject ] [-RegistryCheckpoint] -``` - -## DESCRIPTION -The **Get-ClusterCheckpoint** cmdlet retrieves a cryptographic key checkpoint or registry checkpoint for a resource. - -Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. -Applications might store information locally in two ways. -One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterCheckpoint -Resource Name Type Key --------- ---- ---- --- -Cluster Name Microsoft Enhanced Cryptog... b5a571f2-c28b-48fa-b82f-a8... -Cluster Name software\clusname -``` - -This example retrieves all cluster checkpoints. - -### Example 2 -``` -PS C:\>Get-ClusterResource -ResourceName "Cluster Name" | Get-ClusterCheckpoint -CryptoCheckpoint -Resource Name Type Key --------- ---- ---- --- -Cluster Name Microsoft Enhanced Cryptog... b5a571f2-c28b-48fa-b82f-a8... -``` - -This example retrieves the cryptographic checkpoints for the resource named Cluster Name. - -## PARAMETERS - -### -CheckpointName -Specifies the name of checkpoints for which to search. -Use of wildcard expressions is accepted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoCheckpoint -Specifies that cryptographic checkpoints will be retrieved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to run the cmdlet or the cluster resource for which to retrieve the checkpoint. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RegistryCheckpoint -Specifies that registry checkpoints will be retrieved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the resource for which to retrieve the checkpoint. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-ClusterCheckpoint](./Add-ClusterCheckpoint.md) - -[Remove-ClusterCheckpoint](./Remove-ClusterCheckpoint.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterGroup.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterGroup.md deleted file mode 100644 index e155698d18..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterGroup.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustergroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterGroup - -## SYNOPSIS -Gets information about one or more clustered roles (resource groups) in a failover cluster. - -## SYNTAX - -``` -Get-ClusterGroup [[-Name] ] [-Cluster ] [-InputObject ] [-VMId ] -``` - -## DESCRIPTION -The **Get-ClusterGroup** cmdlet gets information about one or more clustered roles (resource groups) in a failover cluster. - -A resource group is the unit of failover. -During failover, all resources in the resource group move together. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterGroup -Name OwnerNode State ----- --------- ----- -Available Storage node1 Online -Cluster Group node2 Online -cluster1FS node1 Online -cluster1FS-Other node1 Online -``` - -This example lists the state and owner node of each clustered role, or resource group, in the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterGroup -Name "Cluster Group" | Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online Cluster Group Physical Disk -Cluster IP Address Online Cluster Group IP Address -Cluster IP Addre... Online Cluster Group IPv6 Address -Cluster Name Online Cluster Group Network Name -``` - -This example lists the resources in Cluster Group on the local cluster. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterNode -Name node1 | Get-ClusterGroup -Name OwnerNode State ----- --------- ----- -Cluster Group node1 Online -``` - -This example lists the clustered services and applications, or resource groups, that are currently owned by node1 in the local cluster. - -### EXAMPLE 4 -``` -PS C:\>Get-ClusterGroup -Name FileServer1 | Format-List -Process * -Cluster : Cluster1 -IsCoreGroup : False -OwnerNode : node1 -State : Online -Name : FileServer1 -Description : -PersistentState : 0 -FailoverThreshold : 4294967295 -FailoverPeriod : 6 -AutoFailbackType : 0 -FailbackWindowStart : 4294967295 -FailbackWindowEnd : 4294967295 -AntiAffinityClassNames : {} -Id : 189ec8ad-1831-4f57-9bb0-3ffb9cbb9227 -``` - -This example displays the properties of a clustered file server, or resource group, called FileServer1, in the form of a list. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster or cluster node on which to enumerate the clustered roles. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the clustered role to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMId -Specifies the virtual machine identifier (ID). - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/?LinkID=113302) - -[Add-ClusterGroup](./Add-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterLog.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterLog.md deleted file mode 100644 index 24422de433..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterLog.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterlog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterLog - -## SYNOPSIS -Creates a log file for all nodes, or a specific a node, in a failover cluster. - -## SYNTAX - -``` -Get-ClusterLog [[-Node] ] [-Cluster ] [-Destination ] - [-InputObject ] [-TimeSpan ] [-UseLocalTime] -``` - -## DESCRIPTION -The **Get-ClusterLog** cmdlet creates a log file for all nodes, or a specific a node, in a failover cluster. - -When creating a log file for the cluster, you can specify the timespan that you want logged information for in addition to providing a destination for the created logs. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterLog -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 9/4/2008 3:53 PM 2211301 Cluster.log --a--- 9/4/2008 3:53 PM 1261025 Cluster.log -``` - -This example creates a log file for the local cluster in the cluster reports folder on each node of the cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterLog -Destination . -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 9/4/2008 3:55 PM 2211301 node1_cluster.log --a--- 9/4/2008 3:55 PM 1261025 node2_cluster.log -``` - -This example creates a log file for each node of the local cluster, and copies all logs to the local folder. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterLog -TimeSpan 5 -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 9/4/2008 3:58 PM 128299 Cluster.log --a--- 9/4/2008 4:01 PM 104181 Cluster.log -``` - -This example creates a log file for the local cluster in the cluster reports folder on each node of the cluster. -The log covers the last 5 minutes. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Destination -Specifies the location to which to copy one or more cluster logs. -To copy to the current folder, use `.` for this parameter input. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster from which to generate cluster logs. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Node -Specifies the name of the cluster node for which to generate the cluster log. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeSpan -Specifies the time span for which to generate the cluster log. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: span - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLocalTime -Specifies that the time stamp for each cluster log entry uses local time. -By default, the timestamp uses Greenwich Mean Time (GMT). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### System.IO.FileInfo - -## NOTES - -## RELATED LINKS - -[Set-ClusterLog](./Set-ClusterLog.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterNetwork.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterNetwork.md deleted file mode 100644 index f9a54fc2d4..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterNetwork.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternetwork?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterNetwork - -## SYNOPSIS -Gets information about one or more networks in a failover cluster. - -## SYNTAX - -``` -Get-ClusterNetwork [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterNetwork** cmdlet gets information about one or more networks in a failover cluster. -A failover cluster requires network connectivity among nodes and between clients and nodes. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterNetwork -Name State ----- ----- -Cluster Network 1 Up -Cluster Network 2 Up -Cluster Network 3 Up -``` - -This example gets information about the networks used by the local cluster. - -### Example 2 -``` -PS C:\>(Get-ClusterNetwork -Name "Cluster Network 1").Name = "Cluster Network 3" -``` - -This example renames Cluster Network 1 to Cluster Network 3. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate the cluster networks. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster network to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNetwork - -## NOTES - -## RELATED LINKS - -[Get-ClusterNetworkInterface](./Get-ClusterNetworkInterface.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterNetworkInterface.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterNetworkInterface.md deleted file mode 100644 index 6c08b7924c..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterNetworkInterface.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternetworkinterface?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterNetworkInterface - -## SYNOPSIS -Gets information about one or more network adapters in a failover cluster. - -## SYNTAX - -``` -Get-ClusterNetworkInterface [[-Name] ] [-Cluster ] [-InputObject ] - [-Network ] [-Node ] -``` - -## DESCRIPTION -The **Get-ClusterNetworkInterface** cmdlet gets information about one or more network adapters in a failover cluster. -A failover cluster requires network connectivity among nodes and between clients and nodes. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterNetworkInterface -Name Node Network State ----- ---- ------- ----- -node1 - Local A ... node1 Cluster Network 1 Up -node2 - Local A ... node2 Cluster Network 1 Up -node1 - Local A ... node1 Cluster Network 2 Up -node2 - Local A ... node2 Cluster Network 2 Up -``` - -This example displays information about the physical network adapters used by the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterNode -Name node1 | Get-ClusterNetworkInterface -Name Node Network State ----- ---- ------- ----- -node1 - Local A ... node1 Cluster Network 1 Up -node1 - Local A ... node1 Cluster Network 2 Up -``` - -This example displays information about the physical network adapters used by node1 in the local cluster. -This cmdlet is equivalent to `Get-ClusterNetworkInterface -Node node1node1`. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate the cluster network interfaces. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster network interface to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Network -Specifies the name of the cluster network for which to enumerate the network interfaces. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -Specifies the name of the cluster node on which to enumerate the network interfaces. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterNetwork - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface - -## NOTES - -## RELATED LINKS - -[Get-ClusterNetwork](./Get-ClusterNetwork.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterNode.md deleted file mode 100644 index bf3231b820..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterNode.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterNode - -## SYNOPSIS -Gets information about one or more nodes, or servers, in a failover cluster. - -## SYNTAX - -``` -Get-ClusterNode [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterNode** cmdlet gets information about one or more nodes, or servers, in a failover cluster. - -Use this cmdlet to obtain information about the node status. -To see the resources currently owned by a particular node, specify that node in this cmdlet and then pipe the results through the Get-ClusterResource cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterNode -Name ID State ----- -- ----- -node1 1 Up -node2 2 Up -node3 3 Up -node4 4 Up -``` - -This example displays the name, id, and state of each node, or server, in the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterNode -Cluster cluster1 -Name ID State ----- -- ----- -node1 1 Up -node2 2 Up -``` - -This example displays the name, id, and state of each node, or server, in the cluster named cluster1. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterNode -Name node1 | Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online Cluster Group Physical Disk -Cluster IP Address Online Cluster Group IP Address -Cluster IP Addre... Online Cluster Group IPv6 Address -Cluster Name Online Cluster Group Network Name -File Share Witness Offline Cluster Group File Share Witness -``` - -This example lists all cluster resources that are currently owned by node named node1 on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate cluster nodes. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - -[Resume-ClusterNode](./Resume-ClusterNode.md) - -[Start-ClusterNode](./Start-ClusterNode.md) - -[Stop-ClusterNode](./Stop-ClusterNode.md) - -[Suspend-ClusterNode](./Suspend-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterOwnerNode.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterOwnerNode.md deleted file mode 100644 index c56c7cfe0b..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterOwnerNode.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterownernode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterOwnerNode - -## SYNOPSIS -Gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role. - -## SYNTAX - -``` -Get-ClusterOwnerNode [-Cluster ] [-Group ] [-InputObject ] [-Resource ] - [-ResourceType ] -``` - -## DESCRIPTION -The **Get-ClusterOwnerNode** cmdlet gets information about which nodes can own a resource in a failover cluster or information about the order of preference among owner nodes for a clustered role. - -Settings that control the possible or preferred owners affect the way the cluster responds to the failure of a resource or a clustered role. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterResource -Cluster "Cluster Disk 1" | Get-ClusterOwnerNode -ClusterObject OwnerNodes -------------- ---------- -Cluster Disk 1 {node1, node2} -``` - -This example lists the possible owners for the cluster named Cluster Disk 1 in the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterGroup -Group cluster1FS12 | Get-ClusterOwnerNode -ClusterObject OwnerNodes -------------- ---------- -cluster1FS12 {} -``` - -This example lists the preferred owners for the clustered file server, or resource group, called cluster1FS12 on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the name of the cluster group for which owner nodes are enumerated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster group or cluster resource on which to enumerate owner nodes. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource for which owner nodes are enumerated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: res - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceType -Specifies the name of the cluster resource type for which owner nodes are enumerated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: restype - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceType - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterOwnerNodeList - -## NOTES - -## RELATED LINKS - -[Set-ClusterOwnerNode](./Set-ClusterOwnerNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterParameter.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterParameter.md deleted file mode 100644 index d306b54be3..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterParameter.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterparameter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterParameter - -## SYNOPSIS -Gets detailed information about an object in a failover cluster, such as a cluster resource. - -## SYNTAX - -``` -Get-ClusterParameter [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterParameter** cmdlet gets detailed information about an object in a failover cluster, such as a cluster resource. -This cmdlet is used to manage private properties for a cluster object. -To get and set common properties for a cluster object, use the appropriate Get-Cluster* cmdlet to get the cluster object of interest and then set the property of interest on that cluster object directly. - -The type of detailed information you can obtain with this cmdlet depends on the cmdlet you combine with it. -For example: - - -- If you use this cmdlet with the Get-ClusterResource cmdlet for a disk resource, then you can obtain the disk signature or GUID of a disk and information about whether maintenance is turned on for that disk. - - -- If you use this cmdlet with the Get-ClusterResource cmdlet for a Network Name resource, then you can obtain DNS-related information about the resource. - - -- If you use this cmdlet with the Get-ClusterResource cmdlet for an IP address resource, then you can obtain DHCP-related information about the IP Address resource. - - -- If you use this cmdlet with the Get-ClusterResource cmdlet for resources used by virtual machines, then you can obtain details about the settings for the virtual machines. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterResource -Name cluster1FS | Get-ClusterParameter -Object Name Value Type ------- ---- ----- ---- -cluster1FS Name cluster1FS String -cluster1FS DnsName cluster1FS String -cluster1FS RemapPipeNames 0 UInt32 -cluster1FS HostRecordTTL 1200 UInt32 -cluster1FS RegisterAllProvi... 0 UInt32 -cluster1FS PublishPTRRecords 0 UInt32 -cluster1FS TimerCallbackAdd... 5 UInt32 -cluster1FS ResourceData {1, 0, 0, 0...} ByteArray -cluster1FS StatusNetBIOS 0 UInt32 -cluster1FS StatusDNS 0 UInt32 -cluster1FS StatusKerberos 0 UInt32 -cluster1FS CreatingDC \\DOMAIN12-DC-05... String -cluster1FS LastDNSUpdateTime 10/15/2008 9:50:... DateTime -cluster1FS ObjectGUID 8054680893fd5943... String -``` - -This example gets the parameters, including the detailed information, for the cluster resource named cluster1FS on the local cluster. -The displayed parameters will vary according to the type of resource being viewed. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterResource -Name cluster1FS | Get-ClusterParameter -Name HostRecordTTL -Object Name Value Type ------- ---- ----- ---- -cluster1FS HostRecordTTL 1200 UInt32 -``` - -This example displays the HostRecordTTL parameter for the cluster resource named cluster1FS on the local cluster, if that parameter is applicable to cluster1FS. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster object for which to get more information. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster parameter to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterNetwork - -### Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceType - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterParameter - -## NOTES - -## RELATED LINKS - -[Set-ClusterParameter](./Set-ClusterParameter.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterQuorum.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterQuorum.md deleted file mode 100644 index 897e1c4b1b..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterQuorum.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterquorum?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterQuorum - -## SYNOPSIS -Gets information about the quorum configuration of a failover cluster. - -## SYNTAX - -``` -Get-ClusterQuorum [[-Cluster] ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterQuorum** cmdlet gets information about the quorum configuration of a failover cluster. - -The quorum configuration in a failover cluster determines the number of failures that the cluster can sustain. -If an additional failure occurs, then the cluster must stop running. -The relevant failures in this context are failures of nodes or, in some cases, of a disk witness (which contains a copy of the cluster configuration) or file share witness. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterQuorum -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 Cluster Disk 1 NodeAndDiskMajority -``` - -This example displays the quorum configuration for the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterQuorum -Cluster Cluster1 -Cluster QuorumResource QuorumType -------- -------------- ---------- -mycluster NodeMajority -``` - -This example displays the quorum configuration for the cluster named Cluster1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster for which to query the quorum type. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterQuorumSettings - -## NOTES - -## RELATED LINKS - -[Set-ClusterQuorum](./Set-ClusterQuorum.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterResource.md deleted file mode 100644 index 9d57c1d8ed..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterResource.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterResource - -## SYNOPSIS -Gets information about one or more resources in a failover cluster. - -## SYNTAX - -``` -Get-ClusterResource [[-Name] ] [-Cluster ] [-InputObject ] [-VMId ] -``` - -## DESCRIPTION -The **Get-ClusterResource** cmdlet gets information about one or more resources in a failover cluster. - -To set a common property for a clustered resource, use this cmdlet to get the object for the clustered resource, and then set the appropriate property on that object directly. -To get and set more specific information about a clustered resource, use this cmdlet with Get-ClusterParameter and Set-ClusterParameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online Cluster Group Physical Disk -Cluster Disk 2 Online Available Storage Physical Disk -Cluster Disk 3 Online Available Storage Physical Disk -Cluster Disk 4 Online Available Storage Physical Disk -Cluster Disk 5 Online Available Storage Physical Disk -Cluster Disk 6 Online Available Storage Physical Disk -Cluster Disk 7 Online Available Storage Physical Disk -Cluster IP Address Online Cluster Group IP Address -Cluster IP Addre... Online Cluster Group IPv6 Address -Cluster Name Online Cluster Group Network Name -``` - -This example lists all cluster resources on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterResource -Name "Cluster Disk 2" | Format-List -Property * -Cluster : cluster1 -IsCoreResource : False -IsNetworkClassResource : False -IsStorageClassResource : True -OwnerNode : node2 -ResourceType : Physical Disk -State : Online -OwnerGroup : Available Storage -Name : Cluster Disk 2 -MaintenanceMode : False -MonitorProcessId : 524 -Description : -SeparateMonitor : False -PersistentState : 1 -LooksAlivePollInterval : 4294967295 -IsAlivePollInterval : 4294967295 -RestartAction : 2 -RestartThreshold : 1 -RestartDelay : 500 -RestartPeriod : 900000 -RetryPeriodOnFailure : 3600000 -PendingTimeout : 180000 -DeadlockTimeout : 300000 -ResourceSpecificStatus : -Id : 6e394089-145a-4279-b75d-b14015cc36e4 -``` - -This example displays information about Cluster Disk 2, on the local cluster, in the form of a list. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterResource -Name "Cluster Disk 2" | Get-ClusterParameter -Object Name Value Type ------- ---- ----- ---- -Cluster Disk 2 DiskIdType 0 UInt32 -Cluster Disk 2 DiskSignature 2654136047 UInt32 -Cluster Disk 2 DiskIdGuid String -Cluster Disk 2 DiskRunChkDsk 0 UInt32 -Cluster Disk 2 DiskUniqueIds {16, 0, 0, 0...} ByteArray -Cluster Disk 2 DiskVolumeInfo {1, 0, 0, 0...} ByteArray -Cluster Disk 2 DiskArbInterval 3 UInt32 -Cluster Disk 2 DiskPath String -Cluster Disk 2 DiskReload 0 UInt32 -Cluster Disk 2 MaintenanceMode 0 UInt32 -Cluster Disk 2 MaxIoLatency 1000 UInt32 -Cluster Disk 2 CsvEnforseWriteT... 0 UInt32 -Cluster Disk 2 DiskPnpUpdate {0, 0, 0, 0...} ByteArray -``` - -This example displays detailed parameters for Cluster Disk 2 on the local cluster. - -### EXAMPLE 4 -``` -PS C:\>Get-ClusterGroup -Name FileServer1 | Get-ClusterResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 1 Online FileServer1 Physical Disk -Cluster IP Address Online FileServer1 IP Address -Cluster IP Addre... Online FileServer1 IPv6 Address -FileServer1 Online FileServer1 Network Name -``` - -This example lists cluster resources in cluster group named FileServer1, a clustered file server on the local cluster. - -### EXAMPLE 5 -``` -PS C:\>Get-ClusterResource -Name "Cluster Disk 2" | ForEach-Object -Process {$_.RestartDelay = 600} -``` - -This example sets the common property RestartDelay for the Cluster Disk 2 resource on the local cluster to 600. - -### Example 6 -``` -PS C:\>Get-ClusterResource -Name "cluster pool 1" | Format-List -Property OwnerNode -OwnerNode : cluster-node1 -``` - -This example shows how to display the owner of a cluster pooled disk. - -### Example 7 -``` -PS C:\>Get-ClusterResource -Name *print-VM1 | Get-VM | Stop-VM -Verbose -VERBOSE: Current VMobject = Microsoft.HyperV.PowerShell.VirtualMachine[] -VERBOSE: Stop-VM will shutdown the virtual machine "print-VM1". - -Confirm -Hyper-V cannot shut down virtual machine print-VM1 because the Shutdown integration service is unavailable. To avoid -potential data loss, you can pause or save the state of the virtual machine. The other option is to turn off the -virtual machine, but data loss might occur. - - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y -``` - -This example enumerates the cluster resources for wildcard characters *print-VM1 and stops the corresponding virtual machines. -Verbose mode is turned on for details of the operation. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster node or cluster group on which to enumerate cluster resources. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMId -Specifies the virtual machine identifier (ID). - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[ForEach-Object](https://go.microsoft.com/fwlink/?LinkID=113300) - -[Format-List](https://go.microsoft.com/fwlink/?LinkID=113302) - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceDependency.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceDependency.md deleted file mode 100644 index 7f5a2f4a57..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceDependency.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresourcedependency?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterResourceDependency - -## SYNOPSIS -Gets information about the dependencies that have been configured between clustered resources in a failover cluster. - -## SYNTAX - -``` -Get-ClusterResourceDependency [[-Resource] ] [-Cluster ] [-Guid] - [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterResourceDependency** cmdlet gets information about the dependencies that have been configured between clustered resources in a failover cluster. -Resource dependencies control the order in which resources are brought online or taken offline in the cluster. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterResourceDependency -Resource cluster1FS12 -Resource DependencyExpression --------- -------------------- -cluster1FS12 [IP Address 172.24.11.0] or [IP Add ... -``` - -This example displays the dependencies for the resource called cluster1FS12. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterGroup -Name cluster1FS12 | Get-ClusterResource | Get-ClusterResourceDependency -Resource DependencyExpression --------- -------------------- -cluster1FS12 [IP Address 172.24.11.0] or [IP Add ... - -Cluster Disk 6 -IP Address 157.56.48.0 -IP Address 2001:4898:9:2:: -IP Address 2002:9d38:31ca:8:: -``` - -This example displays the dependencies for each resource in the clustered file server ─resource group─ called cluster1FS12. -Some resources do not have dependencies. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -Causes the generated dependency expression to have the resource GUIDs instead of the resource names. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource for which to get the dependency expression. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource for which to get the dependency expression. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceDependency - -## NOTES - -## RELATED LINKS - -[Add-ClusterResourceDependency](./Add-ClusterResourceDependency.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Remove-ClusterResourceDependency](./Remove-ClusterResourceDependency.md) - -[Set-ClusterResourceDependency](./Set-ClusterResourceDependency.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceDependencyReport.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceDependencyReport.md deleted file mode 100644 index 44fb58ca6d..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceDependencyReport.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresourcedependencyreport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterResourceDependencyReport - -## SYNOPSIS -Generates a report that lists the dependencies between resources in a failover cluster. - -## SYNTAX - -``` -Get-ClusterResourceDependencyReport [-Cluster ] [-Group ] [-InputObject ] - [-Resource ] -``` - -## DESCRIPTION -The **Get-ClusterResourceDependencyReport** cmdlet generates a report that lists the dependencies between resources in a failover cluster. - -The report has a filename extension of MHT. -For convenience in storing and finding the report, you can pipe this cmdlet to the Copy-Itemhttp://go.microsoft.com/fwlink/?LinkID=113292 cmdlet and specify a destination folder into which to copy the report. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterResourceDependencyReport -Group cluster1FS12 -Mode LastWriteTime Length Name ----- ------------- ------ ---- --a--- 10/15/2008 6:29 PM 59299 fb509e66-8d02-4881-8184-6be5b1bfa4c2.mht -``` - -This example creates a dependency report file for the clustered file server, or resource group, named cluster1FS12 on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterResourceDependencyReport -Group cluster1FS12 | Copy-Item -Destination C:\users\user1 -``` - -This example creates a dependency report file for the clustered file server, or resource group, named cluster1FS12 on the local cluster. -The dependency report is copied to C:\users\user1. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterGroup | Get-ClusterResourceDependencyReport | Copy-Item -Destination \\fileserver\share -``` - -This example creates a dependency report file for each clustered role, or resource group, on the local cluster, and copies all reports to \\\\fileserver\share. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the name of the cluster group for which to generate the dependency report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster group or cluster resource for which to create the dependency report. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource for which to generate the dependency report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### System.IO.FileInfo - -## NOTES - -## RELATED LINKS - -[Copy-Item](https://go.microsoft.com/fwlink/?LinkID=113292) - -[Add-ClusterResourceDependency](./Add-ClusterResourceDependency.md) - -[Remove-ClusterResourceDependency](./Remove-ClusterResourceDependency.md) - -[Set-ClusterResourceDependency](./Set-ClusterResourceDependency.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceType.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceType.md deleted file mode 100644 index cc2e6bd928..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterResourceType.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clusterresourcetype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterResourceType - -## SYNOPSIS -Gets information about one or more resource types in a failover cluster. - -## SYNTAX - -``` -Get-ClusterResourceType [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterResourceType** cmdlet gets information about one or more resource types in a failover cluster. -Obtain information such as the name of the dynamic-link library (DLL) through which the Cluster service communicates with a particular resource type. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-ClusterResourceType -Name DisplayName ----- ----------- -DFS Replicated Folder DFS Replicated Folder -DHCP Service DHCP Service -Distributed File System Distributed File System -Distributed Transaction Coordinator Distributed Transaction Coordinator -File Server File Server -File Share Witness File Share Quorum Witness -Generic Application Generic Application -Generic Script Generic Script -Generic Service Generic Service -IP Address IP Address -IPv6 Address IPv6 Address -IPv6 Tunnel Address IPv6 Tunnel Address -Microsoft iSNS iSNSClusRes -MSMQ (Resource Type Unavailable) -MSMQTriggers (Resource Type Unavailable) -Network Name Network Name -NFS Share NFS Share -Physical Disk Physical Disk -Print Spooler Print Spooler -Virtual Machine Virtual Machine -Virtual Machine Configuration Virtual Machine Configuration -Volume Shadow Copy Service Task Volume Shadow Copy Service Task -WINS Service WINS Service -``` - -This example lists all the resource types that can be used in configurations on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterResourceType -Name "File Server" | Format-List -Property * -Cluster : Cluster1 -DisplayName : File Server -Name : file server -DllName : clusres.dll -Description : -AdminExtensions : {} -LooksAlivePollInterval : 5000 -IsAlivePollInterval : 60000 -PendingTimeout : 180000 -DeadlockTimeout : 300000 -Id : f582c84f-0066-0069-6c65-207365727665 -``` - -This example gets information about the File Server resource type on the local cluster, and displays the information in the form of a list. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate the cluster resource types. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource type to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceType - -## NOTES - -## RELATED LINKS - -[Add-ClusterResourceType](./Add-ClusterResourceType.md) - -[Remove-ClusterResourceType](./Remove-ClusterResourceType.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterSharedVolume.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterSharedVolume.md deleted file mode 100644 index db5f0a7588..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterSharedVolume.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustersharedvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterSharedVolume - -## SYNOPSIS -Gets information about Cluster Shared Volumes in a failover cluster. - -## SYNTAX - -``` -Get-ClusterSharedVolume [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterSharedVolume** cmdlet gets information about Cluster Shared Volumes in a failover cluster. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterSharedVolume -Name State Node ----- ----- ---- -Cluster Disk 3 Online node1 -Cluster Disk 4 Online node2 -``` - -This example lists all the Cluster Shared Volumes on the local cluster. - -### Example 2 -``` -PS C:\>Get-ClusterSharedVolume -Cluster cluster1 -Name State Node ----- ----- ---- -Cluster Disk 1 Online node4 -``` - -This example lists all the Cluster Shared Volumes on the cluster named cluster1. - -### Example 3 -``` -PS C:\>Get-ClusterSharedVolume -Name "Cluster Disk 4" -Name State Node ----- ----- ---- -Cluster Disk 4 Online node2 -``` - -This example displays the state of the Cluster Shared Volume called Cluster Disk 4. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to enumerate the Cluster Shared Volumes. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Cluster Shared Volume to get. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterSharedVolume](./Add-ClusterSharedVolume.md) - -[Move-ClusterSharedVolume](./Move-ClusterSharedVolume.md) - -[Remove-ClusterSharedVolume](./Remove-ClusterSharedVolume.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Get-ClusterVMMonitoredItem.md b/docset/winserver2012-ps/failoverclusters/Get-ClusterVMMonitoredItem.md deleted file mode 100644 index 37aee0e3a3..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Get-ClusterVMMonitoredItem.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/get-clustervmmonitoreditem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-ClusterVMMonitoredItem - -## SYNOPSIS -Gets the list of services and events currently being monitored in the virtual machine. - -## SYNTAX - -``` -Get-ClusterVMMonitoredItem [[-VirtualMachine] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Get-ClusterVMMonitoredItem** cmdlet gets the list of services and events currently being monitored in the virtual machine. -If one of those services fails or one of the events occurs, then the system responds by taking an action based on the failover configuration for the virtual machine resource. -For example, the configuration might specify that the virtual machine be restarted. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-Cluster -Name Cluster1 | Get-ClusterVMMonitoredItem -VirtualMachine vm1 -Name ----- -Microsoft-Windows-FailoverClustering-Manager+Admin,Microsoft-Windows-FailoverClustering-Manager,4708 -Spooler -``` - -This example returns the services and events being monitored in the virtual machine named vm1 on the cluster named Cluster1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Local Cluster -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to run the cmdlet or the clustered virtual machine for which to retrieve the clustered virtual machine monitored item object. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualMachine -Specifies the name of the clustered virtual machine on which to perform monitoring. -When this parameter is specified, the cmdlet must be run on one of the host cluster nodes, or else the **Cluster** parameter must also be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem - -## NOTES - -## RELATED LINKS - -[Add-ClusterVMMonitoredItem](./Add-ClusterVMMonitoredItem.md) - -[Remove-ClusterVMMonitoredItem](./Remove-ClusterVMMonitoredItem.md) - -[Reset-ClusterVMMonitoredState](./Reset-ClusterVMMonitoredState.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Grant-ClusterAccess.md b/docset/winserver2012-ps/failoverclusters/Grant-ClusterAccess.md deleted file mode 100644 index 27470a8aa9..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Grant-ClusterAccess.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/grant-clusteraccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Grant-ClusterAccess - -## SYNOPSIS -Grants access to a failover cluster, either full access or read-only access. - -## SYNTAX - -``` -Grant-ClusterAccess [-User] [-Cluster ] [-Full] [-InputObject ] - [-ReadOnly] -``` - -## DESCRIPTION -The **Grant-ClusterAccess** cmdlet grants access to a failover cluster, either full access or read-only access. -To provide someone with read-only access to the cluster, use the **ReadOnly** parameter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Grant-ClusterAccess -User contoso\johnj99 -Full -``` - -This example grants full access to the local cluster to johnj99 in the contoso domain. - -### Example 2 -``` -PS C:\>Grant-ClusterAccess -User contoso\johnj99 -ReadOnly -``` - -This example grants read-only access to the local cluster to johnj99 in the contoso domain. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Full -Specifies that the user gets full cluster access. -If no access level is specified, then the user gets read-only cluster access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to grant access for the given user. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReadOnly -Specifies that the user gets read-only cluster access. -If no access level is specified, then the user gets read-only cluster access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -Specifies the user for whom to grant cluster access. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Block-ClusterAccess](./Block-ClusterAccess.md) - -[Get-ClusterAccess](./Get-ClusterAccess.md) - -[Remove-ClusterAccess](./Remove-ClusterAccess.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Move-ClusterGroup.md b/docset/winserver2012-ps/failoverclusters/Move-ClusterGroup.md deleted file mode 100644 index a369a5eead..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Move-ClusterGroup.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustergroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ClusterGroup - -## SYNOPSIS -Moves a clustered role (a resource group) from one node to another in a failover cluster. - -## SYNTAX - -``` -Move-ClusterGroup [[-Name] ] [[-Node] ] [-Cluster ] [-IgnoreLocked] - [-InputObject ] [-Wait ] -``` - -## DESCRIPTION -The **Move-ClusterGroup** cmdlet moves a clustered role (a resource group) from one node to another in a failover cluster. - -Moving a resource group is a way of simulating failover. -Running this cmdlet is also an appropriate step to take in preparation for routine maintenance on a node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Move-ClusterGroup -Name MyFileServer -Name OwnerNode State ----- --------- ----- -MyFileServer node1 Online -``` - -This example moves the clustered service called MyFileServer from the current owner node to any other node. - -### EXAMPLE 2 -``` -PS C:\>Move-ClusterGroup -Name MyFileServer -Node node2 -Name OwnerNode State ----- --------- ----- -MyFileServer node2 Online -``` - -This example moves the resource group called MyFileServer from the current owner node to the node named node2. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterNode node3 | Get-ClusterGroup | Move-ClusterGroup -Name OwnerNode State ----- --------- ----- -Available Storage node4 Online -Cluster Group node1 Online -MyFileServer node1 Online -``` - -This example moves all resource groups that are currently owned by the node named node3 to other nodes. -Use this cmdlet before performing maintenance on the specified node. - -### EXAMPLE 4 -``` -PS C:\>Move-ClusterGroup -Name MyFileServer -Node node2 -Wait 0 -Name OwnerNode State ----- --------- ----- -MyFileServer node2 Pending -``` - -This example moves the resource group called MyFileServer from the current owner node to the node named `node2`. -Information about MyFileServer is displayed immediately, while it is in the process of being moved. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocked -Specifies that locked groups are ignored when running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the resource group to move. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource group to move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -Specifies the name of the cluster node to which to move the resource group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterGroup](./Add-ClusterGroup.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Move-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Move-ClusterResource.md deleted file mode 100644 index efaad4448d..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Move-ClusterResource.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ClusterResource - -## SYNOPSIS -Moves a clustered resource from one clustered role to another within a failover cluster. - -## SYNTAX - -``` -Move-ClusterResource [[-Name] ] [[-Group] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Move-ClusterResource** cmdlet moves a clustered resource from one clustered role to another within a failover cluster. -When a clustered resource is moved to a different clustered role, the clustered resource will then fail over with that clustered role. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Move-ClusterResource -Name resource1 -Group group2 -Name State Group ResourceType ----- ----- ----- ------------ -resource1 Offline group2 IP Address -``` - -This command moves the cluster resource called resource1 to the resource group called group2 on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the name of the cluster group to which to move the resource. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource to move. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Move-ClusterSharedVolume.md b/docset/winserver2012-ps/failoverclusters/Move-ClusterSharedVolume.md deleted file mode 100644 index 0e7f554950..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Move-ClusterSharedVolume.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustersharedvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ClusterSharedVolume - -## SYNOPSIS -Moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster. - -## SYNTAX - -``` -Move-ClusterSharedVolume [[-Name] ] [[-Node] ] [-Cluster ] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Move-ClusterSharedVolume** cmdlet moves a Cluster Shared Volume (CSV) to ownership by a different node in a failover cluster. - -On a failover cluster that uses CSVs, at any given time, access to each CSV is controlled by a particular node, called the owner of that CSV. -However, a single CSV can contain virtual hard disk (VHD) files used by multiple clustered virtual machines that are distributed across multiple cluster nodes. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Move-ClusterSharedVolume -Name "Cluster Disk 3" -Name State Node ----- ----- ---- -Cluster Disk 3 Online node2 -``` - -This example moves the Cluster Shared Volume called Cluster Disk 3 to another cluster node. - -### Example 2 -``` -PS C:\>Move-ClusterSharedVolume -Name "Cluster Disk 3" -Node node1 -Name State Node ----- ----- ---- -Cluster Disk 3 Online node1 -``` - -This example moves the Cluster Shared Volume called Cluster Disk 3 to the node named node1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the Cluster Shared Volume to move. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Cluster Shared Volume to move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -Specifies the name of the cluster node to which to move the Cluster Shared Volume. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterSharedVolume](./Add-ClusterSharedVolume.md) - -[Get-ClusterSharedVolume](./Get-ClusterSharedVolume.md) - -[Remove-ClusterSharedVolume](./Remove-ClusterSharedVolume.md) - -[Repair-ClusterSharedVolume](./Repair-ClusterSharedVolume.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Move-ClusterVirtualMachineRole.md b/docset/winserver2012-ps/failoverclusters/Move-ClusterVirtualMachineRole.md deleted file mode 100644 index 280d1c8fa4..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Move-ClusterVirtualMachineRole.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/move-clustervirtualmachinerole?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-ClusterVirtualMachineRole - -## SYNOPSIS -Moves the ownership of a clustered virtual machine to a different node. - -## SYNTAX - -``` -Move-ClusterVirtualMachineRole [[-Name] ] [[-Node] ] [-Cancel] [-Cluster ] - [-IgnoreLocked] [-InputObject ] [-MigrationType ] [-VMId ] - [-Wait ] -``` - -## DESCRIPTION -The **Move-ClusterVirtualMachineRole** cmdlet moves the ownership of a clustered virtual machine to a different node. - -This cmdlet is used to live migrate a clustered virtual machine. -For quick migration, use Move-ClusterGroup after using Get-ClusterResource and Set-ClusterParameter to set the **OfflineAction** parameter of the virtual machine resource to save state, or a value of 1. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Node node2 -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node2 Online -``` - -This example performs a live migration of the clustered virtual machine named Virtual Machine1 to the node named node2. -The Windows PowerShell® prompt does not return until the action is complete. - -### Example 2 -``` -PS C:\>Get-ClusterGroup -Name "Virtual Machine1" | Move-ClusterVirtualMachineRole -Node node2 -Wait 0 -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node2 Online -``` - -This example performs a live migration of clustered virtual machine named Virtual Machine1 to the node named node2. -The Windows PowerShell® prompt returns as soon as the action has been initiated. - -### Example 3 -``` -PS C:\>Move-ClusterVirtualMachineRole -Name "Virtual Machine1" -Cancel -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node1 Online -``` - -This example cancels the live migration in progress for the clustered virtual machine named Virtual Machine1. - -### Example 4 -``` -PS C:\>$groups = Get-ClusterNode -Name node1 | Get-ClusterGroup | Where-Object -FilterScript {$_ | Get-ClusterResource | Where-Object -FilterScript {$_.ResourceType -Like "Virtual Machine"}} - - - -PS C:\>ForEach-Object -InputObject ($group in $groups) -Process { $group | Move-ClusterVirtualMachineRole -Node node2 } -Name OwnerNode State ----- --------- ----- -Virtual Machine1 node2 Online -Virtual Machine2 node2 Online -Virtual Machine3 node2 Online -``` - -This example performs a live migration of all clustered virtual machines that are currently owned by the node named node1 to the node named node2. -The migration of each virtual machine should complete before the next migration is started. -Use this cmdlet before performing maintenance on the specified node. - -## PARAMETERS - -### -Cancel -Specifies that an in-progress live migration of the virtual machine be canceled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocked -Specifies that locked groups are ignored when running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the clustered virtual machine to move. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MigrationType -Specifies the type of migration to perform for the virtual machine. -The options are as follows: - - -- Live: Transparently migrates the virtual machine without a dropped network connection or perceived downtime. - - -- Quick: Rapidly migrates a running virtual machine with minimal downtime. - - -- Shutdown: Performs an orderly shutdown of the operating system (waiting for all processes to close) on the virtual machine, and then migrates the virtual machine. - - -- ShutdownForce: Shuts down the operating system on the virtual machine without waiting for slower processes to finish, and then migrates the virtual machine. - - -- TurnOff: Turns off the virtual machine without shutting down the operating system first, then migrates the virtual machine. -This is the same as turning off the power, which means that data loss may occur. - -```yaml -Type: NativeGroupHelp.VmMigrationType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the clustered virtual machine to move. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -Specifies the name of the cluster node to which to move the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMId -Specifies the virtual machine identifier (ID). - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterVirtualMachineRole](./Add-ClusterVirtualMachineRole.md) - -[Update-ClusterVirtualMachineConfiguration](./Update-ClusterVirtualMachineConfiguration.md) - diff --git a/docset/winserver2012-ps/failoverclusters/New-Cluster.md b/docset/winserver2012-ps/failoverclusters/New-Cluster.md deleted file mode 100644 index c582db9e6b..0000000000 --- a/docset/winserver2012-ps/failoverclusters/New-Cluster.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/new-cluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-Cluster - -## SYNOPSIS -Creates a new failover cluster. - -## SYNTAX - -``` -New-Cluster [-Name] [-IgnoreNetwork ] [-Node ] [-NoStorage] - [-StaticAddress ] -``` - -## DESCRIPTION -The **New-Cluster** cmdlet creates a new failover cluster. -Before creating a cluster, the hardware (servers, networks, and storage) must be connected, and the validation tests must be run. - -Use Test-Cluster to run the validation tests. -The tests will confirm that the hardware and settings are compatible with failover clustering. -There are multiple types of tests, including Inventory, System Configuration, Network, Storage, and other types of tests. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -``` -```output -Name ----- -cluster1 -``` - -This example creates a four-node cluster named cluster1, using default settings for IP addressing. - -### Example 2 -```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2 -NoStorage -``` -```output -Name ----- -cluster1 -``` - -This example creates a two-node cluster named cluster1. -The cluster will not have any clustered storage, or disk resources. -Storage can be added using the **Get-ClusterAvailableDisk** cmdlet with the **Add-ClusterDisk** cmdlet. - -### Example 3 -```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 -``` -```output -Name ----- -cluster1 -``` - -This example creates a four-node cluster named cluster1 that uses the static IP address 2.0.0.123. - -### Example 4 -```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123,3.0.0.123 -``` -```output -Name ----- -cluster1 -``` - -This example creates a four-node cluster named cluster1 that uses the static IP addresses 2.0.0.123 and 3.0.0.123. - -### Example 5 -```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -IgnoreNetwork 2.0.0.0/8 -``` -```output -Name ----- -cluster1 -``` - -This example creates a four-node cluster named cluster1. -The cluster uses default settings for IP addressing, and does not use the network 2.0.0.0/8. - -### Example 6 -```powershell -PS C:\> New-Cluster -Name cluster1 -Node node1,node2,node3,node4 -StaticAddress 2.0.0.123 -IgnoreNetwork 3.0.0.0/8 -``` -```output -Name ----- -cluster1 -``` - -This example creates a four-node cluster named cluster1. -The cluster uses the static IP address 2.0.0.123, and does not use the network 3.0.0.0/8. - -## PARAMETERS - -### -IgnoreNetwork -Specifies one or more networks to ignore when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster to create. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoStorage -Specifies that shared storage is ignored during the cluster creation. -The cluster created at the end of the operation will not have shared storage. -Shared storage can later be added by piping the **ClusterDiskInfo** object from the **Get-ClusterAvailableDisk** cmdlet into the **Add-ClusterDisk** cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node -Specifies a comma-separated list of cluster node names, or server names, on which to create the cluster. -If this parameter is not specified, then a one node cluster is created on the local physical computer. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticAddress -Specifies one or more static addresses to use when running the cmdlet. -Networks with DHCP enabled are always included, but other networks need a static address to be specified using the **StaticAddress** parameter or should be explicitly ignored with this **IgnoreNetwork** parameter. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## NOTES - -- This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-Cluster](./Get-Cluster.md) - -[Remove-Cluster](./Remove-Cluster.md) - -[Start-Cluster](./Start-Cluster.md) - -[Stop-Cluster](./Stop-Cluster.md) - -[Test-Cluster](./Test-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-Cluster.md b/docset/winserver2012-ps/failoverclusters/Remove-Cluster.md deleted file mode 100644 index a0ce418bb0..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-Cluster.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-cluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-Cluster - -## SYNOPSIS -Destroys an existing failover cluster. - -## SYNTAX - -``` -Remove-Cluster [[-Cluster] ] [-CleanupAD] [-Force] [-InputObject ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-Cluster** cmdlet destroys an existing failover cluster. -The affected servers will no longer function together as a cluster. - -This cmdlet deletes all copies of the cluster configuration database on all cluster nodes. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-Cluster -``` - -This example prompts the user for confirmation, then destroys the local failover cluster and removes cluster configuration information from the cluster nodes. - -### Example 2 -``` -PS C:\>Remove-Cluster -Force -``` - -This example destroys the local failover cluster and removes cluster configuration information from the cluster nodes. -The cmdlet does not prompt for confirmation. - -### Example 3 -``` -PS C:\>Get-Cluster -Name Cluster1 | Remove-Cluster -Force -CleanupAD -``` - -This example destroys the cluster named Cluster1, removes cluster configuration information from the cluster nodes, and deletes the cluster objects in Active Directory. -The cmdlet does not prompt for confirmation. - -## PARAMETERS - -### -CleanupAD -Specifies that when the cluster is destroyed, the objects in Active Directory that are associated with the cluster are removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster to destroy. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-Cluster](./Get-Cluster.md) - -[New-Cluster](./New-Cluster.md) - -[Start-Cluster](./Start-Cluster.md) - -[Stop-Cluster](./Stop-Cluster.md) - -[Test-Cluster](./Test-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterAccess.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterAccess.md deleted file mode 100644 index 17241bafb1..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterAccess.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusteraccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterAccess - -## SYNOPSIS -Removes a user from the access list on the cluster. - -## SYNTAX - -``` -Remove-ClusterAccess [[-User] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Remove-ClusterAccess** cmdlet removes a user from the access list on the cluster. -After this cmdlet is run, the user might still have access to the cluster if the user account is part of another user group which is on the cluster access list. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-ClusterAccess -User contoso\johnj99 -``` - -This example removes the user johnj99 in the contoso domain from the access list of the local cluster. -After this cmdlet runs, the user might still have access to the cluster if the user is part of another user group granted access to the cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster from which to remove access for the given user. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -User -Specifies the user for which to remove cluster access. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Block-ClusterAccess](./Block-ClusterAccess.md) - -[Get-ClusterAccess](./Get-ClusterAccess.md) - -[Grant-ClusterAccess](./Grant-ClusterAccess.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterCheckpoint.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterCheckpoint.md deleted file mode 100644 index 509b2d7b67..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterCheckpoint.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustercheckpoint?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterCheckpoint - -## SYNOPSIS -Removes a cryptographic key checkpoint or registry checkpoint for a resource. - -## SYNTAX - -``` -Remove-ClusterCheckpoint [[-ResourceName] ] [-CheckpointName ] [-Cluster ] - [-CryptoCheckpoint] [-Force] [-InputObject ] [-RegistryCheckpoint] -``` - -## DESCRIPTION -The **Remove-ClusterCheckpoint** cmdlet removes a cryptographic key checkpoint or registry checkpoint for a resource. - -Checkpoints help provide failover support for applications that store configuration information locally instead of or in addition to storing information in the cluster configuration database. -Applications might store information locally in two ways. -One way is to store configuration information in the registry on the local server; another way is to use cryptographic keys on the local server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterResource "Cluster Name" | Remove-ClusterCheckpoint -RegistryCheckpoint - - - -PS C:\>Remove-ClusterCheckpoint -Are you sure you want to remove registry checkpoint 'software\clusname' on resource 'Cluster Name'? - - -[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y -``` - -This example removes the registry checkpoint called software\clusname for the resource named Cluster Name. - -## PARAMETERS - -### -CheckpointName -Specifies the name of the checkpoint to remove. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CryptoCheckpoint -Specifies that cryptographic key checkpoints will be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to run the cmdlet or the cluster resource from which to remove the checkpoint. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -RegistryCheckpoint -Specifies that registry checkpoints will be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceName -Specifies the resource from which a checkpoint should be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### System.Object - -## NOTES - -## RELATED LINKS - -[Add-ClusterCheckpoint](./Add-ClusterCheckpoint.md) - -[Get-ClusterCheckpoint](./Get-ClusterCheckpoint.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterGroup.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterGroup.md deleted file mode 100644 index 64f9d3b2f0..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterGroup.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustergroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterGroup - -## SYNOPSIS -Removes a clustered role, also called a resource group, from a failover cluster. - -## SYNTAX - -``` -Remove-ClusterGroup [[-Name] ] [-Cluster ] [-Force] [-InputObject ] - [-RemoveResources] -``` - -## DESCRIPTION -The **Remove-ClusterGroup** cmdlet removes a clustered role. -also called a resource group, from a failover cluster. - -Use this cmdlet to delete a group. -If the group still has resources in it, then either remove the resources first, or specify the **RemoveResources** parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-ClusterGroup -Name MyFileServer -``` - -This example prompts the user for confirmation and then removes the clustered role named MyFileServer, if the resources have first been removed from it. - -### EXAMPLE 2 -``` -PS C:\>Remove-ClusterGroup -Name MyFileServer -Force -``` - -This example removes the clustered role named MyFileServer, if the resources have first been removed from it. -The cmdlet does not prompt for confirmation. - -### EXAMPLE 3 -``` -PS C:\>Remove-ClusterGroup -Name MyFileServer -Force -RemoveResources -``` - -This example removes the clustered role named MyFileServer, without prompting for confirmation. -All cluster resources in MyFileServer will be deleted. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the clustered role to remove. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the clustered role to remove. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoveResources -Causes the cmdlet to delete all resources in the clustered role before removing the clustered role. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-ClusterGroup](./Add-ClusterGroup.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterNode.md deleted file mode 100644 index 9e4b71f804..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterNode.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterNode - -## SYNOPSIS -Removes a node from a failover cluster. - -## SYNTAX - -``` -Remove-ClusterNode [[-Name] ] [-Cluster ] [-Force] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Remove-ClusterNode** cmdlet removes a node from a failover cluster. -After the node is removed, the node no longer functions as part of the cluster unless the node is added back to the cluster. -Removing a node is also called evicting a node from the cluster. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-ClusterNode -Name node4 -``` - -This example removes the node named node4 from the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Remove-ClusterNode -Name node4 -Force -``` - -This example removes the node named node4 from the local cluster without prompting for confirmation. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster node to remove. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node to remove. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[Resume-ClusterNode](./Resume-ClusterNode.md) - -[Start-ClusterNode](./Start-ClusterNode.md) - -[Stop-ClusterNode](./Stop-ClusterNode.md) - -[Suspend-ClusterNode](./Suspend-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterResource.md deleted file mode 100644 index 85baadcf87..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterResource.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterResource - -## SYNOPSIS -Removes a clustered resource from the failover cluster. - -## SYNTAX - -``` -Remove-ClusterResource [[-Name] ] [-Cluster ] [-Force] [-InputObject ] -``` - -## DESCRIPTION -The **Remove-ClusterResource** cmdlet removes a clustered resource from the failover cluster. -Before removing a resource, be sure to review whether any other resource is dependent on that resource. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-ClusterResource -Name "Cluster Disk 4" -``` - -This example prompts the user for confirmation and then deletes the cluster named Cluster Disk 4 from the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Remove-ClusterResource -Name "Cluster Disk 5" -Force -``` - -This example deletes the cluster named Cluster Disk 5 from the local cluster without prompting for confirmation. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource to remove. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to remove. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterResourceDependency.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterResourceDependency.md deleted file mode 100644 index 0d6d3749a2..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterResourceDependency.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresourcedependency?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterResourceDependency - -## SYNOPSIS -Removes a dependency between two resources in a clustered role within a failover cluster. - -## SYNTAX - -``` -Remove-ClusterResourceDependency [[-Resource] ] [[-Provider] ] [-Cluster ] - [-InputObject ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-ClusterResourceDependency** cmdlet removes a dependency between two resources in a clustered role within a failover cluster. - -A dependent resource is brought online after the resources on which it depends. -Likewise, a dependent resource is taken offline before the resources on which it depends. -If no dependency is configured between clustered resources, then the order in which they are brought online or taken offline might vary. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-ClusterResourceDependency -Resource cluster1FS -Provider "IP Address 2001:4898:9:2:: (3)" -Name State Group ResourceType ----- ----- ----- ------------ -cluster1FS Online cluster1FS Network Name -``` - -This example removes the dependency between cluster resource cluster1FS and the resource named IP Address 2001:4898:9:2:: (3). - -### Example 2 -``` -PS C:\>Get-ClusterResource -Name cluster1FS | Remove-ClusterResourceDependency -Provider "IP Address 2001:4898:9:2:: (3)" -Name State Group ResourceType ----- ----- ----- ------------ -cluster1FS Online cluster1FS Network Name -``` - -This example removes the dependency between the cluster resource named cluster1FS and the resource named IP Address 2001:4898:9:2:: (3). - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource from which to remove the dependency. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Provider -Specifies the cluster resource on which to remove a dependency. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource from which to remove the dependency. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Add-ClusterResourceDependency](./Add-ClusterResourceDependency.md) - -[Get-ClusterResourceDependency](./Get-ClusterResourceDependency.md) - -[Set-ClusterResourceDependency](./Set-ClusterResourceDependency.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterResourceType.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterResourceType.md deleted file mode 100644 index 6884c846f1..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterResourceType.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clusterresourcetype?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterResourceType - -## SYNOPSIS -Removes a resource type from a failover cluster. - -## SYNTAX - -``` -Remove-ClusterResourceType [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Remove-ClusterResourceType** cmdlet removes a resource type from a failover cluster. -A resource type is a class of resource, such as physical disk, network name, or virtual machine, that is organized by the failover cluster. -After a resource type is removed from a failover cluster, resources of that type will not be able to be used in the cluster. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-ClusterResourceType -Name ResType1 -``` - -This example removes the registered resource type named ResType1 on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource type to remove. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource type to remove. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceType - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-ClusterResourceType](./Add-ClusterResourceType.md) - -[Get-ClusterResourceType](./Get-ClusterResourceType.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterSharedVolume.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterSharedVolume.md deleted file mode 100644 index 5625065eae..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterSharedVolume.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustersharedvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterSharedVolume - -## SYNOPSIS -Removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. - -## SYNTAX - -``` -Remove-ClusterSharedVolume [[-Name] ] [-Cluster ] [-InputObject ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-ClusterSharedVolume** cmdlet removes a volume from the Cluster Shared Volumes in a failover cluster, and places it in Available Storage in the cluster. -After placing a volume in Available Storage, you can use the volume when you configure a new clustered role. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-ClusterSharedVolume -Name "Cluster Disk 3" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 3 Online Available Storage Physical Disk -``` - -This example removes the CSV named Cluster Disk 3 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage. - -### Example 2 -``` -PS C:\>Get-ClusterSharedVolume -Name "Cluster Disk 4" | Remove-ClusterSharedVolume -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 4 Online Available Storage Physical Disk -``` - -This example removes the CSV named Cluster Disk 4 from the Cluster Shared Volumes on the local cluster, and places it in Available Storage. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the Cluster Shared Volume to remove. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the Cluster Shared Volume to remove. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Add-ClusterSharedVolume](./Add-ClusterSharedVolume.md) - -[Get-ClusterSharedVolume](./Get-ClusterSharedVolume.md) - -[Move-ClusterSharedVolume](./Move-ClusterSharedVolume.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md b/docset/winserver2012-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md deleted file mode 100644 index be4fcbfc2c..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Remove-ClusterVMMonitoredItem.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/remove-clustervmmonitoreditem?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-ClusterVMMonitoredItem - -## SYNOPSIS -Removes monitoring of a service or event that is currently being monitored on a virtual machine. - -## SYNTAX - -``` -Remove-ClusterVMMonitoredItem [[-VirtualMachine] ] [-Cluster ] [-EventId ] - [-EventLog ] [-EventSource ] [-InputObject ] [-Service ] -``` - -## DESCRIPTION -The **Remove-ClusterVMMonitoredItem** cmdlet removes monitoring of a service or event that is currently being monitored. -After removal, if the service fails or the event occurs, the system will no longer take an action, such as restarting the virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterVMMonitoredItem -VirtualMachine VM1 | Remove-ClusterVMMonitoredItem -VirtualMachine VM1 -``` - -This example removes all of the items being monitored on the virtual machine named VM1. - -### Example 2 -``` -PS C:\>Remove-ClusterVMMonitoredItem -VirtualMachine VM1 -Service spooler -http://go.microsoft.com/fwlink/?LinkId=216240 -``` - -This example removes monitoring on the print spooler service on the virtual machine named VM1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventId -Specifies the event identifier (ID) of the Event Tracing for Windows (ETW) event to be removed from monitoring. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventLog -Specifies the event log of the event to be removed from monitoring. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventSource -Specifies the event source of the event to be removed from monitoring. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to run the cmdlet, the clustered virtual machine from which to remove monitoring, or the clustered virtual machine monitored item object to stop monitoring. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Service -Specifies the name of the service to be removed from monitoring. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachine -Specifies the name of the clustered virtual machine from which to remove monitoring. -When this parameter is specified, this cmdlet must be run on one of the host cluster nodes, or else the **Cluster** parameter must also be specified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterVMMonitoredItem - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-ClusterVMMonitoredItem](./Add-ClusterVMMonitoredItem.md) - -[Get-ClusterVMMonitoredItem](./Get-ClusterVMMonitoredItem.md) - -[Reset-ClusterVMMonitoredState](./Reset-ClusterVMMonitoredState.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Repair-ClusterSharedVolume.md b/docset/winserver2012-ps/failoverclusters/Repair-ClusterSharedVolume.md deleted file mode 100644 index d36e22923d..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Repair-ClusterSharedVolume.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/repair-clustersharedvolume?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Repair-ClusterSharedVolume - -## SYNOPSIS -Runs repair tools on a Cluster Shared Volume locally on a cluster node. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Repair-ClusterSharedVolume [-VolumeName] [-Parameters ] [-ChkDsk] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Repair-ClusterSharedVolume [-VolumeName] [-Parameters ] [-Defrag] -``` - -## DESCRIPTION -The **Repair-ClusterSharedVolume** cmdlet runs repair tools on a Cluster Shared Volume locally on a cluster node. - -This cmdlet runs **chkdsk.exe** or **defrag.exe** on a Cluster Shared Volume. -It will turn maintenance on for the volume, move the cluster resource to the node running this cmdlet, run the tool, and then turn maintenance off for the volume. -This cmdlet has to run locally on one of the cluster nodes. -To run remotely, use Windows PowerShell® remoting. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Repair-ClusterSharedVolume -VolumeName C:\ClusterStorage\Volume1 -Defrag -``` - -This example runs defrag.exe on Cluster Shared Volume located at C:\ClusterStorage\Volume1. - -### Example 2 -``` -PS C:\>Repair-ClusterSharedVolume -VolumeName C:\ClusterStorage\Volume1 -ChkDsk -Parameters "/F" -``` - -This example runs chkdsk.exe on Cluster Shared Volume located at C:\ClusterStorage\Volume1 and passes the /F parameter to chkdsk.exe. - -## PARAMETERS - -### -ChkDsk -Specifies that **chkdsk.exe** is run on the volume. -Any parameters specified in the **Parameters** parameter will be passed through to **chkdsk.exe**. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Defrag -Specifies that **defrag.exe** is run on the volume. -Any parameters specified in the **Parameters** parameter will be passed through to **defrag.exe**. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies one or more parameters to pass through to the tool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeName -Specifies the name of the volume on which to run the tool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-ClusterSharedVolume](./Get-ClusterSharedVolume.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Reset-ClusterVMMonitoredState.md b/docset/winserver2012-ps/failoverclusters/Reset-ClusterVMMonitoredState.md deleted file mode 100644 index 4543fb63fa..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Reset-ClusterVMMonitoredState.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/reset-clustervmmonitoredstate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-ClusterVMMonitoredState - -## SYNOPSIS -Resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. - -## SYNTAX - -``` -Reset-ClusterVMMonitoredState [[-VirtualMachine] ] [-InputObject ] -``` - -## DESCRIPTION -The **Reset-ClusterVMMonitoredState** cmdlet resets the Application Critical state of a virtual machine, so that the virtual machine is no longer marked as being in a critical state in the cluster. -Note: This cmdlet can only be run locally on the virtual machine or through Windows PowerShell® remoting to the virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Reset-ClusterVMMoniteredState -``` - -This example resets the state of the virtual machine and clears the critical state. - -## PARAMETERS - -### -InputObject -Specifies the cluster on which to run the cmdlet and the clustered virtual machine to reset. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualMachine -Specifies the name of the clustered virtual machine to reset. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-ClusterVMMonitoredItem](./Add-ClusterVMMonitoredItem.md) - -[Get-ClusterVMMonitoredItem](./Get-ClusterVMMonitoredItem.md) - -[Remove-ClusterVMMonitoredItem](./Remove-ClusterVMMonitoredItem.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Resume-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Resume-ClusterNode.md deleted file mode 100644 index fa06adbc98..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Resume-ClusterNode.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/resume-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-ClusterNode - -## SYNOPSIS -Resumes a node from the paused state or brings back drained workloads to the node or both. - -## SYNTAX - -``` -Resume-ClusterNode [[-Name] ] [[-Failback] ] - [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Resume-ClusterNode** cmdlet resumes activity on a failover cluster node after it has been suspended, or paused, or brings back drained workloads to the node, or both. -When a node is resumed, clustered roles that were drained from the node are returned to it, and clustered roles or resources that are currently offline can be brought online on that node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Resume-ClusterNode node1 -Name State ----- ----- -node1 Up -``` - -This example resumes node1 on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Resume-ClusterNode node2 -Cluster mycluster -Name State ----- ----- -node2 Up -``` - -This example resumes node2 on the cluster called mycluster. - -### EXAMPLE 3 -``` -PS C:\>Get-ClusterNode | Resume-ClusterNode -Name State ----- ----- -node1 Up -``` - -This example resumes all cluster nodes that are suspended, or paused, on the local cluster. - -### EXAMPLE 4 -``` -PS C:\>Get-ClusterNode | Resume-ClusterNode -Failback Immediate -Name State ----- ----- -node2 Up -``` - -This example resumes all cluster nodes that are suspended, or paused, on the local cluster and immediately brings back the workloads drained from the nodes. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Failback -Sets the policy to bring back drained workloads to the node. -The acceptable values for this parameter are:NoFailback, Immediate, and Policy. -Policy can be configured to not failback, failback immediately, or failback only during specific hours. - -```yaml -Type: ResumeClusterNodeFailbackType -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the group, node, resource, or service for which or cluster on which to run the cmdlet. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the group, node, resource, or service for which or cluster on which to run the cmdlet. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Clear-ClusterNode](./Clear-ClusterNode.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - -[Start-ClusterNode](./Start-ClusterNode.md) - -[Stop-ClusterNode](./Stop-ClusterNode.md) - -[Suspend-ClusterNode](./Suspend-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Resume-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Resume-ClusterResource.md deleted file mode 100644 index a7a564af19..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Resume-ClusterResource.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/resume-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-ClusterResource - -## SYNOPSIS -Turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. - -## SYNTAX - -``` -Resume-ClusterResource [[-Name] ] [-Cluster ] [-InputObject ] [-VolumeName ] -``` - -## DESCRIPTION -The **Resume-ClusterResource** cmdlet turns off maintenance for a disk resource or Cluster Shared Volume within a failover cluster. - -This cmdlet applies to disks and Cluster Shared Volumes only. -We recommend that maintenance be turned off for a disk or Cluster Shared Volume as soon as the maintenance tasks have been completed. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Resume-ClusterResource "Cluster Disk 2" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 2 Online Available Storage Physical Disk -``` - -This example turns off maintenance for the CSV named Cluster Disk 2. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterSharedVolume "Cluster Disk 5" | Resume-ClusterResource -Name State Node ----- ----- ---- -Cluster Disk 5 Online node2 -``` - -This example turns off maintenance for all volumes on the CSV named Cluster Disk 5. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource to resume. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to resume. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeName -Specifies the name of the volume to suspend. -This parameter is only applicable to Cluster Shared Volumes. -If this parameter is not specified, then the operation will be performed on all volumes on the Cluster Shared Volume. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Set-ClusterLog.md b/docset/winserver2012-ps/failoverclusters/Set-ClusterLog.md deleted file mode 100644 index 7ce68857a5..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Set-ClusterLog.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterlog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ClusterLog - -## SYNOPSIS -Sets the size and level of detail for the cluster log. - -## SYNTAX - -``` -Set-ClusterLog [-Cluster ] [-InputObject ] [-Level ] [-Size ] -``` - -## DESCRIPTION -The **Set-ClusterLog** cmdlet sets the size and level of detail for the cluster log. -The default level, `3`, includes errors, warnings, and additional information. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-ClusterLog -Level 1 -Name ----- -cluster1 -``` - -This example sets the cluster log to a detail level of 1. - -### Example 2 -``` -PS C:\>Set-ClusterLog -Size 1024 -Name ----- -cluster1 -``` - -This example sets the cluster log size to 1024 MB. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster from which to generate cluster logs. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Level -Specifies the log level to set for the cluster. -The acceptable values for this parameter are:`0` to `5`. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Size -Specifies the log size to set for the cluster. -The acceptable values for this parameter are:`8` MB to `1024` MB. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## NOTES - -## RELATED LINKS - -[Get-ClusterLog](./Get-ClusterLog.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Set-ClusterOwnerNode.md b/docset/winserver2012-ps/failoverclusters/Set-ClusterOwnerNode.md deleted file mode 100644 index 4d8b91edb5..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Set-ClusterOwnerNode.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterownernode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ClusterOwnerNode - -## SYNOPSIS -Specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group. - -## SYNTAX - -``` -Set-ClusterOwnerNode [-Cluster ] [-Group ] [-InputObject ] [-Resource ] - -Owners -``` - -## DESCRIPTION -The **Set-ClusterOwnerNode** cmdlet specifies which nodes can own a resource in a failover cluster or specifies the order of preference among owner nodes for a clustered role, or resource group. -The settings that control the possible or preferred owners affect the way the cluster responds to the failure of a resource or a clustered role. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterResource -Name "Cluster Disk 3" | Set-ClusterOwnerNode -Owners node1,node2 -``` - -This example sets the possible owners for cluster named Cluster Disk 3 on the local cluster to the nodes named node1 and node2. - -### Example 2 -``` -PS C:\>Set-ClusterOwnerNode -Group cluster12FS -Owners node3,node2 -``` - -This example sets the preferred owners for the clustered service named cluster12FS to the node named node3 followed by the node named node2 on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Group -Specifies the name of the cluster group for which owner nodes are set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster group or cluster resource for which to set owner nodes. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Owners -Specifies the list of owner nodes. -If this is for a cluster group, then the sorted list of nodes is the preferred owners for this cluster group. -If this is for a cluster resource, then the list is for the possible owners for this cluster resource. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource for which owner nodes are set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-ClusterOwnerNode](./Get-ClusterOwnerNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Set-ClusterParameter.md b/docset/winserver2012-ps/failoverclusters/Set-ClusterParameter.md deleted file mode 100644 index 78417af5a2..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Set-ClusterParameter.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterparameter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ClusterParameter - -## SYNOPSIS -Controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. - -## SYNTAX - -``` -Set-ClusterParameter [[-Name] ] [[-Value] ] [-Cluster ] [-Create] [-Delete] - [-InputObject ] [-Multiple ] -``` - -## DESCRIPTION -The **Set-ClusterParameter** cmdlet controls specific properties of an object in a failover cluster, such as a resource, a group, or a network. - - -- For a disk resource, you can set the disk signature or GUID of a disk, and turn maintenance on or off for that disk. - - -- For a Network Name resource, you can set DNS-related information about the resource. - - -- For an IP address resource, you can set DHCP-related information about the IP Address resource. - - -- For resources used by virtual machines, you can set details about the settings for the virtual machines. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterResource -Name cluster1FS | Set-ClusterParameter -Name HostRecordTTL -Value 300 -``` - -This example configures the clustered resource called cluster1FS on the local cluster, by setting the value of HostRecordTTL to 300. - -### Example 2 -``` -PS C:\>Get-ClusterResource -Name "Cluster IP Address" | Set-ClusterParameter -Multiple @{"Address"="172.24.22.168";"Network"="Cluster Network 2";"EnableDhcp"=1} -``` - -This example uses the **Multiple** parameter to configure the clustered resource called Cluster IP Address, by setting the **Address**, **Network**, and **EnableDhcp** parameters simultaneously. - -### Example 3 -``` -PS C:\>$res = Get-ClusterResource -Name "IP Address" - - - -PS C:\>$param1 = New-Object -ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter -Property $res,Address,10.55.88.46 - - - -PS C:\>$param2 = New-Object -ComObject Microsoft.FailoverClusters.PowerShell.ClusterParameter -Property $res,SubnetMask,255.0.0.0 - - - -PS C:\>$params = $param1,$param2 - - - -PS C:\>$params | Set-ClusterParameter -``` - -This example configures the clustered resource called IP Address to use a new static IP. -Because the new address and subnet mask are required, both parameters must be passed to this cmdlet together. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Create -Causes the cmdlet to create the parameter on the cluster object, if it does not already exist. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Delete -Causes the cmdlet to delete the parameter from the cluster object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster object for which to set the parameters. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Multiple -Allows multiple cluster parameters to be set simultaneously. -These parameters are provided in the form of a hashtable. - -```yaml -Type: hashtable -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster parameter to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies the value to be set for the cluster parameter. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -### Microsoft.FailoverClusters.PowerShell.ClusterNetwork - -### Microsoft.FailoverClusters.PowerShell.ClusterNetworkInterface - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -### Microsoft.FailoverClusters.PowerShell.ClusterParameter - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterResourceType - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-ClusterParameter](./Get-ClusterParameter.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Set-ClusterQuorum.md b/docset/winserver2012-ps/failoverclusters/Set-ClusterQuorum.md deleted file mode 100644 index aa66036b79..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Set-ClusterQuorum.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterquorum?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ClusterQuorum - -## SYNOPSIS -Configures quorum options for a failover cluster. - -## SYNTAX - -``` -Set-ClusterQuorum [-Cluster ] [-DiskOnly ] [-InputObject ] - [-NodeAndDiskMajority ] [-NodeAndFileShareMajority ] [-NodeMajority] -``` - -## DESCRIPTION -The **Set-ClusterQuorum** cmdlet configures quorum options for a failover cluster. -The quorum configuration in a failover cluster determines the number of failures that the cluster can sustain. -If an additional failure occurs, the cluster must stop running. -The relevant failures in this context are failures of nodes or, in some cases, of a disk witness (which contains a copy of the cluster configuration) or file share witness. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-ClusterQuorum -NodeMajority -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 NodeMajority -``` - -This example changes the quorum configuration to Node Majority on the local cluster. - -### Example 2 -``` -PS C:\>Set-ClusterQuorum -NodeAndDiskMajority "Cluster Disk 7" -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 Cluster Disk 7 NodeAndDiskMajority -``` - -This example changes the quorum configuration to Node and Disk Majority on the local cluster, using the disk resource named Cluster Disk 7 for the disk witness. - -### Example 3 -``` -PS C:\>Set-ClusterQuorum -NodeAndFileShareMajority \\fileserver\fsw -Cluster QuorumResource QuorumType -------- -------------- ---------- -cluster1 File Share Witness NodeAndFileShareMajority -``` - -This example changes the quorum configuration to Node and File Share Majority on the local cluster, using the disk resource at \\\\fileserver\fsw for the file share witness. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskOnly -Causes the cluster quorum to be set to disk only type. -This is not recommended as it creates a single point of failure for the cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster on which to change the quorum type. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NodeAndDiskMajority -Causes the cluster quorum to be set to node and disk majority type. -The name of the disk resource to be used as the disk witness is expected with this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeAndFileShareMajority -Causes the cluster quorum to be set to node and file share majority type. -The path to the file share to be used as the file share witness is expected with this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeMajority -Causes the cluster quorum to be set to node majority type. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterQuorumSettings - -## NOTES - -## RELATED LINKS - -[Get-ClusterQuorum](./Get-ClusterQuorum.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Set-ClusterResourceDependency.md b/docset/winserver2012-ps/failoverclusters/Set-ClusterResourceDependency.md deleted file mode 100644 index c22a9dd1d6..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Set-ClusterResourceDependency.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/set-clusterresourcedependency?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-ClusterResourceDependency - -## SYNOPSIS -Specifies the resources that a particular resource depends on within a failover cluster. - -## SYNTAX - -``` -Set-ClusterResourceDependency [[-Resource] ] [[-Dependency] ] [-Cluster ] - [-InputObject ] -``` - -## DESCRIPTION -The **Set-ClusterResourceDependency** cmdlet specifies the resources that a particular resource depends on within a failover cluster. -Existing dependencies will be overwritten by the dependencies that you specify. - -The term or can be used in the expression describing the dependency. -For example, an or dependency can be set up where a Network Name resource is dependent on either of two IP address resources, instead of being dependent on both. -This use of or dependencies is common in multi-site cluster deployments. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "[IP Address 151.56.48.0]" -``` - -This example makes the resource called cluster1FS12 dependent on \[IP Address 151.56.48.0\]. - -### Example 2 -``` -C:\PS>Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "[IP Address 151.56.48.0] or [New IP Address]" -``` - -This example makes the resource called cluster1FS12 dependent on either \[IP Address 151.56.48.0\] or \[New IP Address\]. - -### Example 3 -``` -C:\PS>Set-ClusterResourceDependency -Resource cluster1FS12 -Dependency "" -``` - -This example clears the dependency list for the resource named cluster1FS12, so that it no longer depends on any other resources. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dependency -Specifies the dependency expression to set for this resource. -The format for this is string is as follows. -`"\[Resource Name 1\] \[and|or \[Resource Name 2\] \[...\] \]"Resource Name 1Resource Name 2` - - Resource names should be enclosed in square brackets as `\[Cluster Disk 2\]Cluster Disk 2`. -To reset the resource dependency, use an empty string `""` in this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource for which to set the dependency expression. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Resource -Specifies the name of the cluster resource for which to set the dependency expression. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-ClusterResourceDependency](./Add-ClusterResourceDependency.md) - -[Get-ClusterResourceDependency](./Get-ClusterResourceDependency.md) - -[Get-ClusterResourceDependencyReport](./Get-ClusterResourceDependencyReport.md) - -[Remove-ClusterResourceDependency](./Remove-ClusterResourceDependency.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Start-Cluster.md b/docset/winserver2012-ps/failoverclusters/Start-Cluster.md deleted file mode 100644 index ae1e1c0fc5..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Start-Cluster.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-cluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-Cluster - -## SYNOPSIS -Starts the Cluster service on all nodes of the cluster on which it is not yet started. - -## SYNTAX - -``` -Start-Cluster [[-Name] ] [-IgnorePersistentState] [-Wait ] -``` - -## DESCRIPTION -The **Start-Cluster** cmdlet starts the Cluster service on all nodes of the cluster on which it is not yet started. -A node can function as part of the cluster only when the Cluster service is running on that node. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Start-Cluster -Name ----- -mycluster -``` - -This example starts all cluster nodes on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Start-Cluster -Name node2 -Name ----- -mycluster -``` - -This example starts all cluster nodes on the cluster of which the node named node2 is a part. -A node name is required if all cluster nodes are stopped. -If the cluster is already running, then the cluster name, assuming the cluster name resource is online, can be used instead of the node name. - -## PARAMETERS - -### -IgnorePersistentState -Starts the nodes in the cluster without bringing resources online on the nodes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: IPS - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster to start. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If this parameter is not specified, then the cmdlet will not return until quorum is achieved. -If the value of `0` is specified, the cmdlet will attempt to start the Cluster service on all nodes and then return without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## NOTES - -## RELATED LINKS - -[Get-Cluster](./Get-Cluster.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[New-Cluster](./New-Cluster.md) - -[Remove-Cluster](./Remove-Cluster.md) - -[Stop-Cluster](./Stop-Cluster.md) - -[Test-Cluster](./Test-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Start-ClusterGroup.md b/docset/winserver2012-ps/failoverclusters/Start-ClusterGroup.md deleted file mode 100644 index 7a9632c87e..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Start-ClusterGroup.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-clustergroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-ClusterGroup - -## SYNOPSIS -Starts one or more clustered roles, also known as resource groups, on a failover cluster. - -## SYNTAX - -``` -Start-ClusterGroup [[-Name] ] [-Cluster ] [-IgnoreLocked] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Start-ClusterGroup** cmdlet starts one or more clustered roles, also known as resource groups, on a failover cluster. -With this cmdlet, a clustered role can be started again after stopping it for maintenance or diagnosis. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Start-ClusterGroup FileServer1 -Name OwnerNode State ----- --------- ----- -FileServer1 node1 Online -``` - -This example starts the clustered file server, or resource group, called FileServer1. - -### EXAMPLE 2 -``` -PS C:\>Start-ClusterGroup FileServer1 -Wait 0 -Name OwnerNode State ----- --------- ----- -FileServer1 node1 Pending -``` - -This example starts the clustered file server, or resource group, called FileServer1. -The Windows PowerShell® prompt returns as soon as the action has been initiated. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocked -Specifies that locked groups are ignored when running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the clustered role to start. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the clustered role to start. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterGroup](./Add-ClusterGroup.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Stop-ClusterGroup](./Stop-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Start-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Start-ClusterNode.md deleted file mode 100644 index a7d35cbb2b..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Start-ClusterNode.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-ClusterNode - -## SYNOPSIS -Starts the Cluster service on a node in a failover cluster. - -## SYNTAX - -``` -Start-ClusterNode [[-Name] ] [-Cluster ] [-FixQuorum] [-IgnorePersistentState] - [-InputObject ] [-PreventQuorum] [-Wait ] -``` - -## DESCRIPTION -The **Start-ClusterNode** cmdlet starts the Cluster service on a node in a failover cluster. -If this is the first node started, then it will wait for other nodes to join. -The cluster will begin to run when a quorum has formed. - -This cmdlet with the **FixQuorum** parameter can be used to force quorum, that is, force the start of a cluster node even if quorum has not been achieved. -When quorum is forced on a given node, the copy of the cluster configuration that is on that node will be treated as the authoritative copy and will be replicated to all other nodes. -Therefore, forcing quorum should be considered a last resort, because some cluster configuration changes could be lost. -The ability to force quorum can be especially useful in a multi-site cluster if the primary site, with the majority of nodes, becomes unavailable, and the secondary site, with a minority of nodes, need to be brought into service. -Similarly, the ability to force quorum makes it possible to start a cluster that uses the Node and File Share Majority quorum option when none of the available cluster nodes contains a current copy of the cluster configuration. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Start-ClusterNode -Name node3 -Name State ----- ----- -node3 Joining -``` - -This example starts the Cluster service on the node named node3 on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Start-ClusterNode -Name node1 -Cluster cluster2 -Name State ----- ----- -node1 Joining -``` - -This example starts the Cluster service on the node named node1 on the cluster named cluster2. - -### EXAMPLE 3 -``` -PS C:\>Start-ClusterNode -FixQuorum -Name State ----- ----- -node1 Joining -``` - -This example forces the local node and the local cluster to start, even if quorum has not been achieved. -If quorum has not been achieved, then the copy of the cluster configuration that is on the local node will be treated as the authoritative copy and will be replicated to all other nodes. -This cmdlet should be considered a last resort, because some cluster configuration changes could be lost. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FixQuorum -Forces quorum on this node, which means that the copy of the cluster configuration that is on this node will be treated as the authoritative copy and will be replicated to all other nodes. -Forcing quorum should be considered a last resort. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: fq - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnorePersistentState -Starts the cluster node without bringing resources online on the node. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster node to start. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node to start. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PreventQuorum -Starts the node, but prevents it from achieving quorum and forming the cluster, to prevent a split situation with two competing instances of the cluster running. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - -[Resume-ClusterNode](./Resume-ClusterNode.md) - -[Stop-ClusterNode](./Stop-ClusterNode.md) - -[Suspend-ClusterNode](./Suspend-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Start-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Start-ClusterResource.md deleted file mode 100644 index 7c0b2a6383..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Start-ClusterResource.md +++ /dev/null @@ -1,159 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/start-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-ClusterResource - -## SYNOPSIS -Brings a resource online in a failover cluster. - -## SYNTAX - -``` -Start-ClusterResource [[-Name] ] [-Cluster ] [-IgnoreLocked] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Start-ClusterResource** cmdlet brings a resource online in a failover cluster. -Before the resource is brought online, any resources that it depends are brought online. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Start-ClusterResource -Name "IP Address 172.24.11.0" -Name State Group ResourceType ----- ----- ----- ------------ -IP Address 172.2... Online cluster1FS12 IP Address -``` - -This example brings the resource called IP Address 172.24.11.0 online on the local cluster. -Before bringing the resource online, this cmdlet brings online any resources on which the resource depends. - -### EXAMPLE 2 -``` -PS C:\>Start-ClusterResource -Name "IP Address 172.24.11.0" -Wait 0 -Name State Group ResourceType ----- ----- ----- ------------ -IP Address 172.2... OnlinePending cluster1FS12 IP Address -``` - -This example brings the resource called IP Address 172.24.11.0 online on the local cluster. -Before bringing the resource online, this cmdlet brings online any resources on which the resource depends. -The Windows PowerShell® prompt returns as soon as the action has been initiated. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocked -Specifies that locked groups are ignored when running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource to bring online. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to bring online. -This can also be the name of a Cluster Shared Volume (CSV). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Stop-Cluster.md b/docset/winserver2012-ps/failoverclusters/Stop-Cluster.md deleted file mode 100644 index df0585a5a8..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Stop-Cluster.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-cluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-Cluster - -## SYNOPSIS -Stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-Cluster [-Cluster ] [-Force] [-InputObject ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-Cluster [[-Name] ] [-Cluster ] [-Force] -``` - -## DESCRIPTION -The **Stop-Cluster** cmdlet stops the Cluster service on all nodes in a failover cluster, which will stop all services and applications configured in the cluster. -A node can only function as part of the cluster when the Cluster service is running on that node. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Stop-Cluster -``` - -This example stops the Cluster service on all nodes in the local cluster, which will stop all services and applications configured in the cluster. - -### EXAMPLE 2 -``` -PS C:\>Stop-Cluster cluster1 -``` - -This example stops the Cluster service on all nodes in the cluster named cluster1, which will stop all services and applications configured in the cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster to stop. - -```yaml -Type: PSObject -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster to stop. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-Cluster](./Get-Cluster.md) - -[New-Cluster](./New-Cluster.md) - -[Remove-Cluster](./Remove-Cluster.md) - -[Start-Cluster](./Start-Cluster.md) - -[Test-Cluster](./Test-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Stop-ClusterGroup.md b/docset/winserver2012-ps/failoverclusters/Stop-ClusterGroup.md deleted file mode 100644 index 40e12a5f92..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Stop-ClusterGroup.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-clustergroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-ClusterGroup - -## SYNOPSIS -Stops one or more clustered roles, also known as resource groups, on a failover cluster. - -## SYNTAX - -``` -Stop-ClusterGroup [[-Name] ] [-Cluster ] [-IgnoreLocked] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Stop-ClusterGroup** cmdlet stops one or more clustered roles, also known as resource groups, on a failover cluster. - -If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly fashion by using this cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-ClusterGroup FileServer1 -Name OwnerNode State ----- --------- ----- -FileServer1 node1 Offline -``` - -This example stops the clustered role, or resource group, called FileServer1 on the local cluster. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocked -Specifies that locked groups are ignored when running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the clustered role to stop. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the clustered role to stop. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterGroup - -## NOTES - -## RELATED LINKS - -[Add-ClusterGroup](./Add-ClusterGroup.md) - -[Get-ClusterGroup](./Get-ClusterGroup.md) - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Remove-ClusterGroup](./Remove-ClusterGroup.md) - -[Start-ClusterGroup](./Start-ClusterGroup.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Stop-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Stop-ClusterNode.md deleted file mode 100644 index fc547421ab..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Stop-ClusterNode.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-ClusterNode - -## SYNOPSIS -Stops the Cluster service on a node in a failover cluster. - -## SYNTAX - -``` -Stop-ClusterNode [[-Name] ] [-Cluster ] [-InputObject ] [-Wait ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-ClusterNode** cmdlet stops the Cluster service on a node in a failover cluster. -If stopping the node brings the cluster below quorum, the operation is not permitted. -To stop the cluster, use the Stop-Cluster cmdlet instead. - -Note: This cmdlet cannot be run remotely without Credential Security Service Provider (CredSSP) authentication on the server computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Stop-ClusterNode -Name node3 -Name State ----- ----- -node3 Down -``` - -This example stops the Cluster service on the node named node3 of the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Stop-ClusterNode -Name node1 -Cluster cluster2 -Name State ----- ----- -node1 Down -``` - -This example stops the Cluster service on the node named node1 on the cluster named cluster2. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster node to stop. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node to stop. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - -[Resume-ClusterNode](./Resume-ClusterNode.md) - -[Start-ClusterNode](./Start-ClusterNode.md) - -[Stop-Cluster](./Stop-Cluster.md) - -[Suspend-ClusterNode](./Suspend-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Stop-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Stop-ClusterResource.md deleted file mode 100644 index 00e97d8040..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Stop-ClusterResource.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/stop-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-ClusterResource - -## SYNOPSIS -Takes a resource offline in a failover cluster. - -## SYNTAX - -``` -Stop-ClusterResource [[-Name] ] [-Cluster ] [-IgnoreLocked] [-InputObject ] - [-Wait ] -``` - -## DESCRIPTION -The **Stop-ClusterResource** cmdlet takes a resource offline in a failover cluster. -Before the resource is taken offline, any resources that depend on it are taken offline. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-ClusterResource "IP Address 172.24.11.0" -Name State Group ResourceType ----- ----- ----- ------------ -IP Address 172.2... Offline cluster1FS12 IP Address -``` - -This example takes the resource called IP Address 172.24.11.0 offline on the local cluster. -Before taking the resource offline, it takes offline any dependent resources. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreLocked -Specifies that locked groups are ignored when running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource to take offline. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource to take offline. -This can also be the name of a Cluster Shared Volume. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the **Wait** parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Suspend-ClusterResource](./Suspend-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Suspend-ClusterNode.md b/docset/winserver2012-ps/failoverclusters/Suspend-ClusterNode.md deleted file mode 100644 index 0dc9739e67..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Suspend-ClusterNode.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/suspend-clusternode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-ClusterNode - -## SYNOPSIS -Suspends activity on a failover cluster node, that is, pauses the node. - -## SYNTAX - -``` -Suspend-ClusterNode [[-Name] ] [[-TargetNode] ] [-Cluster ] [-Drain] - [-ForceEvacuation] [-InputObject ] [-Wait] -``` - -## DESCRIPTION -The **Suspend-ClusterNode** cmdlet suspends activity on a failover cluster node, that is, pauses the node. -If you use the *Drain* parameter, clustered roles currently running on the node will be drained before the node is paused. - -Pausing (suspending) a node is usually done when applying software updates to the node. -If you need to perform extensive diagnosis or maintenance on a cluster node, it might be more workable to stop (not pause) the Cluster service on that node. - -## EXAMPLES - -### Example 1: Pause a node of the local cluster -``` -PS C:\> Suspend-ClusterNode -Name "node1" -Name State ----- ----- -node1 Paused -``` - -This example pauses the node named node1 on the local cluster. - -### Example 2: Pause a node of a cluster -``` -PS C:\> Suspend-ClusterNode "node2" -Cluster "cluster2" -Name State ----- ----- -node2 Paused -``` - -This example pauses the node named node2 on the cluster named cluster2. - -### Example 3: Pause a node and move its workloads -``` -PS C:\> Suspend-ClusterNode -Name "node1" -Target "node2" -Drain -Name State ----- ----- -node1 Paused -``` - -This example pauses the node named node1 and moves the workloads from it to the node named node2. - -### Example 4: Preview a pause operation -``` -PS C:\> Suspend-ClusterNode node1 -Drain -WhatIf -What if: Performing operation "Suspend-ClusterNode" on Target "node1". -``` - -This example provides a preview of the operation that will be performed on the node named node1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Drain -Specifies that all of the workloads are gracefully moved to other nodes while maintaining the highest levels of availability and using the best placement logic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ForceEvacuation -Specifies that workloads are moved from a node even in the case of an error. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster node to suspend (with or without draining), or the cluster on which to run the cmdlet. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster node to suspend (with or without draining). - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetNode -Specifies a node to which to drain the workloads. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Wait -Specifies the time in seconds to wait for the cmdlet. -If the *Wait* parameter is not specified, then the cmdlet waits for completion. -If `-Wait 0` is specified, then the call is initiated and the cmdlet returns without waiting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterNode - -## NOTES - -## RELATED LINKS - -[Add-ClusterNode](./Add-ClusterNode.md) - -[Get-ClusterNode](./Get-ClusterNode.md) - -[Remove-ClusterNode](./Remove-ClusterNode.md) - -[Resume-ClusterNode](./Resume-ClusterNode.md) - -[Start-ClusterNode](./Start-ClusterNode.md) - -[Stop-ClusterNode](./Stop-ClusterNode.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Suspend-ClusterResource.md b/docset/winserver2012-ps/failoverclusters/Suspend-ClusterResource.md deleted file mode 100644 index 8f5792bc77..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Suspend-ClusterResource.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/suspend-clusterresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-ClusterResource - -## SYNOPSIS -Turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that you can run a disk maintenance tool without triggering failover. - -## SYNTAX - -``` -Suspend-ClusterResource [[-Name] ] [-Cluster ] [-Force] [-InputObject ] - [-RedirectedAccess] [-VolumeName ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Suspend-ClusterResource** cmdlet turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that a disk maintenance tool can be run without triggering failover. - -This cmdlet only applies to disks and CSVs. -For Cluster Shared Volumes, turning on maintenance takes dependent resources offline, which interrupts client access. -For other disks (LUNs) in cluster storage, turning on maintenance leaves dependent resources online. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Suspend-ClusterResource -Name "Cluster Disk 2" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 2 Online(Maintenance) Available Storage Physical Disk -``` - -This example turns on maintenance for CSV named Cluster Disk 2 so that you can run a disk maintenance tool without triggering failover. - -### EXAMPLE 2 -``` -PS C:\>Get-ClusterSharedVolume -Name "Cluster Disk 5" | Suspend-ClusterResource -Name State Node ----- ----- ---- -Cluster Disk 5 Online node2 -``` - -This example turns on maintenance for all volumes on the CSV named Cluster Disk 5. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Runs the cmdlet without prompting for confirmation. -By default the cmdlet will ask for confirmation from the user before proceeding. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource, a disk or CSV, to suspend. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource, a disk or CSV, to suspend. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RedirectedAccess -Causes CSV access to the storage device to be redirected over the network through another cluster node. -This parameter is only applicable to CSVs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeName -Specifies the name of the volume to suspend. -This parameter is only applicable to Cluster Shared Volumes (CSVs). -If this parameter is not specified, then the operation will be performed on all volumes on the CSV. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -### Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume - -## NOTES - -## RELATED LINKS - -[Add-ClusterResource](./Add-ClusterResource.md) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Move-ClusterResource](./Move-ClusterResource.md) - -[Remove-ClusterResource](./Remove-ClusterResource.md) - -[Resume-ClusterResource](./Resume-ClusterResource.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - -[Stop-ClusterResource](./Stop-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Test-Cluster.md b/docset/winserver2012-ps/failoverclusters/Test-Cluster.md deleted file mode 100644 index 392ea0a8c8..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Test-Cluster.md +++ /dev/null @@ -1,355 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/test-cluster?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-Cluster - -## SYNOPSIS -Runs validation tests for failover cluster hardware and settings. - -## SYNTAX - -``` -Test-Cluster [[-Node] ] [-Cluster ] [-Disk ] [-Force] - [-Ignore ] [-Include ] [-InputObject ] [-List] - [-Pool ] [-ReportName ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION - -The `Test-Cluster` cmdlet runs validation tests for failover cluster hardware and settings. Tests -can be run both before and after a cluster is set up. - -Test results are captured in a file with the file name that you specify. By running the validation -tests, you can confirm that your hardware and settings are compatible with Failover Clustering. -There are multiple types of tests, including Cluster, Inventory, Network, Storage, System, and other -types of tests. Storage tests will not test online disks or storage pools that are in use by a -clustered role. To test such disks, first run `Stop-ClusterGroup` to stop the clustered role, and -then run `Test-Cluster`. After the tests are done, start the clustered roles, also known as resource -groups, again. - -> [!NOTE] -> To perform some of the Cluster Shared Volume (CSV) validation tests, the `Test-Cluster` command -> creates a local user account named CliTest2 on each cluster node. The account is automatically -> removed from your system after the cluster validation tests are completed. - -## EXAMPLES - -### Example 1: Validate local cluster - -```powershell -Test-Cluster -``` - -This example runs all applicable cluster validation tests on the local cluster. - -### Example 2: Validate specified nodes - -```powershell -Test-Cluster -Node "node1", "node2" -``` - -This example runs all cluster validation tests on the nodes named node1 and node2. If either node1 -or node2 is already a member of a cluster, then the tests will include all nodes in that cluster. - -### Example 3: View tests and categories in cluster validation - -```powershell -Test-Cluster -List -``` - -This example lists the names of all tests and categories in cluster validation. Specify these test -names with **Ignore** or **Include** parameters to run specific tests. - -### Example 4: Validate specified nodes for storage - -```powershell -Test-Cluster -Node "node1", "node2" -Include "Storage" -``` - -This example runs the storage validation tests on the nodes named node1 and node2. If either node1 -or node2 is already a member of a cluster, then the tests will include all nodes in that cluster. - -### Example 5: Validate specified nodes for everything except inventory - -```powershell -Test-Cluster -Node "node1", "node2" -Ignore Inventory -``` - -This example runs all validation tests except the Inventory tests on the nodes named node1 and -node2. If either node1 or node2 is already a member of a cluster, then the tests will include all -nodes in that cluster. - -### Example 6: Run a specific test - -```powershell -Test-Cluster -Include "List Potential Cluster Disks" -``` - -This example runs the test called List Potential Cluster Disks on the local cluster. - -### Example 7: Run multiple tests - -```powershell -Test-Cluster -Include "List System Drivers","List Unsigned Drivers" -``` - -This example runs the tests called List System Drivers and List Unsigned Drivers on the local -cluster. - -## PARAMETERS - -### -Cluster - -Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is -`.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk - -Specifies the disk number or disks for which to run the cmdlet. If the specified disk is online and -is assigned to a clustered role or Cluster Shared Volume, you must also specify the **Force** -parameter to take the disk offline for the duration of the storage tests. Otherwise, the specified -disk must be offline before the cmdlet is run. If the **Disk** parameter is not specified, storage -tests run on all disks that are available for use in the cluster or that are in the cluster resource -offline or failed state. - -The acceptable values for this parameter are: - -- **Int32, Int64, Uint32, Uint64**. A number that represents a master boot record (MBR) signature of - the disk. -- **System.String**. A string that represents a master boot record (MBR) signature of the disk, - hexadecimal format is supported. -- **System.String**. A string that represents the GUID of a GPT disk. -- **ClusterResource**. A cluster resource object that represents a clustered disk. -- **CimInstance#MSFT_Disk**. An object returned from Get-Disk, from the Windows PowerShell storage - module. - -```yaml -Type: Object[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - -Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation -from the user before proceeding. When combined with the **Disk** or **Pool** parameters, the disks or -storage pool is taken offline for the duration of the storage tests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Ignore - -Specifies which tests or category of tests to ignore during the validation test run. All other -tests or category of tests will run. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Include - -Specifies which tests or category of tests to include during the validation test run. Only the tests -or category of tests specified here will run. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Specifies the cluster on which to run the validation tests. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -List - -Causes the cmdlet to list the tests and test categories. No tests will run on the servers or cluster -nodes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Node - -Specifies a comma-separated list of server names on which to run the cluster validation tests. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pool - -Specifies the clustered storage pool or pools for which to run the cmdlet. When the specified -storage pool is online and a virtual disk in the storage pool is assigned to a clustered role or -Cluster Shared Volume, you must also specify the **Force** parameter to take the storage pool -offline for the duration of the storage tests. Otherwise, command will exit with an error. The -specified storage pool must be taken offline before running the storage tests. If the **Pool** -parameter is not specified, storage tests run on all storage pools that are available for use in the -cluster or that are in the cluster resource offline or failed state. - -The acceptable values for this parameter are: - -- **System.String**: A string that represents the name of the clustered storage pool or pools. -- **ClusterResource**: A cluster resource object that represents a clustered storage pool. -- **CimInstance#MSFT_StoragePool**: An object returned from `Get-StoragePool`, from the Windows - PowerShell storage module. - -```yaml -Type: Object[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportName - -Specifies the name of the test report to generate. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf - -Shows what would happen if the cmdlet runs. The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.Cluster - -## OUTPUTS - -### System.IO.FileInfo - -### Microsoft.FailoverClusters.PowerShell.ClusterTestInfo - -## NOTES - -## RELATED LINKS - -[Get-Cluster](./Get-Cluster.md) - -[New-Cluster](./New-Cluster.md) - -[Remove-Cluster](./Remove-Cluster.md) - -[Start-Cluster](./Start-Cluster.md) - -[Stop-Cluster](./Stop-Cluster.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Test-ClusterResourceFailure.md b/docset/winserver2012-ps/failoverclusters/Test-ClusterResourceFailure.md deleted file mode 100644 index d44e4b0b57..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Test-ClusterResourceFailure.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/test-clusterresourcefailure?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-ClusterResourceFailure - -## SYNOPSIS -Simulates a failure of a cluster resource. - -## SYNTAX - -``` -Test-ClusterResourceFailure [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Test-ClusterResourceFailure** cmdlet simulates a failure of a cluster resource. - -Based on the failover and failback policies, when this cmdlet runs, the Cluster service moves the clustered role, or resource group, and attempts to bring the clustered resource online. -This cmdlet can be used to simulate what actions the Cluster service will take when a resource fails. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Test-ClusterResourceFailure -Name "Cluster Disk 4" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster Disk 4 Failed cluster12FS Physical Disk -``` - -This example simulates a failure in cluster resource named Cluster Disk 4. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster resource of which to simulate failure. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster resource of which to simulate failure. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Move-ClusterGroup](./Move-ClusterGroup.md) - -[Start-ClusterResource](./Start-ClusterResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Update-ClusterIPResource.md b/docset/winserver2012-ps/failoverclusters/Update-ClusterIPResource.md deleted file mode 100644 index 2ffdfd6032..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Update-ClusterIPResource.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/update-clusteripresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ClusterIPResource - -## SYNOPSIS -Renews or releases the DHCP lease for an IP address resource in a failover cluster. - -## SYNTAX - -``` -Update-ClusterIPResource [[-Name] ] [-Cluster ] [-InputObject ] [-Release] [-Renew] -``` - -## DESCRIPTION -The **Update-ClusterIPResource** cmdlet renews or releases the DHCP lease for an IP address resource in a failover cluster. -This cmdlet applies only to IP address resources that use DHCP. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Update-ClusterIPResource -Name "Cluster IP Address" -Name State Group ResourceType ----- ----- ----- ------------ -Cluster IP Address Online Cluster Group IP Address -``` - -This example updates the DHCP lease for the resource called Cluster IP Address if this resource is DHCP assigned. - -### Example 2 -``` -PS C:\>Get-ClusterResource | Where-Object -FilterScript {$_.ResourceType.Name -eq "IP Address"} | Update-ClusterIPResource -Name State Group ResourceType ----- ----- ----- ------------ -Cluster IP Address Online Cluster Group IP Address -IP Address 172.2... Online cluster1-Other IP Address -IP Address 172.2... Online cluster1-FS IP Address -``` - -This example updates the DHCP lease for all of the clustered IP resources that are DHCP assigned. - -### Example 3 -``` -PS C:\>Get-ClusterResource -Name "IP Address 172.24.11.0" | Stop-ClusterResource | Update-ClusterIPResource -Release -Name State Group ResourceType ----- ----- ----- ------------ -IP Address 172.2... Offline cluster1-Other IP Address -``` - -This example takes the resource named IP Address 172.24.11.0 offline, and releases the DHCP lease for that resource. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the cluster IP address resource to update. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the cluster IP address resource to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Release -Causes the cmdlet to release the DHCP lease of the IP address resource. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Renew -Causes the cmdlet to renew the DHCP lease of the IP address resource. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/?LinkID=113423) - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Update-ClusterNetworkNameResource](./Update-ClusterNetworkNameResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Update-ClusterNetworkNameResource.md b/docset/winserver2012-ps/failoverclusters/Update-ClusterNetworkNameResource.md deleted file mode 100644 index 20488df0e9..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Update-ClusterNetworkNameResource.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/update-clusternetworknameresource?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ClusterNetworkNameResource - -## SYNOPSIS -Registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability. - -## SYNTAX - -``` -Update-ClusterNetworkNameResource [[-Name] ] [-Cluster ] [-InputObject ] -``` - -## DESCRIPTION -The **Update-ClusterNetworkNameResource** cmdlet registers existing Network Name resources with a DNS server in a way that does not interrupt cluster availability. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-ClusterResource "Cluster Name" | Update-ClusterNetworkNameResource -Name State OwnerGroup ResourceType ----- ----- ---------- ------------ -Cluster Name Online Cluster Group Network Name -``` - -This example registers the Network Name resources of the local cluster with a DNS server. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the network name resource to register with the DNS server. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the network name to be registered with the DNS server. - -```yaml -Type: StringCollection -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Get-ClusterResource](./Get-ClusterResource.md) - -[Update-ClusterIPResource](./Update-ClusterIPResource.md) - diff --git a/docset/winserver2012-ps/failoverclusters/Update-ClusterVirtualMachineConfiguration.md b/docset/winserver2012-ps/failoverclusters/Update-ClusterVirtualMachineConfiguration.md deleted file mode 100644 index 95819ef10e..0000000000 --- a/docset/winserver2012-ps/failoverclusters/Update-ClusterVirtualMachineConfiguration.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Failoverv2_Cmdlets.xml -Module Name: FailoverClusters -online version: https://learn.microsoft.com/powershell/module/failoverclusters/update-clustervirtualmachineconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-ClusterVirtualMachineConfiguration - -## SYNOPSIS -Refreshes the configuration of a clustered virtual machine within a failover cluster. - -## SYNTAX - -``` -Update-ClusterVirtualMachineConfiguration [[-Name] ] [-Cluster ] [-InputObject ] - [-VMId ] -``` - -## DESCRIPTION -The **Update-ClusterVirtualMachineConfiguration** cmdlet refreshes the configuration of a clustered virtual machine within a failover cluster. -Use this cmdlet if a hardware device, such as a network adapter, is to be added or removed or the hardware configuration settings, such as the setting for virtual memory, are being changed for a clustered virtual machine. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Update-ClusterVirtualMachineConfiguration -Name "Virtual Machine Configuration VM1" -Name State Group ResourceType ----- ----- ----- ------------ -Virtual Machine ... Online Virtual Machine Virtual Machine ... -``` - -This example refreshes the clustered virtual machine named Virtual Machine Configuration VM1 on the local cluster. - -### EXAMPLE 2 -``` -PS C:\>Update-ClusterVirtualMachineConfiguration -Name "Virtual Machine Configuration VM2" -Cluster cluster1 -Name State Group ResourceType ----- ----- ----- ------------ -Virtual Machine ... Online Virtual Machine Virtual Machine -``` - -This example refreshes the clustered virtual machine named Virtual Machine Configuration VM2 on the cluster named cluster1. - -## PARAMETERS - -### -Cluster -Specifies the name of the cluster on which to run this cmdlet. -If the input for this parameter is `.` or it is omitted, then the cmdlet runs on the local cluster. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the clustered virtual machine resource to update. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the clustered virtual machine resource to update. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMId -Specifies the virtual machine identifier (ID). - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## OUTPUTS - -### Microsoft.FailoverClusters.PowerShell.ClusterResource - -## NOTES - -## RELATED LINKS - -[Add-ClusterVirtualMachineRole](./Add-ClusterVirtualMachineRole.md) - -[Move-ClusterVirtualMachineRole](./Move-ClusterVirtualMachineRole.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/FileServerResourceManager.md b/docset/winserver2012-ps/fileserverresourcemanager/FileServerResourceManager.md deleted file mode 100644 index 3acbf4a10b..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/FileServerResourceManager.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: faa199b6-c378-4aad-9d4d-f0e99f3f4845 -Module Name: FileServerResourceManager ---- - -# FileServerResourceManager Module -## Description -This reference provides cmdlet descriptions and syntax for all File Server Resource Manager (FSRM) cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## FileServerResourceManager Cmdlets -### [Get-FsrmAdrSetting](./Get-FsrmAdrSetting.md) -Gets access denied remediation settings for events. - -### [Get-FsrmAutoQuota](./Get-FsrmAutoQuota.md) -Gets auto apply quotas on a server. - -### [Get-FsrmClassification](./Get-FsrmClassification.md) -Gets the status of the running file classification. - -### [Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) -Gets definitions of classification properties. - -### [Get-FsrmClassificationRule](./Get-FsrmClassificationRule.md) -Gets classification rules. - -### [Get-FsrmEffectiveNamespace](./Get-FsrmEffectiveNamespace.md) -Gets a list of paths that match static namespaces. - -### [Get-FsrmFileGroup](./Get-FsrmFileGroup.md) -Gets file groups. - -### [Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) -Gets file management jobs. - -### [Get-FsrmFileScreen](./Get-FsrmFileScreen.md) -Gets file screens. - -### [Get-FsrmFileScreenException](./Get-FsrmFileScreenException.md) -Gets file screen exceptions. - -### [Get-FsrmFileScreenTemplate](./Get-FsrmFileScreenTemplate.md) -Gets file screen templates. - -### [Get-FsrmMacro](./Get-FsrmMacro.md) -Gets FSRM-supported macros. - -### [Get-FsrmMgmtProperty](./Get-FsrmMgmtProperty.md) -Gets management properties. - -### [Get-FsrmQuota](./Get-FsrmQuota.md) -Gets FSRM quotas on the server. - -### [Get-FsrmQuotaTemplate](./Get-FsrmQuotaTemplate.md) -Gets FSRM quota templates - -### [Get-FsrmRmsTemplate](./Get-FsrmRmsTemplate.md) -Gets a list of all RMS templates on the server. - -### [Get-FsrmSetting](./Get-FsrmSetting.md) -Gets the current FSRM settings. - -### [Get-FsrmStorageReport](./Get-FsrmStorageReport.md) -Gets storage reports. - -### [New-FsrmAction](./New-FsrmAction.md) -Returns an FSRM action object. - -### [New-FsrmAutoQuota](./New-FsrmAutoQuota.md) -Creates an auto apply quota. - -### [New-FsrmClassificationPropertyDefinition](./New-FsrmClassificationPropertyDefinition.md) -Creates a classification property definition. - -### [New-FsrmClassificationPropertyValue](./New-FsrmClassificationPropertyValue.md) -Creates a classification property value. - -### [New-FsrmClassificationRule](./New-FsrmClassificationRule.md) -Creates an automatic classification rule. - -### [New-FsrmFileGroup](./New-FsrmFileGroup.md) -Creates a file group. - -### [New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) -Creates a file management job. - -### [New-FsrmFileScreen](./New-FsrmFileScreen.md) -Creates a file screen. - -### [New-FsrmFileScreenException](./New-FsrmFileScreenException.md) -Creates a file screen exception. - -### [New-FsrmFileScreenTemplate](./New-FsrmFileScreenTemplate.md) -Creates a file screen template. - -### [New-FsrmFmjAction](./New-FsrmFmjAction.md) -Returns an action object for file management jobs. - -### [New-FsrmFmjCondition](./New-FsrmFmjCondition.md) -Creates a file management property condition object. - -### [New-FsrmFMJNotification](./New-FsrmFMJNotification.md) -Returns a notification object for file management jobs. - -### [New-FsrmFmjNotificationAction](./New-FsrmFmjNotificationAction.md) -Returns a notification action object for file management jobs. - -### [New-FsrmQuota](./New-FsrmQuota.md) -Creates a FSRM quota. - -### [New-FsrmQuotaTemplate](./New-FsrmQuotaTemplate.md) -Creates a quota template. - -### [New-FsrmQuotaThreshold](./New-FsrmQuotaThreshold.md) -Returns a quota threshold object. - -### [New-FsrmScheduledTask](./New-FsrmScheduledTask.md) -Creates a scheduled task object. - -### [New-FsrmStorageReport](./New-FsrmStorageReport.md) -Creates a storage report on the server. - -### [Remove-FsrmAutoQuota](./Remove-FsrmAutoQuota.md) -Removes an auto apply quota from a server. - -### [Remove-FsrmClassificationPropertyDefinition](./Remove-FsrmClassificationPropertyDefinition.md) -Removes classification property definitions. - -### [Remove-FsrmClassificationRule](./Remove-FsrmClassificationRule.md) -Removes classification rules. - -### [Remove-FsrmFileGroup](./Remove-FsrmFileGroup.md) -Removes file groups from the server. - -### [Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) -Removes file management jobs. - -### [Remove-FsrmFileScreen](./Remove-FsrmFileScreen.md) -Removes a file screen. - -### [Remove-FsrmFileScreenException](./Remove-FsrmFileScreenException.md) -Removes a file screen exception. - -### [Remove-FsrmFileScreenTemplate](./Remove-FsrmFileScreenTemplate.md) -Removes file screen templates. - -### [Remove-FsrmMgmtProperty](./Remove-FsrmMgmtProperty.md) -Removes a management property. - -### [Remove-FsrmQuota](./Remove-FsrmQuota.md) -Removes a FSRM quota from the server. - -### [Remove-FsrmQuotaTemplate](./Remove-FsrmQuotaTemplate.md) -Removes FSRM quota templates. - -### [Remove-FsrmStorageReport](./Remove-FsrmStorageReport.md) -Removes storage reports. - -### [Reset-FsrmFileScreen](./Reset-FsrmFileScreen.md) -Resets the default settings for all file screen parameters. - -### [Reset-FsrmQuota](./Reset-FsrmQuota.md) -Updates configuration settings of a FSRM quota. - -### [Send-FsrmTestEmail](./Send-FsrmTestEmail.md) -Sends a test email message. - -### [Set-FsrmAdrSetting](./Set-FsrmAdrSetting.md) -Changes configuration settings for access denied remediation. - -### [Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) -Changes configuration settings of an auto apply quota. - -### [Set-FsrmClassification](./Set-FsrmClassification.md) -Changes configuration settings for classification. - -### [Set-FsrmClassificationPropertyDefinition](./Set-FsrmClassificationPropertyDefinition.md) -Changes a classification property definition. - -### [Set-FsrmClassificationRule](./Set-FsrmClassificationRule.md) -Changes configuration settings of classification rules. - -### [Set-FsrmFileGroup](./Set-FsrmFileGroup.md) -Changes configuration settings for file groups. - -### [Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) -Changes configuration settings of a file management job. - -### [Set-FsrmFileScreen](./Set-FsrmFileScreen.md) -Changes configuration settings of a file screen. - -### [Set-FsrmFileScreenException](./Set-FsrmFileScreenException.md) -Changes configuration settings of a file screen exception. - -### [Set-FsrmFileScreenTemplate](./Set-FsrmFileScreenTemplate.md) -Changes configuration settings of a file screen template. - -### [Set-FsrmMgmtProperty](./Set-FsrmMgmtProperty.md) -Changes the setting of a management property. - -### [Set-FsrmQuota](./Set-FsrmQuota.md) -Changes configuration settings for a FSRM quota. - -### [Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) -Changes configuration settings for FSRM quota templates. - -### [Set-FsrmSetting](./Set-FsrmSetting.md) -Changes global FSRM settings for the computer. - -### [Set-FsrmStorageReport](./Set-FsrmStorageReport.md) -Changes settings of a storage report. - -### [Start-FsrmClassification](./Start-FsrmClassification.md) -Starts the classification process. - -### [Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) -Starts a file management job. - -### [Start-FsrmStorageReport](./Start-FsrmStorageReport.md) -Starts generating storage reports. - -### [Stop-FsrmClassification](./Stop-FsrmClassification.md) -Stops the running instance of a classification. - -### [Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) -Stops the running instance of a file management job. - -### [Stop-FsrmStorageReport](./Stop-FsrmStorageReport.md) -Stops the running instance of storage reports. - -### [Update-FsrmAutoQuota](./Update-FsrmAutoQuota.md) -Updates the properties of an auto apply quota. - -### [Update-FsrmClassificationPropertyDefinition](./Update-FsrmClassificationPropertyDefinition.md) -Updates the classification property definitions. - -### [Update-FsrmQuota](./Update-FsrmQuota.md) -Starts a quota scan on a path. - -### [Wait-FsrmClassification](./Wait-FsrmClassification.md) -Waits for a period of time or until classification is finished running. - -### [Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) -Waits for file management jobs to finish running. - -### [Wait-FsrmStorageReport](./Wait-FsrmStorageReport.md) -Waits for a period of time or until storage reports is finished running. - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmAdrSetting.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmAdrSetting.md deleted file mode 100644 index 1ac305474f..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmAdrSetting.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmadrsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmAdrSetting - -## SYNOPSIS -Gets access denied remediation settings for events. - -## SYNTAX - -``` -Get-FsrmAdrSetting [[-Event] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmAdrSetting** cmdlet gets access denied remediation (ADR) settings in File Server Resource Manager (FSRM) for one or more events. - -Windows Server® 2012 uses the ADR settings when a client cannot access a file. -Users get an access-denied message when they try to access shared files and folders on a file server for which they do not have permissions. - -## EXAMPLES - -### Example 1: Get FSRM access denied settings -``` -PS C:\>Get-FsrmAdrSetting -Event AccessDenied -``` - -This command gets all access denied settings in FSRM. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Event -Specifies an array of types of events that ADR handles. -The acceptable values for this parameter are: AccessDenied and FileNotFound. - -```yaml -Type: FsrmAdrEventEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMADRSettings - -## NOTES - -## RELATED LINKS - -[Set-FsrmAdrSetting](./Set-FsrmAdrSetting.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmAutoQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmAutoQuota.md deleted file mode 100644 index e187e33953..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmAutoQuota.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmautoquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmAutoQuota - -## SYNOPSIS -Gets auto apply quotas on a server. - -## SYNTAX - -``` -Get-FsrmAutoQuota [[-Path] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmAutoQuota** cmdlet gets an auto apply quota or all auto apply quota on a volume or folder. -An auto apply quota is a quota template that you assign to a parent volume or folder. - -## EXAMPLES - -### Example 1: Get all auto apply quotas -``` -PS C:\>Get-FsrmAutoQuota -``` - -This command gets all the auto apply quotas on the local server. - -### Example 2: Get auto apply quotas by using a path -``` -PS C:\>Get-FsrmAutoQuota -Path "C:\Share01\..." -``` - -This command gets all the auto apply quotas in C:\ Share01 plus all the auto apply quotas in all subfolders of C:\Share01. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -This parameter supports recursive and wildcard paths. -To specify a recursive path, add \... -to a path. -For example, C:\ Share01\... -indicates all the auto apply quotas in C:\ Share1 plus all the auto apply quotas in any and all subfolders of C:\ Share01.To specify a wildcard in a path, you can add the asterisk (*) and the question mark (?) to a path. -For example, C:\ Share01\*A indicates all the auto apply quotas in C:\ Share01 plus all the auto apply quotas in subfolders of C:\ Share01 that have a name that begins with the letter A. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) - -[New-FsrmAutoQuota](./New-FsrmAutoQuota.md) - -[Update-FsrmAutoQuota](./Update-FsrmAutoQuota.md) - -[Remove-FsrmAutoQuota](./Remove-FsrmAutoQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassification.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassification.md deleted file mode 100644 index 5996abc630..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassification.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmclassification?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmClassification - -## SYNOPSIS -Gets the status of the running file classification. - -## SYNTAX - -``` -Get-FsrmClassification [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmClassification** cmdlet gets the status of the file classification process that the server is currently running. -This cmdlet returns a status value of Unknown, NotRunning, Queued, or Running. - -## EXAMPLES - -### Example 1: Get the status of the running classification -``` -PS C:\>Get-FsrmClassification -``` - -This command gets the status of the classification that the server is currently running. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassification - -## NOTES - -## RELATED LINKS - -[Set-FsrmClassification](./Set-FsrmClassification.md) - -[Stop-FsrmClassification](./Stop-FsrmClassification.md) - -[Start-FsrmClassification](./Start-FsrmClassification.md) - -[Stop-FsrmClassification](./Stop-FsrmClassification.md) - -[Wait-FsrmClassification](./Wait-FsrmClassification.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassificationPropertyDefinition.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassificationPropertyDefinition.md deleted file mode 100644 index ae48c72600..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassificationPropertyDefinition.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmclassificationpropertydefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmClassificationPropertyDefinition - -## SYNOPSIS -Gets definitions of classification properties. - -## SYNTAX - -``` -Get-FsrmClassificationPropertyDefinition [[-Name] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmClassificationPropertyDefinition** cmdlet gets one or more definitions of classification properties. -The server uses classification properties to assign values to files. - -This cmdlet automatically attempts, up to once an hour, to get any updated property definitions for Active Directory Domain Service (AD DS). -You can use the Update-FsrmClassificationPropertyDefinition cmdlet to force the server to update the property definitions more often. - -## EXAMPLES - -### Example 1: Get all classification property definitions -``` -PS C:\>Get-FsrmClassificationPropertyDefinition -``` - -This command gets all classification property definitions on the server. - -### Example 2: Get a classification property definition by using a name -``` -PS C:\>Get-FsrmClassificationPropertyDefinition -Name "PII_MS" -``` - -This command gets the classification property definition named "PII_MS". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of property definitions. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationPropertyDefinition - -## NOTES - -## RELATED LINKS - -[Set-FsrmClassificationPropertyDefinition](./Set-FsrmClassificationPropertyDefinition.md) - -[New-FsrmClassificationPropertyDefinition](./New-FsrmClassificationPropertyDefinition.md) - -[Update-FsrmClassificationPropertyDefinition](./Update-FsrmClassificationPropertyDefinition.md) - -[Remove-FsrmClassificationPropertyDefinition](./Remove-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassificationRule.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassificationRule.md deleted file mode 100644 index 6affee42a9..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmClassificationRule.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmclassificationrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmClassificationRule - -## SYNOPSIS -Gets classification rules. - -## SYNTAX - -``` -Get-FsrmClassificationRule [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmClassificationRule** cmdlet gets classification rules. -If you do not specify the **Name** parameter, the cmdlet gets all classification rules on the server. - -## EXAMPLES - -### Example 1: Get all classification rules -``` -PS C:\>Get-FsrmClassificationRule -``` - -This command gets all classification rules on the server. - -### Example 2: Get a classification rule by using a name -``` -PS C:\>Get-FsrmClassificationRule "Find confidential files" -``` - -This command gets the classification rule named Find confidential files. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of classification rules. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-FsrmClassificationRule](./Set-FsrmClassificationRule.md) - -[New-FsrmClassificationRule](./New-FsrmClassificationRule.md) - -[Remove-FsrmClassificationRule](./Remove-FsrmClassificationRule.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmEffectiveNamespace.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmEffectiveNamespace.md deleted file mode 100644 index eeccff3e1e..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmEffectiveNamespace.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmeffectivenamespace?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmEffectiveNamespace - -## SYNOPSIS -Gets a list of paths that match static namespaces. - -## SYNTAX - -``` -Get-FsrmEffectiveNamespace [-AsJob] [-CimSession ] [-ThrottleLimit ] -Namespace - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Get-FsrmEffectiveNamespace** cmdlet gets a list of paths that match the static namespaces in the input list and any namespaces that have a Folder Usage property set that have a value in the input list. - -## EXAMPLES - -### Example 1: Gets paths that match static namespaces -``` -PS C:\>Get-FsrmEffectiveNameSpace -Namespace @("c:\data","[Folder Usage=User Data]") -``` - -This command gets a list of paths that have their Folder Usage property set to User Data and C:\data. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Namespace -Specifies an array of namespaces. - -Each string must be either a value of the FolderType property on the server, the string "All Shares", or a static path. -The FolderType properties must be in the format \[\=\\]. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileGroup.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileGroup.md deleted file mode 100644 index d75e8cceae..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileGroup.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmfilegroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmFileGroup - -## SYNOPSIS -Gets file groups. - -## SYNTAX - -``` -Get-FsrmFileGroup [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmFileGroup** cmdlet gets a file group or all file groups on the server. -A file group is a group of files that are based on one or more file name patterns. - -## EXAMPLES - -### Example 1: Get all file groups -``` -PS C:\>Get-FsrmFileGroup -``` - -This command gets all files groups on the server. - -### Example 2: Get a file group by using a name -``` -PS C:\>Get-FsrmFileGroup -Name "Image Files" -``` - -This command gets the files group named "Image Files". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file groups. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileGroup - -## NOTES - -## RELATED LINKS - -[Set-FsrmFileGroup](./Set-FsrmFileGroup.md) - -[New-FsrmFileGroup](./New-FsrmFileGroup.md) - -[Remove-FsrmFileGroup](./Remove-FsrmFileGroup.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileManagementJob.md deleted file mode 100644 index 972a291ad0..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileManagementJob.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmFileManagementJob - -## SYNOPSIS -Gets file management jobs. - -## SYNTAX - -``` -Get-FsrmFileManagementJob [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmFileManagementJob** cmdlet gets a file management job or all file management jobs on the server. - -## EXAMPLES - -### Example 1: Get a file management job -``` -PS C:\>Get-FsrmFileManagementJob -``` - -This command gets all the file management jobs on the server. - -### Example 2: Get a file management job by using a name -``` -PS C:\>Get-FsrmFileManagementJob -Name "Encrypt sensitive files" -``` - -This command gets the file management job named Encrypt sensitive files. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file management jobs. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob - -## NOTES - -## RELATED LINKS - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) - -[Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) - -[Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) - -[Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreen.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreen.md deleted file mode 100644 index aaca1de909..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreen.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmfilescreen?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmFileScreen - -## SYNOPSIS -Gets file screens. - -## SYNTAX - -``` -Get-FsrmFileScreen [[-Path] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmFileScreen** cmdlet gets a file screen or all file screens on the server. - -## EXAMPLES - -### Example 1: Get all file screens -``` -PS C:\>Get-FsrmFileScreen -``` - -This command gets all file screens on the server. - -### Example 2: Get a file screen by using a path -``` -PS C:\>Get-FsrmFileScreen -Path "C:\Shares\CtrShare03" -``` - -This command gets the file screen in the path C:\Shares\CtrShare03. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreen - -## NOTES - -## RELATED LINKS - -[Set-FsrmFileScreen](./Set-FsrmFileScreen.md) - -[New-FsrmFileScreen](./New-FsrmFileScreen.md) - -[Remove-FsrmFileScreen](./Remove-FsrmFileScreen.md) - -[Reset-FsrmFileScreen](./Reset-FsrmFileScreen.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreenException.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreenException.md deleted file mode 100644 index 700e579d65..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreenException.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmfilescreenexception?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmFileScreenException - -## SYNOPSIS -Gets file screen exceptions. - -## SYNTAX - -``` -Get-FsrmFileScreenException [[-Path] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmFileScreenException** cmdlet gets a file screen exception or all file screen exceptions on the server. - -## EXAMPLES - -### Example 1: Get all file screen exceptions -``` -PS C:\>Get-FsrmFileScreenException -``` - -This command returns all file screen exceptions defined on the server. - -### Example 2: Get file screen exceptions by using a path -``` -PS C:\>Get-FsrmFileScreenException Path "C:\Shares\CtrShare03" -``` - -This command returns the file screen exception on the path C:\Shares\CtrShare03. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder that is associated with a file screen exception. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenException - -## NOTES - -## RELATED LINKS - -[Set-FsrmFileScreenException](./Set-FsrmFileScreenException.md) - -[New-FsrmFileScreenException](./New-FsrmFileScreenException.md) - -[Remove-FsrmFileScreenException](./Remove-FsrmFileScreenException.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreenTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreenTemplate.md deleted file mode 100644 index f388973dc5..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmFileScreenTemplate.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmfilescreentemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmFileScreenTemplate - -## SYNOPSIS -Gets file screen templates. - -## SYNTAX - -``` -Get-FsrmFileScreenTemplate [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmFileScreenTemplate** cmdlet gets one or more file screen templates. - -## EXAMPLES - -### Example 1: Get all file screen templates -``` -PS C:\>Get-FsrmFileScreenTemplate -``` - -This command gets all file screen templates on the server. - -### Example 2: Get a file screen template by using a name -``` -PS C:\>Get-FsrmFileScreenTemplate -Name "Block media files" -``` - -This command gets the file screen template named "Block media files". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file screen templates. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenTemplate - -## NOTES - -## RELATED LINKS - -[Set-FsrmFileScreenTemplate](./Set-FsrmFileScreenTemplate.md) - -[New-FsrmFileScreenTemplate](./New-FsrmFileScreenTemplate.md) - -[Remove-FsrmFileScreenTemplate](./Remove-FsrmFileScreenTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmMacro.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmMacro.md deleted file mode 100644 index 6d0eb881e9..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmMacro.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmmacro?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmMacro - -## SYNOPSIS -Gets FSRM-supported macros. - -## SYNTAX - -``` -Get-FsrmMacro [-AsJob] [-CimSession ] [-Name ] [-ThrottleLimit ] - [-Type ] -``` - -## DESCRIPTION -The **Get-FsrmMacro** cmdlet gets one or more macros that File Server Resource Manager (FSRM) supports for configuration options. -This cmdlet gets the FSRM-supported macros for the FSRM object that you specify in the **Type** parameter. - -## EXAMPLES - -### Example 1: Get FSRM-supported macros for quotas -``` -PS C:\>Get-FsrmMacro -Type Quota -``` - -This command gets all the FSRM-supported macros for quotas. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of macro names. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies an array of FSRM object types. -The acceptable values for this parameter are: -- Quota -- FileScreen -- FileManagementJob -- ADR - -```yaml -Type: FsrmMacroTypeEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMMacro - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuota](./Get-FsrmQuota.md) - -[Get-FsrmFileScreen](./Get-FsrmFileScreen.md) - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[Get-FsrmAdrSetting](./Get-FsrmAdrSetting.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmMgmtProperty.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmMgmtProperty.md deleted file mode 100644 index 9543a0e834..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmMgmtProperty.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmmgmtproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmMgmtProperty - -## SYNOPSIS -Gets management properties. - -## SYNTAX - -``` -Get-FsrmMgmtProperty [-AsJob] [-CimSession ] [-Effective] [-Name ] [-Namespace ] - [-Recurse] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Get-FsrmMgmtProperty** cmdlet gets File Server Resource Manager (FSRM) management properties for a namespace. -A management property is a classification property that includes Folder in its AppliesTo property and whose Flags property does not include the Secure value. -You can use the Get-FsrmClassificationPropertyDefinition cmdlet to get definitions of classification properties. - -## EXAMPLES - -### Example 1: Get all management properties -``` -PS C:\>Get-FsrmMgmtProperty -``` - -This command gets all management properties for the server. - -### Example 2: Get management properties by using a namespace -``` -PS C:\>Get-FsrmMgmtProperty -Namespace "C:\Shares" -``` - -This command gets the Folder Usage property for the folder C:\Shares. - -### Example 3: Get management properties by using a name -``` -PS C:\>Get-FsrmMgmtProperty -Namespace "C:\Shares" -Name "FolderUsage_MS" -``` - -This command gets the Folder Usage property for the management property named "FolderUsage_MS" in the folder C:\Shares. - -### Example 4: Get management properties for all folders in a path -``` -PS C:\>Get-FsrmMgmtProperty -Namespace "C:\Shares" -Recurse -``` - -This command gets management properties for C:\Shares and for all folders within the path. - -### Example 5: Get the nearest management properties by using a name -``` -PS C:\>Get-FsrmMgmtProperty -Namespace "C:\Shares\CtrShares03" -Name "FolderUsage_MS" -Effective -``` - -This command gets the FolderUsage property value on C:\Shares\CtrShares03. -If the folder usage management property named "FolderUsage_MS" is not set on C:\Shares\CtrShares03, the cmdlet searches up through the namespace (C:\shares, C:\\) and finds the first occurrence of the management property. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Effective -Indicates that the cmdlet gets the management property for the nearest folder that has the name that you specify. -The cmdlet finds the nearest management property based on the namespace that you specify or the parent hierarchy. -If you specify this parameter, you must specify the **Name** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a management property. -Specify the value of the Name property in a **FsrmClassificationPropertyDefinition** object. -If you do not specify this parameter, the cmdlet gets all management properties on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies a local path to a folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that this cmdlet gets management properties for all folders that contain management properties in the namespace. -If you specify this parameter, you must specify the **Namespace** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMMgmtProperty - -## NOTES - -## RELATED LINKS - -[Set-FsrmMgmtProperty](./Set-FsrmMgmtProperty.md) - -[Remove-FsrmMgmtProperty](./Remove-FsrmMgmtProperty.md) - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmQuota.md deleted file mode 100644 index 70ec831f39..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmQuota.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmQuota - -## SYNOPSIS -Gets FSRM quotas on the server. - -## SYNTAX - -``` -Get-FsrmQuota [[-Path] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmQuota** cmdlet gets a File Server Resource Manager (FSRM) quota or all FSRM quotas on the server. - -## EXAMPLES - -### Example 1: Get all quotas -``` -PS C:\>Get-FsrmQuotaTemplate -``` - -This command gets all quotas on the server. - -### Example 2: Get quotas by using a path -``` -PS C:\>Get-FsrmQuotaTemplate -Path "C:\Shares\..." -``` - -This command gets all of the quotas in C:\Share01 plus all of the quotas in all subfolders of C:\Share01. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the local folder that contains the quota. - -This parameter supports recursive and wildcard paths. -To specify a recursive path, add \... -to a path. -For example, C:\ Share01\... -indicates all of the quotas in C:\ Share1 plus all the quotas in any and all subfolders of C:\ Share01. -To specify a wildcard in a path, you can add the asterisk (*) and the question mark (?) to a path. -For example, C:\ Share01\*A indicates all of the quotas in C:\ Share01 plus all the quotas in subfolders of C:\ Share01 that have a name that begins with the letter A. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuota - -## NOTES - -## RELATED LINKS - -[Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) - -[New-FsrmQuotaTemplate](./New-FsrmQuotaTemplate.md) - -[Remove-FsrmQuotaTemplate](./Remove-FsrmQuotaTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmQuotaTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmQuotaTemplate.md deleted file mode 100644 index 3213fbab83..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmQuotaTemplate.md +++ /dev/null @@ -1,119 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmquotatemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmQuotaTemplate - -## SYNOPSIS -Gets FSRM quota templates - -## SYNTAX - -``` -Get-FsrmQuotaTemplate [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmQuotaTemplate** cmdlet gets one or more File Server Resource Manager (FSRM) quota templates on the server. - -## EXAMPLES - -### Example 1: Get all quota templates -``` -PS C:\>Get-FsrmQuotaTemplate -``` - -This command gets all quota templates on the server. - -### Example 1: Get a quota template by using a name -``` -PS C:\>Get-FsrmQuotaTemplate -Name "128MB limit" -``` - -This command gets the quota templates named "128MB limit". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of quota templates. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuotaTemplate - -## NOTES - -## RELATED LINKS - -[Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) - -[New-FsrmQuotaTemplate](./New-FsrmQuotaTemplate.md) - -[Remove-FsrmQuotaTemplate](./Remove-FsrmQuotaTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmRmsTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmRmsTemplate.md deleted file mode 100644 index d273e04e99..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmRmsTemplate.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmrmstemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmRmsTemplate - -## SYNOPSIS -Gets a list of all RMS templates on the server. - -## SYNTAX - -``` -Get-FsrmRmsTemplate [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Get-FsrmRmsTemplate** cmdlet gets a list of all Rights Management Services (RMS) templates that are available on the server. - -## EXAMPLES - -### Example 1: Gets a list of all RMS templates -``` -PS C:\>Get-FsrmRmsTemplate -``` - -This command gets a list of all RMS templates that are available on the server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### string[] - -## NOTES - -## RELATED LINKS - -[New-FsrmFmjAction](./New-FsrmFmjAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmSetting.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmSetting.md deleted file mode 100644 index c7807d075d..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmSetting.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmSetting - -## SYNOPSIS -Gets the current FSRM settings. - -## SYNTAX - -``` -Get-FsrmSetting [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmSetting** cmdlet retrieves the current FSRM settings. -You can use the Set-FsrmSetting cmdlet to change FSRM settings. - -## EXAMPLES - -### Example 1: Get FSRM settings -``` -PS C:\>Get-FsrmSetting -``` - -This command gets the current FSRM settings. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMSettings - -## NOTES - -## RELATED LINKS - -[Set-FsrmSetting](./Set-FsrmSetting.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmStorageReport.md deleted file mode 100644 index 59ea671b42..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Get-FsrmStorageReport.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/get-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-FsrmStorageReport - -## SYNOPSIS -Gets storage reports. - -## SYNTAX - -``` -Get-FsrmStorageReport [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-FsrmStorageReport** cmdlet gets one or more storage reports on the server. -This cmdlet gets all types of storage reports: scheduled, interactive, and incident reports. -If you do not specify the **Name** parameter, this cmdlet gets all storage reports on the server. - -The object that this cmdlet returns does not include a property to indicate if a report is interactive. -Use the Schedule property to determine if a report is interactive or is launched by an event incident, such as a quota event. -If the Schedule property has a value, the report is scheduled. -If the schedule property is null, the report is interactive or generated by an event. - -## EXAMPLES - -### Example 1: Get all storage reports. -``` -PS C:\>Get-FsrmStorageReport -``` - -This command gets all storage reports on the server. - -### Example 2: Get a storage report by using a name -``` -PS C:\>Get-FsrmStorageReport -Name "Find big files" -``` - -This command gets the storage report named "Find big files". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an arrary of names of storage reports. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport - -## NOTES - -## RELATED LINKS - -[Set-FsrmStorageReport](./Set-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[Start-FsrmStorageReport](./Start-FsrmStorageReport.md) - -[Stop-FsrmStorageReport](./Stop-FsrmStorageReport.md) - -[Wait-FsrmStorageReport](./Wait-FsrmStorageReport.md) - -[Remove-FsrmStorageReport](./Remove-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmAction.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmAction.md deleted file mode 100644 index 6d3fd657b7..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmAction.md +++ /dev/null @@ -1,454 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmAction - -## SYNOPSIS -Returns an FSRM action object. - -## SYNTAX - -``` -New-FsrmAction [-Type] [-AsJob] [-Body ] [-CimSession ] - [-Command ] [-CommandParameters ] [-EventType ] [-KillTimeOut ] - [-MailBCC ] [-MailCC ] [-MailTo ] [-ReportTypes ] - [-RunLimitInterval ] [-SecurityLevel ] [-ShouldLogError] [-Subject ] - [-ThrottleLimit ] [-WorkingDirectory ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmAction** cmdlet returns a File Server Resource Manager (FSRM) action object. -An **FsrmAction** object does not contain the trigger for the action. -You can pass the action object to other cmdlets that use notifications and quota thresholds. - -An **FsrmAction** object encapsulates a single action, such as sending an email. -FSRM does not save an action object unless it is used as part of another object. -For example, you can use an **FsrmAction** object to create notifications and quota thresholds. -The saved object provides the trigger for the action. - -The New-FsrmAction cmdlet supports the following actions: - -- Email: Send email to the user or administrator that the event triggered -- Event: Create an event log entry -- Command: Run a command that the administrator specifies -- Report: Run one or more storage reports - -## EXAMPLES - -### Example 1: Create an action that sends an email -``` -PS C:\>New-FsrmAction Email -MailCC "john.smith@contosco.com" -MailTo "sarah.jones@contosco.com" -Subject "Warning: Approaching storage limit" -Body "You are about to reach the end of your available storage." -``` - -This command returns an object that indicates that the server sends an email when an associated event occurs. -The recipient of the email is the user sarah.jones@contosco.com and the CC recipient of the email is the administrator, john.smith@contosco.com. - -### Example 2: Create an action that has a run limit -``` -PS C:\>New-FsrmAction Email -MailTo "john.smith@contosco.com;sarah.jones@contosco.com" -Subject "Warning: Approaching storage limit" -Body "You are about to reach the end of your available storage." -RunLimitInterval 120 -``` - -This command returns an object that indicates that the server sends an email to the administrator and the file owner when an associated event occurs. -The command specifies that the event can trigger no more than once every 120 minutes. -If the event does trigger, the action will have no effect before the time interval passes. - -### Example 3: Create an action that logs an event -``` -PS C:\>New-FsrmAction Event -EventType Information -Body "The user [File Owner] is about to reach the end of his available storage." -RunLimitInterval 180 -``` - -This command returns an object that indicates the server logs an event that contains the specified message when an associated event occurs. -The event should trigger no more than once every 180 minutes. -If the event does trigger, no additional event log entries are created before the time interval passes. - -### Example 4: Create an action that runs a command and logs errors -``` -PS C:\>New-FsrmAction Command -Command "c:\windows\system32\cmd.exe"-CommandParameters "echo [source file path] >> c:\log.txt" -ShouldLogError -``` - -This command returns an object that indicates that when an associated event occurs, the server runs Cmd.exe with the specified parameters. -The command specifies that the server records errors codes from the command in the error log. - -### Example 5: Create an action that runs a storage report -``` -PS C:\>New-FsrmAction Report -ReportType @(LargeFiles, DuplicateFiles) -``` - -This command returns an object that indicates that the server runs LargeFiles and DuplicateFiles reports when an associated event occurs. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Specifies the content of an email. -If you specify this parameter, you must set Email or Event Specify for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Command -Specifies the full path to the program or script. -If you specify this parameter, you must set Command for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CommandParameters -Specifies the parameters for the program or script. -If you specify this parameter, you must set Command for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventType -Specifies the event type of the action. -If you specify this parameter, you must set Event for the **Type** parameter. -The acceptable values for this parameter are: -- None -- Information -- Warning -- Error - -```yaml -Type: ActionEventTypeEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KillTimeOut -Specifies the timeout period, in minutes, after which the process that the action created is ended. -Specify the default, -1, to indicate that the server does not end the process. -If you specify this parameter, you must set Command for the **Type** parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailBCC -Specifies a semicolon-separated list of email addresses for the Bcc recipients of an email. -Valid email addresses are an administrator email account or the owner of the file. -If you specify this parameter, you must set Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -1 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailCC -Specifies a semicolon-separated list of email addresses for the Cc recipients of an email. -Valid email addresses are an administrator email account or the owner of the file. -If you specify this parameter, you must set Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses for the recipients of an email. -Valid email addresses are an administrator email account or the owner of the file. -If you specify this parameter, you must set Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportTypes -Specifies an array of report types that the action generates. -If you specify this parameter, you must set Report for the **Type** parameter. -The acceptable values for this parameter are: -- DuplicateFiles -- FilesByFileGroup -- FilesByOwner -- FilesByProperty -- LargeFiles -- LeastRecentlyAccessed -- MostRecentlyAccessed -- QuotaUsage - -```yaml -Type: ActionReportTypeEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunLimitInterval -Specifies the minimum interval, in minutes, before the server can run the action again. -For example, if the interval expired since the action last ran, the server runs the action again in response to an event; otherwise, the server cannot run the action again. -The default value, 60, specifies that there is no limit. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 60 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityLevel -Specifies the computer account type under which the program or script runs. -The acceptable values for this parameter are: -- LocalService -- NetworkService -- LocalSystem - -```yaml -Type: ActionSecurityLevelEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: LocalService -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ShouldLogError -Indicates that the server records errors codes from running commands in the event log. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subject -Specifies the subject of an email. -The maximum size of a subject is 1 KB. -If you specify this parameter, you must set Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the action. -This setting determines the action that the server takes in response to a quota or file screen event. -The acceptable values for this parameter are: -- Email -- Event -- Command -- Report - -```yaml -Type: ActionTypeEnum -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkingDirectory -Specifies the working directory in which the program or script runs. -You must specify a valid path to a folder. -FSRM does not support paths to remote computers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMAction - -## NOTES - -## RELATED LINKS - -[New-FsrmQuotaThreshold](./New-FsrmQuotaThreshold.md) - -[New-FsrmFileScreen](./New-FsrmFileScreen.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[New-FsrmScheduledTask](./New-FsrmScheduledTask.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[New-FsrmFMJNotification](./New-FsrmFMJNotification.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmAutoQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmAutoQuota.md deleted file mode 100644 index fac0ff84ec..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmAutoQuota.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmautoquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmAutoQuota - -## SYNOPSIS -Creates an auto apply quota. - -## SYNTAX - -``` -New-FsrmAutoQuota [-Path] [-AsJob] [-CimSession ] [-Disabled] [-Template ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmAutoQuota** cmdlet creates an auto apply quota. -By using auto apply quotas, you can assign a quota template to a parent volume or folder. -File Server Resource Manager (FSRM) automatically generates quotas that are based on that template. -The server generates quotas for each of the existing subfolders and for subfolders that you create in the future. - -You can verify all automatically generated quotas by using the Get-FsrmAutoQuota cmdlet. -Get-FsrmAutoQuota returns an individual quota for each subfolder and the auto apply quota profile in the parent volume or folder. - -## EXAMPLES - -### Example 1: Create an auto apply quota on a folder -``` -PS C:\>New-FsrmAutoQuota -Path "C:\Shares\CtrShare03" -Template "250 MB Extended Limit" -``` - -This command creates an auto apply quota on the folder named C:\Shares\CtrShare03. -The server generates quotas based on the "250 MB Extended Limit" template for each of the existing subfolders in C:\Shares\CtrShare03 and for subfolders that you create in C:\Shares\CtrShare03. - -### Example 2: Create an inactive auto apply quota -``` -PS C:\>New-FsrmAutoQuota -Path "C:\Shares\CtrShare03" -Template "100 MB Limit" -Disabled -``` - -This command creates an auto apply quota on the folder C:\Shares\CtrShare03 and applies the "100 MB Limit" template to the quota. -The command disables the auto apply quota, which means that the server does not generate quotas for subfolders in C:\Shares\CtrShare03. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the server does not track quota data for the quota and does not run any action associated with quota thresholds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. -The server applies the auto apply quota to each of the subfolders (current and future) in this folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Template -Specifies a name of a quota template on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmAutoQuota](./Get-FsrmAutoQuota.md) - -[Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) - -[Update-FsrmAutoQuota](./Update-FsrmAutoQuota.md) - -[Remove-FsrmAutoQuota](./Remove-FsrmAutoQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationPropertyDefinition.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationPropertyDefinition.md deleted file mode 100644 index dcf6b76dcf..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationPropertyDefinition.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmclassificationpropertydefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmClassificationPropertyDefinition - -## SYNOPSIS -Creates a classification property definition. - -## SYNTAX - -``` -New-FsrmClassificationPropertyDefinition [-Name] [-AsJob] [-CimSession ] - [-Description ] [-DisplayName ] [-Parameters ] [-PossibleValue ] - [-ThrottleLimit ] -Type [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmClassificationPropertyDefinition** cmdlet creates a classification property definition on the server. -You create a property definition to define the property that you want to use to classify files. -One or more classification rules can specify the property. -The File Server Resource Manager (FSRM) server limits the number of property definitions to 100. - -## EXAMPLES - -### Example 1: Create a YesNo classification property definition -``` -PS C:\>New-FsrmClassificationPropertyDefinition -Name "ClassProp01" -DisplayName "Central Level Definitions" -Type YesNo -``` - -This command creates a YesNo classification property definition that named "ClassProp01" with a display name of "Central Level Definitions". - -### Example 2: Create an ordered list classification property definition -``` -PS C:\>New-FsrmClassificationPropertyDefinition -Name "Impact" -Type OrderedList -PossibleValue @("High","Moderate","Low") -``` - -This command creates an OrderedList classification property definition named "Impact", and specifies the possible values for the property. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the property definition. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayName -Specifies an optional name for the property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Parameters -Specifies an array of strings using the format \=\. -The File Classification Infrastructure and other management tools use these parameters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PossibleValue -Specifies an array of property values. -The default value is an empty list. -You can use the New-FsrmClassificationPropertyValue cmdlet to create possible values for a classification property. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of the classification property definition. -The acceptable values for this parameter are: -- OrderedList -- MultiChoice -- SingleChoice -- String -- MultiString -- Integer -- YesNo -- DateTime - -```yaml -Type: PropertyDefinitionTypeEnum -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationPropertyDefinition - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - -[Set-FsrmClassificationPropertyDefinition](./Set-FsrmClassificationPropertyDefinition.md) - -[Update-FsrmClassificationPropertyDefinition](./Update-FsrmClassificationPropertyDefinition.md) - -[Remove-FsrmClassificationPropertyDefinition](./Remove-FsrmClassificationPropertyDefinition.md) - -[New-FsrmClassificationPropertyValue](./New-FsrmClassificationPropertyValue.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationPropertyValue.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationPropertyValue.md deleted file mode 100644 index 3c5c8c9980..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationPropertyValue.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmclassificationpropertyvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmClassificationPropertyValue - -## SYNOPSIS -Creates a classification property value. - -## SYNTAX - -``` -New-FsrmClassificationPropertyValue [-Name] [-AsJob] [-CimSession ] - [-Description ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmClassificationPropertyValue** cmdlet creates a classification property value. - -## EXAMPLES - -### Example 1: Create a classification property number value -``` -PS C:\>New-FsrmClassificationPropertyValue -Name "1" -Description "The value 1" -``` - -This command creates the classification property value named "1" and adds a description to the property value. - -### Example 2: Create a classification property string value -``` -PS C:\>New-FsrmClassificationPropertyValue -Name "Value 1" -Description "First item in a list" -``` - -This command creates the classification property value named "Value1" and adds a description to the property value. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the classification property value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the classification property value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-FsrmClassificationPropertyDefinition](./New-FsrmClassificationPropertyDefinition.md) - -[Set-FsrmClassificationPropertyDefinition](./Set-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationRule.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationRule.md deleted file mode 100644 index 3d117f2933..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmClassificationRule.md +++ /dev/null @@ -1,332 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmclassificationrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmClassificationRule - -## SYNOPSIS -Creates an automatic classification rule. - -## SYNTAX - -``` -New-FsrmClassificationRule [-Name] [-AsJob] [-CimSession ] - [-ContentRegularExpression ] [-ContentString ] [-ContentStringCaseSensitive ] - [-Description ] [-Disabled] [-Parameters ] [-PropertyValue ] - [-ReevaluateProperty ] [-ThrottleLimit ] -ClassificationMechanism - -Namespace -Property [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmClassificationRule** cmdlet creates an automatic classification rule on the server. -Each rule sets the value for a single property. -By default, a rule runs only once and ignores files that already have a property value assigned. -However, you can configure a rule to evaluate files regardless of whether a value is already assigned to the property. - -## EXAMPLES - -### Example 1: Create a classification rule -``` -PS C:\>New-FsrmClassificationRule -Name "Find confidential files" -Namespace @("C:\shares\CtrShare03") -Property "Impact" -PropertyValue "High" -ClassificationMechanism "Content Classifier" -ContentString "Confidential" -``` - -This command creates a classification rule that marks any files as Impact=High if the files contain the word "Confidential" and the files do not already have an Impact property. - -### Example 2: Create a classification rule and overwrite the property value -``` -PS C:\>New-FsrmClassificationRule -Name "Find confidential files" -Namespace @("C:\shares\CtrShare03") -Property "Impact" -PropertyValue "High" -ClassificationMechanism "Content Classifier" -ContentString "confidential" -ReevaluateProperty Overwrite -``` - -This command creates a classification rule that marks any files as Impact=High if they contain the word "Confidential", and overwrites any existing Impact property value. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClassificationMechanism -Specifies the name of a valid classification mechanism available on the server for assigning the property value. - -The classification mechanisms are provided by a series of plug-ins that are included with Windows Server® 2012 or produced by you or an ISV. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContentRegularExpression -Specifies an array of regular expressions for pattern matching. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContentString -Specifies an array of strings for the content classifier to search for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContentStringCaseSensitive -Specifies an array of case sensitive strings for the content classifier to search for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the classification rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the classification rule is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the classification rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies an array of namespaces where the rule is applied. -Each value must be either a value of the FolderType property defined on the server (using the format "\[Folder type property name=\\]") or a static path. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -Specifies an array of strings using the format \=\. -The File Classification Infrastructure and other management tools use these parameters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Property -Specifies the name of a classification property definition to set. -Specify the value of the **Name** property in a **FsrmClassificationPropertyDefinition** object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyValue -Specifies the property value that the rule will assign. -The property value that you set must be an valid value supported by the classification mechanism that you specify in the **ClassificationMechanism** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReevaluateProperty -Specifies the evaluation policy of the rule. -The acceptable values for this parameter are: -- Never: Assign values to properties only if that property does not already have a value for the file. -- Overwrite: Reclassify files when the files change and overwrite this property. -- Aggregate: Reclassify files when the files change and aggregate the new value for the property with the existing value. - -```yaml -Type: RuleReevaluatePropertyEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Never -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit - - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationRule - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationRule](./Get-FsrmClassificationRule.md) - -[Set-FsrmClassificationRule](./Set-FsrmClassificationRule.md) - -[Remove-FsrmClassificationRule](./Remove-FsrmClassificationRule.md) - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFMJNotification.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFMJNotification.md deleted file mode 100644 index 7b70fd75d2..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFMJNotification.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfmjnotification?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFMJNotification - -## SYNOPSIS -Returns a notification object for file management jobs. - -## SYNTAX - -``` -New-FsrmFMJNotification [-Days] [-Action ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFMJNotification** cmdlet returns a notification object that you can use to create file management job actions. -You can use the **FsrmFMJNotification** object as input for the **New-FsrmFileManagementJob** cmdlet and the **Set-FsrmFileManagementJob** cmdlet. - -The **FsrmFmjAction** object defines a notification period before a file management job acts on a file. -This cmdlet supports the following actions: -- Email -- Event -- Command - -## EXAMPLES - -### Example 1: Create a notification for file management jobs -``` -PS C:\>$action = New-FsrmFmjNotificationAction -Type Email -MailTo "[Admin Email];[File Owner]" -Subject "Warning: Files will expire soon" -Body "The attached list of files will expire in 30 days." -AttachmentFileListSize 1000 PS C:\>New-FsrmFmjNotification -Days 30 -Action $action -``` - -The first command returns an object that represents a notification action. -The notification action sends the specified email message to the administrator and file owner, and specifies that the action can attach a maximum of 1000 files to the message. -The command stores the notification action object in the $action variable. - -The second command returns a notification object for a file management job that runs the notification action stored in the $action variable 30 days before the file management job acts. - -## PARAMETERS - -### -Action -Specifies an array of file management job actions. -You can create a job action by using the **New-FsrmFmjAction** cmddlet. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Days -Specifies the number of days before a file management job acts on a file to run the notification action. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFMJNotification - -## NOTES - -## RELATED LINKS - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFmjAction](./New-FsrmFmjAction.md) - -[New-FsrmFmjNotificationAction](./New-FsrmFmjNotificationAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileGroup.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileGroup.md deleted file mode 100644 index d0ce517052..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileGroup.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfilegroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFileGroup - -## SYNOPSIS -Creates a file group. - -## SYNTAX - -``` -New-FsrmFileGroup [-Name] [-AsJob] [-CimSession ] [-Description ] - [-ExcludePattern ] [-IncludePattern ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFileGroup** cmdlet creates a file group object on the server. -A file group is a logical collection of file name patterns that the server uses to define file screens and file screen exceptions. -You can also use file group definitions for generating storage report jobs based on file type. - -The file group consists of two collections of wildcard patterns for file names. -One collection indicates file names that the server includes for file screens, and the other collection indicates file names that the server does not include for file screens. - -## EXAMPLES - -### Example 1: Create a file group -``` -PS C:\>New-FsrmFileGroup -Name "Non-HTML text files" -IncludePattern @("*.txt", "*ml") -ExcludePattern "*.html" -``` - -This command creates a file group named "Non-HTML text files". -The command indicates that files that end in txt or ml are included in the file group, and that files that end in .html are not included in the file group. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExcludePattern -Specifies an array of pattern strings that can include * and ? -as wildcard characters. -The strings can be up to 1KB in size. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludePattern -Specifies an array of pattern strings that can include * and ? -as wildcard characters. -The strings can be up to 1KB in size. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the file group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileGroup - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileGroup](./Get-FsrmFileGroup.md) - -[Set-FsrmFileGroup](./Set-FsrmFileGroup.md) - -[Remove-FsrmFileGroup](./Remove-FsrmFileGroup.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileManagementJob.md deleted file mode 100644 index 764d5569d4..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileManagementJob.md +++ /dev/null @@ -1,470 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFileManagementJob - -## SYNOPSIS -Creates a file management job. - -## SYNTAX - -``` -New-FsrmFileManagementJob [-Name] [-AsJob] [-CimSession ] [-Condition ] - [-Continuous] [-ContinuousLog] [-ContinuousLogSize ] [-Description ] [-Disabled] - [-MailTo ] [-Notification ] [-Parameters ] - [-ReportFormat ] [-ReportLog ] [-ThrottleLimit ] - -Action -Namespace -Schedule [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFileManagementJob** cmdlet creates a file management job on the server. -The job specifies a schedule, conditions, a command or actions to run if a file meets all the conditions, user notifications, and reporting. - -To use this cmdlet to create a file management job, you must pass in a **FsrmScheduledTask** object, a **FsrmFmjAction** object, and a **FsrmFmjNotification** object. - -## EXAMPLES - -### Example 1: Create a file management job that expires data -``` -The first command gets a **DateTime** object and stores it in the variable **$date**. -PS C:\>$date = Get-Date "12:00am" - -This second command returns a **FsrmScheduledTask** object that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = New-FsrmScheduledTask -Time $date -Monthly 1 - -The third command returns an action object for a management job and stores the results in the **$action** variable. The command specifies an expiration action and specifies a path that the action uses to expire files. -PS C:\>$action = New-FsrmFmjAction -Type Expiration -ExpirationFolder "C:\Expire" - -The fourth command creates a file management job named "Expire all data" for the folder C:\Share01. The command specifies the schedule stored in the **$task** variable and specifies the action stored in the **$action** variable. -PS C:\>New-FsrmFileManagementJob -Name "Expire all data" -Namespace @("C:\Share01") -Schedule $task -Action $action -``` - -This example creates a file management job that expires all data in a namespace. - -### Example 2: Create a file management job that expires data continuously -``` -The first command gets a **DateTime** object and stores it in the variable **$date**. -PS C:\>$date = Get-Date "12:00am" - -This second command returns a **FsrmScheduledTask** object that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = New-FsrmScheduledTask -Time $date -Monthly 1 - -The third command returns an action object for a management job and stores the results in the **$action** variable. The command specifies an expiration action and specifies a path that the action uses to expire files. -PS C:\>$action = New-FsrmFmjAction -Type Expiration -ExpirationFolder "C:\Expire" - -The fourth command creates a file management job named "Expire all data" for the folder C:\Share01. The command specifies the schedule stored in the **$task** variable, specifies the action stored in the **$action** variable, and specifies that the server continuously apply classification to files in the background. -PS C:\>New-FsrmFileManagementJob -Name "Expire all data" -Namespace @("C:\Share01") -Schedule $task -Action $action -Continuous -``` - -This example creates a file management job that expires data in a namespace when the server runs the file management job and when a file is modified or classified. - -### Example 3: Create a file management job that sends notifications -``` -The first command gets a **DateTime** object and stores it in the variable **$date**. -PS C:\>$date = Get-Date "12:00am" - -This second command returns a **FsrmScheduledTask** object that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = New-FsrmScheduledTask -Time $date -Monthly 1 - -The third command returns an action object for a management job and stores the results in the **$action** variable. The command specifies an expiration action and specifies a path that the action uses to expire files. -PS C:\>$action = New-FsrmFmjAction -Type Expiration -ExpirationFolder "C:\Expire" - -The fourth command returns a notification action object that sends the specified email message to the administrator and file owner. The command specifies that the action can attach a maximum of 1000 files to the message. The command stores the results in the **$notificationaction** variable. -PS C:\>$notificationaction = New-FsrmFmjNotificationAction -Type Email -MailTo "[Admin Email];[File Owner]" -Subject "Warning: Files will expire soon" -Body "The attached list of files will expire in 30 days." -AttachmentFileListSize 1000 - -The fifth command returns a notification object for a file management job that runs the notification action stored in the **$notificationaction** variable 30 days before the file management job acts. The command stores the results in the **$notification** variable. -PS C:\>$notification = New-FsrmFmjNotification -Days 30 -Action $notificationaction - -The sixth command creates a file management job named "Expire all data" for the folder C:\Share01. The command specifies the schedule stored in the **$task** variable, specifies the action stored in the **$action** variable, and specifies the notification stored in the **$notification** variable. -PS C:\>New-FsrmFileManagementJob -Name "Expire all data" -Namespace @("C:\Share01") -Schedule $task -Action $action -Notification $notification -``` - -This example creates a file management job that expires data in a namespace and sends an email notice to the file owner and administrator 30 days before the server runs the file management job. - -### Example 4: Create a conditional file management job -``` -The first command gets a **DateTime** object and stores it in the variable **$date**. -PS C:\>$date = Get-Date "12:00am" - -This second command returns an **FsrmScheduledTask** object that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = New-FsrmScheduledTask -Time $date -Monthly 1 - -The third command returns an action object for a management job and stores the results in the **$action** variable. The command specifies an expiration action and specifies a path that the action uses to expire files. -PS C:\>$action = New-FsrmFmjAction -Type Expiration -ExpirationFolder "C:\Expire" - -The fourth command returns a condition object for file management job that verifies that a file has a PII classification property set to true. The command stores the results in the **$condition** variable. -PS C:\>$condition = New-FsrmFmjCondition -Property "PII" -Condition Equal -Value "1" - -The fifth command creates a file management job named "Expire all data" for the folder C:\Share01. The command specifies the schedule stored in the **$task** variable, specifies the action stored in the **$action** variable, and specifies the condition stored in the **$condition** variable. -PS C:\>New-FsrmFileManagementJob -Name "Expire all data" -Namespace @("C:\Share01") -Schedule $task -Action $action -Condition $condition -``` - -This example creates a file management job that expires all files that have the PII property set to true. - -## PARAMETERS - -### -Action -Specifies a **FsrmFmjAction** object. -You can use the New-FsrmFmjAction cmdlet to create a **FsrmFmjAction** object. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -Specifies a **FsrmFmjCondition** object. -You can use the New-FsrmFmjCondition cmdlet to create a **FsrmFmjCondition** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Continuous -Indicates that the server continuously applies classification to files in the background. - -If you specify this parameter, you cannot specify any notifications and the conditions that you specify cannot include any objects where the classification property is set to the following values: -- File.DateCreated -- File.DateLastModified -- File.DateLastAccessed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContinuousLog -Indicates that the server maintains a log of continuous classification activities. -You must specify the **Continuous** parameter to log classification activities. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ContinuousLogSize -Specifies the maximum size of the log that contains continuous classification activity. -You must specify the **Continuous** parameter to log classification activities. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file management job. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the file management job is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses to which the file server sends the email. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the file management job. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies an array of namespaces that are part of the scope. -Each value must be either a value of the FolderType property defined on the server (in the format "\[Folder type property name=\\]") or a static path. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Notification -Specifies a **FsrmFmjNotificationAction** object. -You can use the New-FsrmFmjNotificationAction cmdlet to create a **FsrmFmjNotificationAction** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Parameters -Specifies an array of strings of the form \=\. -The File Classification Infrastructure and other management tools use these parameters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportFormat -Specifies an array of report formats that the file management job produces. -The acceptable values for this parameter are: -- DHTML -- HTML -- XML -- CSV -- Text - -```yaml -Type: FmjReportFormatsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: {"DHTML", "XML"} -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportLog -Specifies an array of report types that the file management job generates. -The acceptable values for this parameter are: -- Information -- Error -- Audit - -```yaml -Type: FmjReportLogsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Schedule -Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for performing the continuous classification. -Use the New-FsrmScheduledTask cmdlet to create a scheduled task object. -Any duration information in the FSRM scheduled task object is ignored. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) - -[Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) - -[Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) - -[Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) - -[New-FsrmFmjAction](./New-FsrmFmjAction.md) - -[New-FsrmFmjCondition](./New-FsrmFmjCondition.md) - -[New-FsrmScheduledTask](./New-FsrmScheduledTask.md) - -[New-FsrmFMJNotification](./New-FsrmFMJNotification.md) - -[New-FsrmFmjNotificationAction](./New-FsrmFmjNotificationAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreen.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreen.md deleted file mode 100644 index 0f95eeb033..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreen.md +++ /dev/null @@ -1,254 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfilescreen?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFileScreen - -## SYNOPSIS -Creates a file screen. - -## SYNTAX - -``` -New-FsrmFileScreen [-Path] [-Active] [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-Notification ] [-Template ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFileScreen** cmdlet creates a file screen for a path on the server. -A file screen blocks users from saving groups of files to a specified folder. - -If you specify the **Active** parameter, the file screen prevents users from saving files that are members of blocked file groups, and generates notifications when users try to save blocked files. -The file screen does not prevent users and applications from accessing files that were saved to the path before the file screen was created, regardless of whether the files are members of blocked file groups. - -## EXAMPLES - -### Example 1: Create a passive file screen -```powershell -PS C:\> New-FsrmFileScreen -Path "C:\Shares" -Description "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" -Active:$false -``` - -This command creates a passive file screen on C:\Shares that logs any files that match the "Non-HTML text files" file group. -The file screen template is passive because the command specifies the `-Active:$false` parameter. -This means that users can create non-HTML text files. - -### Example 2: Create an active file screen -```powershell -PS C:\> $Notification = New-FsrmAction -Type Email -MailTo "[Admin Email];[File Owner]" -Subject "Warning: attempted to create a non-HTML text file" -Body "You attempted to create a non-HTML text file. This is not allowed." -RunLimitInterval 120 -PS C:\> New-FsrmFileScreen -Path "C:\Shares\Ctrshare03" -IncludeGroup "Non-HTML text files" -Notification $Notification -Active -``` - -The first command creates a File Server Resource Manager (FSRM) action object and stores the results in the $Notification variable. -The action sends an email notification to the file owner and administrator. -The **RunLimitInterval** parameter specifies an interval of 2 minutes before the server can send the email notification again. - -This second command creates an active file screen on `C:\Shares\Ctrshare03` that restricts any files that match the "Non-HTML text files" file group. -When a user attempts to create a non-HTML text file, the file screen performs the notification action stored in the `$Notification` variable. - -### Example 3: Create a file screen from a file screen template -```powershell -PS C:\> New-FsrmFileScreen -Path "C:\shares\ctrshare03" -Template "Block Image Files" -``` - -This command creates a file screen on `C:\shares\ctrshare03` based on the settings in the "Block Image Files" template. - -## PARAMETERS - -### -Active -Indicates that the server will fail any I/O operation that violates the file screen. It is enabled by default. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file screen. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroup -Specifies an array of names of file groups. -The file groups contain the file name patterns that the server uses to specify the files that are blocked by this screen. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notification -Specifies an array of notification action objects. -You can use the New-FsrmFmjNotificationAction cmdlet to create a **FsrmFmjNotificationAction** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Template -Specifies a file screen template on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreen - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreen](./Get-FsrmFileScreen.md) - -[Set-FsrmFileScreen](./Set-FsrmFileScreen.md) - -[Reset-FsrmFileScreen](./Reset-FsrmFileScreen.md) - -[Remove-FsrmFileScreen](./Remove-FsrmFileScreen.md) - -[New-FsrmFmjNotificationAction](./New-FsrmFmjNotificationAction.md) - -[Get-FsrmFileGroup](./Get-FsrmFileGroup.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreenException.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreenException.md deleted file mode 100644 index a0daa2057e..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreenException.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfilescreenexception?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFileScreenException - -## SYNOPSIS -Creates a file screen exception. - -## SYNTAX - -``` -New-FsrmFileScreenException [-Path] [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -**The New-FsrmFileScreenException** cmdlet creates a file screen exception. -A file screen exception is a special type of file screen that overrides any file screening that would otherwise apply to a folder, and all its subfolders, in a designated exception path. - -A file screen exception creates an exception to any rules derived from a parent folder. -To determine which file types the exception allows, you can specify file groups for a file screen exception. - -You cannot create a file screen exception on a folder for which you already have a file screen. -You must assign the exception to a subfolder or make changes to the existing file screen. - -## EXAMPLES - -### Example 1: Create a file screen exception -``` -PS C:\>New-FsrmFileScreenException -Path "C:\Share1-IncludeGroup" -IncludeGroup "Text Files" -``` - -This command creates a file screen exception on C:\Share1-IncludeGroup that allows users to create files that are part of the "Text Files" file group. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for a file screen exception. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroup -Specifies an array of names of file groups that you want to exclude from file screening. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. -The exception applies to the selected folder and all of its subfolders. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenException - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreenException](./Get-FsrmFileScreenException.md) - -[Set-FsrmFileScreenException](./Set-FsrmFileScreenException.md) - -[Remove-FsrmFileScreenException](./Remove-FsrmFileScreenException.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md deleted file mode 100644 index a190030f1c..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFileScreenTemplate.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfilescreentemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFileScreenTemplate - -## SYNOPSIS -Creates a file screen template. - -## SYNTAX - -``` -New-FsrmFileScreenTemplate [-Name] [-Active] [-AsJob] [-CimSession ] - [-Description ] [-IncludeGroup ] [-Notification ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFileScreenTemplate** cmdlet creates a file screen template. -A file screen template defines the group of file groups to block, the type of screening to perform (active or passive), and the set of notifications that the file screen generates. - -You can use file screen templates to centrally manage your file screens by updating the templates instead of the individual file screens. -When you make changes to a template, you can choose to apply those changes to all file screens that are based on that template or only to the file screens whose properties match those in the template. - -## EXAMPLES - -### Example 1: Create a passive file screen template -``` -PS C:\>New-FsrmFileScreenTemplate "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" -``` - -This command creates a passive file screen template named "Filter Non-HTML text files" that logs any files that match the "Non-HTML text files" file group. -The file screen template is passive because the command does not specify the **Active** parameter. -This means that users can create non-HTML text files. - -### Example 2: Create an active file screen template -``` -PS C:\>$Notification = New-FsrmAction -Type Email -MailTo "[Admin Email];[File Owner]" -Subject "Warning: attempted to create a non-HTML text file" -Body "You attempted to create a non-HTML text file. This is not allowed." -RunLimitInterval 120 PS C:\>New-FsrmFileScreenTemplate -Name "Filter Non-HTML text files" -IncludeGroup "Non-HTML text files" -Notification $Notification -Active -``` - -The first command creates a File Server Resource Manager (FSRM) action object and stores the results in the **$Notification** variable. -The action sends an email notification to the file owner and administrator. -The **RunLimitInterval** parameter specifies an interval of 2 minutes before the server can send the email notification again. - -This second command creates an active file screen template named "Filter Non-HTML text files" that restricts any files that match the Non-HTML text files file group. -When a user attempts to create a non-HTML text file, the file screen performs the notification action stored in the **$Notification** variable. - -## PARAMETERS - -### -Active -Indicates that the server will fail any I/O operation that violates the file screen. -If you do not specify this parameter, the server does not fail violating I/O operations and still runs any action that is associated with the file screen. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file screen template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroup -Specifies an array of names of file groups that you want to exclude from file screening. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name for the file screen template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Notification -Specifies an array of notification action objects. -You can use the **New-FsrmFmjNotificationAction** cmdlet to create a **FsrmFmjNotificationAction** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenTemplate - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreenTemplate](./Get-FsrmFileScreenTemplate.md) - -[Set-FsrmFileScreenTemplate](./Set-FsrmFileScreenTemplate.md) - -[Remove-FsrmFileScreenTemplate](./Remove-FsrmFileScreenTemplate.md) - -[New-FsrmAction](./New-FsrmAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjAction.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjAction.md deleted file mode 100644 index a4622ec265..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjAction.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfmjaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFmjAction - -## SYNOPSIS -Returns an action object for file management jobs. - -## SYNTAX - -``` -New-FsrmFmjAction [-Type] [-AsJob] [-CimSession ] [-Command ] - [-CommandParameters ] [-ExpirationFolder ] [-RmsFolderOwner] [-RmsFullControlUser ] - [-RmsReadUser ] [-RmsTemplate ] [-RmsWriteUser ] - [-SecurityLevel ] [-ThrottleLimit ] [-WorkingDirectory ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFmjAction** cmdlet returns an object that you can use to create file management job actions. -You can use the **FsrmFmjAction** object as input for the New-FsrmFileManagementJob cmdlet and the Set-FsrmFileManagementJob cmdlet. - -The **FsrmFmjAction** object defines one action of the file management job when the job acts on a file. -This cmdlet supports the following actions: -- Expiration: Move the file to another location -- RMS: Encrypt the file (Rights Management Services) -- Custom: Run a command - -## EXAMPLES - -### Example 1: Create an action that expires files -``` -PS C:\>New-FsrmFmjAction -Type Expiration -ExpirationFolder "C:\shares\expire01" -``` - -This command returns an object that expires files to the path C:\shares\expire01. - -### Example 2: Create an action that encrypts files by using an RMS template -``` -PS C:\>New-FsrmFmjAction -Type RMS -RmsTemplate "Contoso Confidential" -``` - -This command returns an action object that encrypts a file to the Contoso Confidential RMS template. -This command requires that an RMS template is configured on the RMS server named "Contoso Confidential". - -### Example 3: Create an action that encrypts files and assigns RMS permissions -``` -PS C:\>New-FsrmFmjAction -Type RMS -RmsFullControlUser "admin@contoso.com" -RmsReadUser "AllStaff@contoso.com" -RmsWriteUser "AllFTE@contoso.com" -``` - -This command returns an action object that encrypts a file so that the administrator account in contoso.com has full control of the file, the ALLFTE security group has edit rights to the file, and the ALLStaff group has read rights to the file. - -### Example 4: Create an action that runs a command -``` -PS C:\>New-FsrmFmjAction -Type Custom -Command "C:\windows\system32\cmd.exe" -CommandParameters "echo [source file path] >> c:\log.txt" -``` - -This command returns an action object that runs Cmd.exe and specifies the parameters for the command. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Command -Specifies the command that the action runs. -If you specify a command, you must specify Custom for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CommandParameters -Specifies the parameters that the action passes to the command when the action runs. -If you specify parameters for a command, you must specify Custom for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ExpirationFolder -Specifies a path that the action uses to expire files. -If you specify an expiration folder, you must specify Expiration for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RmsFolderOwner -Indicates that the action adds the RMS FolderOwner to the Full Control list. -If a FolderOwner is not available for a file, this setting has no effect. - -If you specify an RMS folder owner, you must specify RMS for the **Type** parameter. -If you specify this parameter, do not specify the **RMSFullControlUser**, **RMSReadUser**, or **RMSWriteUser** parameters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RmsFullControlUser -Specifies an array of email addresses to provide with full control to the Active Directory Rights Management Services (AD RMS) encryption. -If you specify this cmdlet, you must specify RMS for the **Type** parameter. -If you specify this parameter, do not specify the **RMSTemplate** parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RmsReadUser -Specifies an array of addresses to provide with read permission to the Active Directory Rights Management Services (AD RMS) encryption. -If you specify this cmdlet, you must specify RMS for the **Type** parameter. -If you specify this parameter, do not specify the **RMSTemplate** parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RmsTemplate -Specifies the name of the RMS template that the actions applies to files. -If you specify an RMS template, you must specify RMS for the **Type** parameter. -If you specify this parameter, do not specify the **RMSFullControlUser**, **RMSReadUser**, or **RMSWriteUser** parameters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RmsWriteUser -Specifies an array of addresses to provide with write permission to the Active Directory Rights Management Services (AD RMS) encryption. -If you specify this cmdlet, you must specify RMS for the **Type** parameter. -If you specify this parameter, do not specify the **RMSTemplate** parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityLevel -Specifies the system account that the action uses to run the command that you specify in the Command parameter. -If you specify this parameter, you must specify Custom for the **Type** parameter. - -```yaml -Type: FmjActionSecurityLevelEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: LocalService -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of action that the file management job performs. -The acceptable values for this parameter are: -- Expiration -- RMS -- Custom - -```yaml -Type: FmjActionTypeEnum -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkingDirectory -Specifies the working directory in which the program or script runs. -You must specify a valid path to a folder. -File Server Resource Manager (FSRM) does not support paths to remote computers. -If you specify this parameter, you must specify Custom for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFMJAction - -## NOTES - -## RELATED LINKS - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjCondition.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjCondition.md deleted file mode 100644 index b11ae6a3ca..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjCondition.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfmjcondition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFmjCondition - -## SYNOPSIS -Creates a file management property condition object. - -## SYNTAX - -``` -New-FsrmFmjCondition [-Property] [-Condition] [-AsJob] - [-CimSession ] [-DateOffset ] [-ThrottleLimit ] [-Value ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFmjCondition** cmdlet creates a file management condition object. -A file management condition object defines a condition that determines if a file management job acts on a file. - -## EXAMPLES - -### Example 1: Create a property condition -``` -PS C:\>New-FsrmFmjCondition -Property "PII" -Condition Equal -Value "1" -``` - -This command creates a property condition that verifies that a file has a PII classification property set to true. - -### Example 2: Create a condition based on a file classification -``` -PS C:\>New-FsrmFmjCondition -Property "DatePublished" -Condition Equal -Value "File.DateLastModified" -``` - -This command creates a condition based on the file's classification. -The command verifies that a file has a DatePublished classification property (of type DateTime) set to the file's Last Modified timestamp. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -Specifies the condition of the property that must be matched for the file management job. -The acceptable values for this parameter are: -- Equal -- NotEqual -- GreaterThan -- LessThan -- Contain -- Exist -- NotExist -- StartWith -- EndWith -- ContainedIn -- PrefixOf -- SuffixOf -- MatchesPattern - -```yaml -Type: FmjConditionTypeEnum -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DateOffset -Specifies an offset from the **Value** parameter for DateTime values. -The default value is 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Property -Specifies the property to compare for the condition. -Specify one of the following values: -- The name of a classification property definition on the server. -(Do not specify the display name of the property definition.) -- The string File.Name -- The string File.DateCreated -- The string File.DateLastModified -- The string File.DateLastAccessed - -The value of this parameter limits the values that other parameters to the cmdlet can accept as follows: - -File.Name: -- You can set the **Condition** parameter only to MatchesPattern. -- The **Value** parameter must contain a semi-colon separated list of wildcard patterns. -- You cannot specify the **DateOffset** parameter. - -File.DateCreated, File.DateLastModified, or File.DateLastAccessed: -- You can set the **Condition** parameter only to LessThan or Equal. -- If you specify the **DateOffset** parameter, you can set the **Value** parameter to one of the following: File.DateCreated, File.DateLastModified, File.DateLastAccessed, or Date.Now. -- If you do not specify the **DateOffset** parameter, you can set the **Value** parameter to a FileTime value. - -The name of a classification property definition whose Type is DateTime: -- You can set the **Condition** parameter to Exist, NotExist, Equal, NotEqual, LessThan, GreaterThan. -- If you specify the **DateOffset** parameter, the **Value** parameter can contain one of the following: File.DateCreated, File.DateLastModified, File.DateLastAccessed, or Date.Now. -- If you do not specify the **DateOffset** parameter, the **Value** parameter can contain a FileTime value. - -The name of a classification property definition whose Type is not DateTime: -- You cannot specify the **DateOffset** parameter. -- If the **Condition** parameter is Exist or NotExist, you cannot specify the **Value** parameter. -- If the Type is Integer, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist, LessThan, GreaterThan. -- If the Type is String, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist, Contains, IsContainedIn, LessThan, GreaterThan, StartsWith, EndsWith, PrefixOf, SuffixOf. -- If the Type is YesNo, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist. -- If the Type is OrderedList, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist, LessThan, GreaterThan. -- If the Type is SingleChoice, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist. -- If the Type is MultiChoice, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist, Contains. -- If the Type is MultiString, you can set the **Condition** parameter to Equal, NotEqual, Exist, NotExist, Contains. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies a name of a file condition property value. -Do not specify this parameter if you specify Exists or NotExist for the **Condition** parameter. -If you specify the name of a DateTime property, specify the **DateOffset** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFMJCondition - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjNotificationAction.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjNotificationAction.md deleted file mode 100644 index 1fbb02bbb8..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmFmjNotificationAction.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmfmjnotificationaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmFmjNotificationAction - -## SYNOPSIS -Returns a notification action object for file management jobs. - -## SYNTAX - -``` -New-FsrmFmjNotificationAction [-Type] [-AsJob] - [-AttachmentFileListSize ] [-Body ] [-CimSession ] [-Command ] - [-CommandParameters ] [-EventType ] [-MailBCC ] - [-MailCC ] [-MailTo ] [-SecurityLevel ] - [-Subject ] [-ThrottleLimit ] [-WorkingDirectory ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmFmjNotificationAction** cmdlet returns a notification action object that you can use to create file management job actions. -You can use the **FsrmFMJNotificationAction** object as input for the following File Server Resource Manager (FSRM) cmdlets: -- New-FsrmFileManagementJob -- Set-FsrmFileManagementJob -- New-FsrmFileScreen -- Set-FsrmFileScreen -- New-FsrmFileScreenTemplate -- Set-FsrmFileScreenTemplate - -The **FsrmFmjAction** object defines an action that the server performs when the notification period is reached. -This cmdlet supports the following actions: -- Email -- Event -- Command - -## EXAMPLES - -### Example 1: Create an email notification action -``` -PS C:\>New-FsrmFmjNotificationAction -Type Email -MailTo "[Admin Email];[File Owner]" -Subject "Warning: Files will expire soon" -Body "The attached list of files will expire in 30 days." -AttachmentFileListSize 1000 -``` - -This command returns a notification action object that sends the specified email message to the administrator and file owner. -The command specifies that the action can attach a maximum of 1000 files to the message. - -### Example 2: Create an event notification action -``` -PS C:\>New-FsrmFmjNotificationAction -Type Event -EventType Information -Body "Files will expire in 30 days." -``` - -This command returns a notification action object that logs an information event that contains the message Files will expire in 30 days. -The server logs the event when an event that you associated with the action occurs. - -### Example 3: Create a command notification action -``` -PS C:\>New-FsrmFmjNotificationAction -Type Command -Command "c:\windows\system32\cmd.exe" -CommandParameters "echo [source file path] >> c:\log.txt" -``` - -This command returns a notification action object that runs Cmd.exe and logs the output in a file named Log.txt. -The server runs Cmd.exe when an event that you associated with the action occurs. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AttachmentFileListSize -Specifies the maximum number of files that the list can include. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Body -Specifies the content of an email. -If you specify this parameter, you specify Email or Event for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Command -Specifies the command that the action runs. -If you specify a command, you must specify Custom for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CommandParameters -Specifies the parameters that the action passes to the command when the action runs. -If you specify parameters for a command, you must specify Custom for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventType -Specifies the event type of the action. -If you specify an event type, you must specify Event for the Type parameter. -The acceptable values for this parameter are: -- None -- Information -- Warning -- Error - -```yaml -Type: FmjNotificationActionEventTypeEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailBCC -Specifies a semicolon-separated list of email addresses for the Bcc recipients of an email. -Valid email addresses are an administrator email account or the owner of the file. -If you specify this parameter, you must specify Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: -1 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailCC -Specifies a semicolon-separated list of email addresses for the Cc recipients of an email. -Valid email addresses are an administrator email account or the owner of the file. -If you specify this parameter, you must specify Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses for the recipients of an email. -Valid email addresses are an administrator email account or the owner of the file. -If you specify this parameter, you must specify Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecurityLevel -Specifies the computer account type under which the executable program or script runs. -The acceptable values for this parameter are: -- LocalService -- NetworkService -- LocalSystem - -The default value is LocalService. -If you specify this parameter, you must specify Command for the **Type** parameter. - -```yaml -Type: FmjNotificationActionSecurityLevelEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: LocalService -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Subject -Specifies the subject of an email. -The maximum size of a subject is 1 KB. -If you specify this parameter, you must specify Email for the **Type** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the type of notification action. -The acceptable values for this parameter are: -- Email -- Event -- Command - -```yaml -Type: FmjNotificationActionTypeEnum -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WorkingDirectory -Specifies the working directory in which the executable program or script runs. -You must specify a valid path to a folder. -File Server Resource Manager (FSRM) does not support paths to remote computers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFMJNotificationAction - -## NOTES - -## RELATED LINKS - -[New-FsrmFMJNotification](./New-FsrmFMJNotification.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFileScreen](./New-FsrmFileScreen.md) - -[Set-FsrmFileScreen](./Set-FsrmFileScreen.md) - -[New-FsrmFileScreenTemplate](./New-FsrmFileScreenTemplate.md) - -[Set-FsrmFileScreenTemplate](./Set-FsrmFileScreenTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuota.md deleted file mode 100644 index babfa1f93a..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuota.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmQuota - -## SYNOPSIS -Creates a FSRM quota. - -## SYNTAX - -``` -New-FsrmQuota [-Path] [-AsJob] [-CimSession ] [-Description ] [-Disabled] - [-Size ] [-SoftLimit] [-Template ] [-Threshold ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmQuota** cmdlet creates a File Server Resource Manager (FSRM) quota on the server. -The quota applies to the directory and all its subdirectories (recursively). -Quotas that you specify on folders higher in the hierarchy further restrict the quota specified on a folder. - -## EXAMPLES - -### Example 1: Create a hard limit quota -``` -PS C:\>New-FsrmQuota -Path "C:\Shares" -Description "limit usage to 1 GB." -Size 1GB -``` - -This command creates a quota on C:\Shares and adds a description for the quota. -The quota is configured as a hard limit at 1GB in size that does not have any thresholds. -A hard limit quota prevents users from saving files after the space limit is reached and generates notifications when the volume of data reaches each configured threshold. - -### Example 2: Create a quota based on a quota template -``` -PS C:\>New-FsrmQuota -Path "C:\Shares" -Description "limit usage to 100 MB based on template." -Template "100 MB Limit" -``` - -This command creates a quota on C:\Shares based on the template named 100 MB Limit. -The command specifies a description for the quota that is different from the description in the template. -The quota is configured as a hard limit at 100 MB in size that does not have any thresholds. - -### Example 3: Create a soft limit quota that runs a command -``` -PS C:\>$Action = New-FsrmAction -Type Command -Command "c:\windows\system32\cmd.exe" -CommandParameters "echo [source file path] >> c:\log.txt" -ShouldLogError -PS C:\>$Threshold = New-FsrmQuotaThreshold -Percentage 90 -Action $action -PS C:\>New-FsrmQuota -Path "C:\Shares" -Size 128MB -Threshold $Threshold -Softlimit -``` - -This example creates a new quota on C:\Shares that has a soft limit at 128MB, a threshold at 90% usage, and that runs a custom command. - -The first command creates an FSRM action object and stores the results in the **$Action** variable. The action indicates that when an associated event occurs, the server run Cmd.exe with the specified parameters. The command specifies that server record errors codes from the executed command in the error log. -The second command creates a threshold object and stores the results in the **$Threshold** variable. The command specifies the percentage of the quota limit at which to execute the action, and specifies the action stored in the **$Action** variable. -The third command creates a quota on C:\Shares and specifies the threshold stored in the **$Threshold** variable. The Softlimit parameter indicates the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the quota. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the quota is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Size -Specifies the space limit that the quota template enforces. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftLimit -Indicates that the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Template -Specifies the name of a quota template on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Threshold -Specifies an array of threshold objects. - -The threshold object defines a percentage of used space from the available space that can be reached during a file operation, and a set of actions that the server takes when a quota reaches the threshold. -To perform the action when the quota is exceeded, set the threshold to 100 (percent). -You can use the New-FsrmQuotaThreshold cmdlet to create a threshold object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuota](./Get-FsrmQuota.md) - -[Set-FsrmQuota](./Set-FsrmQuota.md) - -[Update-FsrmQuota](./Update-FsrmQuota.md) - -[Reset-FsrmQuota](./Reset-FsrmQuota.md) - -[Remove-FsrmQuota](./Remove-FsrmQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuotaTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuotaTemplate.md deleted file mode 100644 index d3ca1a03bf..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuotaTemplate.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmquotatemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmQuotaTemplate - -## SYNOPSIS -Creates a quota template. - -## SYNTAX - -``` -New-FsrmQuotaTemplate [-Name] [-AsJob] [-CimSession ] [-Description ] - [-SoftLimit] [-Threshold ] [-ThrottleLimit ] -Size [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmQuotaTemplate** cmdlet creates a quota template. -A quota template defines a space limit, the type of quota (hard or soft), and (optionally) a set of notifications that the server generates automatically when quota usage reaches the threshold levels that you define. - -## EXAMPLES - -### Example 1: Create a hard limit quota template -``` -PS C:\>New-FsrmQuotaTemplate -Name "1GB limit" -Description "limit usage to 1 GB." -Size 1GB -``` - -This command creates a quota template named "1GB limit". -The command adds a description for the quota template and configures a hard size limit at 1GB that does not have any thresholds. -A hard limit quota prevents users from saving files after the space limit is reached and generates notifications when the volume of data reaches each threshold. - -### Example 2: Create a soft limit quota template that runs a command -``` -PS C:\>$Action = New-FsrmAction -Type Command -Command "c:\windows\system32\cmd.exe" -CommandParameters "echo [source file path] >> c:\log.txt" -ShouldLogError -PS C:\>$Threshold = New-FsrmQuotaThreshold -Percentage 90 -Action $action -PS C:\>New-FsrmQuotaTemplate -Name "128MB limit" -Size 128MB -Threshold $Threshold -Softlimit -``` - -This example creates a quota template that has a soft limit at 128MB, a threshold at 90% usage, and that runs a custom command. - -The first command creates an FSRM action object and stores the results in the **$Action** variable. The action indicates that when an associated event occurs, the server run Cmd.exe with the specified parameters. The command specifies that server record errors codes from the executed command in the error log. -The second command creates a threshold object and stores the results in the **$Threshold** variable. The command specifies the percentage of the quota limit at which to execute the action, and specifies the action stored in the **$Action** variable. -The third command creates a quota template named "128MB limit" and specifies the threshold stored in the **$Threshold** variable. The **Softlimit** parameter indicates the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the quota. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the quota. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Size -Specifies the size limit that the quota enforces. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SoftLimit -Indicates that the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Threshold -Specifies an array of threshold objects. - -The threshold object defines a percentage of used space from the available space that can be reached during a file operation, and a set of actions that the server takes when a quota reaches the threshold. -To perform the action when the quota is exceeded, set the threshold to 100 (percent). -You can use the New-FsrmQuotaThreshold cmdlet to create a threshold object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuotaTemplate - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuotaTemplate](./Get-FsrmQuotaTemplate.md) - -[Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) - -[Remove-FsrmQuotaTemplate](./Remove-FsrmQuotaTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuotaThreshold.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuotaThreshold.md deleted file mode 100644 index 7d6feb775d..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmQuotaThreshold.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmquotathreshold?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmQuotaThreshold - -## SYNOPSIS -Returns a quota threshold object. - -## SYNTAX - -``` -New-FsrmQuotaThreshold [-Percentage] [-Action ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmQuotaThreshold** cmdlet returns a threshold object. -You can use a threshold object to create File Server Resource Manager (FSRM) quotas and quota templates. - -## EXAMPLES - -### Example 1: Create a quota threshold -``` -PS C:\>$Action = New-FsrmAction -Type Command -Command "c:\windows\system32\cmd.exe" -CommandParameters "echo [source file path] >> c:\log.txt" -ShouldLogError PS C:\>New-FsrmQuotaThreshold -Percentage 90 -Action $Action -``` - -The first command creates an FSRM action object and stores the results in the **$Action** variable. -The action indicates that when an associated event occurs, the server runs Cmd.exe and uses the specified parameters. -The command specifies that the server records errors codes from the command in the error log. - -The second command returns a threshold object. -The command specifies that at 90 percent of the quota limit, the server runs the action stored in the **$Action** variable. - -## PARAMETERS - -### -Action -Specifies an array of FSRM actions. -You can create an action by using the New-FsrmAction cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Percentage -Specifies the percentage of the quota limit at which to run the action. -The maximum value you can set is 259. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuotaThreshold - -## NOTES - -## RELATED LINKS - -[New-FsrmQuota](./New-FsrmQuota.md) - -[Set-FsrmQuota](./Set-FsrmQuota.md) - -[New-FsrmQuotaTemplate](./New-FsrmQuotaTemplate.md) - -[Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) - -[New-FsrmAction](./New-FsrmAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmScheduledTask.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmScheduledTask.md deleted file mode 100644 index 406341290d..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmScheduledTask.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmscheduledtask?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmScheduledTask - -## SYNOPSIS -Creates a scheduled task object. - -## SYNTAX - -``` -New-FsrmScheduledTask [-Time] [-AsJob] [-CimSession ] [-Monthly ] - [-RunDuration ] [-ThrottleLimit ] [-Weekly ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmScheduledTask** cmdlet creates a scheduled task object that defines scheduling for reports, classification, and file management jobs. - -## EXAMPLES - -### Example 1: Create a weekly scheduled task -``` -PS C:\>$d = get-date "12:00am" PS C:\>New-FsrmScheduledTask -Time $d -Weekly @(Monday, Tuesday, Wednesday, Thursday, Friday) -``` - -The first command gets a **DateTime** object and stores it in the variable $d. - -The second command returns a **FsrmScheduledTask** object that defines a schedule that runs the task at midnight every day, Monday through Friday. - -### Example 2: Create a monthly scheduled task -``` -PS C:\>$d = get-date "12:00am" PS C:\>New-FsrmScheduledTask -Time $d -Monthly @(-1,15) -RunDuration 4 -``` - -The first command gets a **DateTime** object and stores it in the variable **$d**. - -This second command returns a **FsrmScheduledTask** object that describes a schedule that runs the task at midnight on the 15th and the last day of every month. -The **RunDuration** parameter specifies that the server terminates the process after 4 hours if the process has not ended. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Monthly -Specifies an array of days on which to run the task. -Specify a value of -1 to run the task on the last day of the month. -If you specify this parameter, do not specify the **Weekly** parameter. - -```yaml -Type: Int32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunDuration -Specifies the number of hours that the server runs the task before canceling it. -The value 0 indicates that the server runs the task to completion. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Time -Specifies a date and time value, in standard Coordinated Universal Time (UTC) format, to run the task. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Weekly -Specifies an array of weekdays on which to run the task. -If you specify this parameter, do not specify the **Monthly** parameter. - -```yaml -Type: FsrmScheduledTaskDaysEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMScheduledTask - -## NOTES - -## RELATED LINKS - -[Set-FsrmClassification](./Set-FsrmClassification.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Set-FsrmStorageReport](./Set-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmStorageReport.md deleted file mode 100644 index 01aa38bff3..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/New-FsrmStorageReport.md +++ /dev/null @@ -1,557 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/new-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-FsrmStorageReport - -## SYNOPSIS -Creates a storage report on the server. - -## SYNTAX - -``` -New-FsrmStorageReport [-Name] [-AsJob] [-CimSession ] [-FileGroupIncluded ] - [-FileOwnerFilePattern ] [-FileOwnerUser ] [-FileScreenAuditDaysSince ] - [-FileScreenAuditUser ] [-FolderPropertyName ] [-Interactive] [-LargeFileMinimum ] - [-LargeFilePattern ] [-LeastAccessedFilePattern ] [-LeastAccessedMinimum ] - [-MailTo ] [-MostAccessedFilePattern ] [-MostAccessedMaximum ] - [-PropertyFilePattern ] [-PropertyName ] [-QuotaMinimumUsage ] - [-ReportFormat ] [-Schedule ] [-ThrottleLimit ] - -Namespace -ReportType [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-FsrmStorageReport** cmdlet creates a storage report on the server. -A storage report job specifies a set of directories that the server analyzes to generate one or more report types that help you to better understand how storage is utilized in the specified directories. -You can configure report jobs to run according to a schedule or on demand. - -## EXAMPLES - -### Example 1: Create a large files storage report -``` -The first command gets a **DateTime** object and stores it in the **$d** variable. -PS C:\>$d = Get-Date "12:00am" - -This second command returns a **FsrmScheduledTask** object that describes a schedule that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = New-FsrmScheduledTask -Time $d.ToFileTimeUtc() -Monthly 1 - -The third command creates a LargeFiles storage report named "Find large files" on C:\Shares. The command sets the schedule for the report stored in the **$task** variable, and limits the report to files larger than 10MB. -PS C:\>New-FsrmStorageReport -Name "Find large files" -Namespace @("C:\Shares") -Schedule $task -ReportType @("LargeFiles") -LargeFileMinimum 10MB -``` - -This example creates a LargeFiles storage report that the server runs monthly and restricts the report to files larger than 10MB. - -### Example 2: Create a large files storage report by using a namespace condition -``` -The first command gets a **DateTime** object and stores it in the **$d** variable. -PS C:\>$d = get-date "12:00am" - -This second command returns an **FsrmScheduledTask** object that describes a schedule that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = new-FsrmScheduledTask -Time $d.ToFileTimeUtc() -Monthly 1 - -The third command creates a LargeFiles storage report named "Find large files" that generates a Large Files report on any folders whose Folder Usage property includes the User Data value. The command sets the schedule for the report stored in the **$task** variable. -PS C:\>New-FsrmStorageReport -Name "Find large files" -Namespace @("[FolderUsage=User Data]") -Schedule $task -ReportType @("LargeFiles") -``` - -This example creates a LargeFiles storage report that the server runs monthly and reports on any folders whose Folder Usage property includes the User Data value. -This example creates a LargeFiles storage report that the server runs monthly and restricts the report to files larger than 10MB. - -### Example 3: Create a storage report for files from a file group -``` -The first command gets a **DateTime** object and stores it in the **$d** variable. -PS C:\>$d = get-date "12:00am" - -This second command returns a **FsrmScheduledTask** object that describes a schedule that runs the task at midnight on the first day of the month. The command stores results in the **$task** variable. -PS C:\>$task = new-FsrmScheduledTask -Time $d.ToFileTimeUtc() -Monthly 1 - -The third command creates a storage report named "Find large files" and file groups on the folder C:\Shares. The command sets the schedule for the report stored in the **$task** variable, set the report type to LargeFiles and a FilesByFileGroup, limits the report to files larger than 10MB, and restricts the FilesByFileGroup report to include only files from the "Text files file" group. -PS C:\>New-FsrmStorageReport -Name "Find large files and file groups" -Namespace @("C:\Shares") -Schedule $task -ReportType @("LargeFiles", "FilesByFileGroup") -LargeFileMinimum 10MB -FileGroupIncluded "Text files" -``` - -This example creates a storage report that the server runs monthly and generates a LargeFiles and a FilesByFileGroup report. - -### Example 4: Create an interactive storage report -``` -PS C:\>New-FsrmStorageReport -Name "Find large files" -Namespace @("C:\Shares") -Interactive -ReportType @("LargeFiles") -``` - -This command creates a storage report named "Find large files" that the server runs immediately. -The command creates a LargeFile storage report for the folder C:\Shares. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileGroupIncluded -Specifies an array of names of file groups to include in the report. -Each string must be the name of a valid file group. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileOwnerFilePattern -Specifies a string of files to include in the file by owner report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set FilesByOwner for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileOwnerUser -Specifies an array of users, in **Domain\User** format, to include files for in the file by owner report. -The default value is an empty list, which indicates all users. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileScreenAuditDaysSince -Specifies the minimum number of days since the audit event to include in the report. -If you specify this parameter, you must set FileScreenAuditFiles for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FileScreenAuditUser -Specifies an array of user email addresses to include audit events for. -The default value is an empty list, which indicates all users. -If you specify this parameter, you must set FileScreenAuditFiles for the **ReportType** parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FolderPropertyName -Specifies a name of the classification property name to report on for a folder by property report. -Specify the value of the Name property in an **FsrmClassificationPropertyDefinition** object. -If you specify this parameter, you must set FoldersByProperty for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Interactive -Indicates that the report is interactive. -When you specify this parameter, the report does not require a schedule, the report cannot be modified, the report is generated immediately when you run this cmdlet, and the server removes the report automatically from the system when it finishes running the report. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LargeFileMinimum -Specifies the minimum file size to include in the large file report. -If you specify this parameter, you must set LargeFiles for the **ReportType** parameter. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LargeFilePattern -Specifies a string of files to include in the large file report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set LargeFiles for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LeastAccessedFilePattern -Specifies a string of files to include in the least frequently accessed report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set LeastRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LeastAccessedMinimum -Specifies the minimum number of days since the report was last accessed, to include in the least frequently accessed report. -If you specify this parameter, you must set LeastRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses for the recipients of an email. -\[Admin Email\] is a valid email address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MostAccessedFilePattern -Specifies a string of files to include in the most frequently accessed report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set MostRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MostAccessedMaximum -Specifies the maximum number of days since the report was last accessed, to include in the most frequently accessed report. -If you specify this parameter, you must set MostRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the storage report. -If you do not specify a name, the server generates a standard name. -You must specify this parameter if you specify the **Interactive** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies an array of namespaces that are part of the scope of the report. -Each string must be either a value of the FolderType property on the server, the string "All Shares", or a static path. -The FolderType properties must be in the format \[Folder type property name=\\]. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyFilePattern -Specifies a string of files to include in the file by property report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set FilesByProperty for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PropertyName -Specifies the name of the classification property to report on for a file by property report. -Specify the value of the Name property in an **FsrmClassificationPropertyDefinition** object. -If you specify this parameter, you must set FilesByProperty for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -QuotaMinimumUsage -Specifies the minimum quota usage level to include in the quota usage report. -If you specify this parameter, you must set QuotaUsage for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportFormat -Specifies an array of report formats that the classification report produces. -The acceptable values for this parameter are: -- DHTML -- HTML -- XML -- CSV -- Text - -```yaml -Type: StorageReportReportFormatsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportType -Specifies the types of reports that the action generates. -Specify this parameter only if you set the **Type** parameter to Report.The acceptable values for this parameter are: -- DuplicateFiles -- FilesByFileGroup -- FilesByOwner -- FilesByProperty -- LargeFiles -- LeastRecentlyAccessed -- MostRecentlyAccessed -- QuotaUsage - -```yaml -Type: StorageReportReportTypeEnum[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Schedule -Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for running the storage report. -Use the New-FsrmScheduledTask cmdlet to create a scheduled task object. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport - -## NOTES - -## RELATED LINKS - -[New-FsrmScheduledTask](./New-FsrmScheduledTask.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmAutoQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmAutoQuota.md deleted file mode 100644 index c2a817be55..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmAutoQuota.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmautoquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmAutoQuota - -## SYNOPSIS -Removes an auto apply quota from a server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmAutoQuota [-Path] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmAutoQuota [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmAutoQuota** cmdlet removes an auto apply quota from a server. -After you remove an auto apply quota, the server removes the quotas from the subfolders that were derived from the quota template associated with the auto apply quota. - -## EXAMPLES - -### Example 1: Remove an auto apply quota -``` -PS C:\>Remove-FsrmAutoQuota -Path "C:\Shares\NFSShare01" -``` - -This command removes the auto apply quota in the path C:\Shares\NFSShare01 and removes the quotas from the subfolders that were derived from the quota template associated with C:\Shares\NFSShare01. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmAutoQuota](./Get-FsrmAutoQuota.md) - -[Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) - -[New-FsrmAutoQuota](./New-FsrmAutoQuota.md) - -[Update-FsrmAutoQuota](./Update-FsrmAutoQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmClassificationPropertyDefinition.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmClassificationPropertyDefinition.md deleted file mode 100644 index d17ebb93d7..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmClassificationPropertyDefinition.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmclassificationpropertydefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmClassificationPropertyDefinition - -## SYNOPSIS -Removes classification property definitions. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmClassificationPropertyDefinition [-Name] [-AsJob] [-CimSession ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmClassificationPropertyDefinition [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmClassificationPropertyDefinition** cmdlet removes one or more classification property definitions from the server. -The cmdlet can remove only locally defined property definitions. - -## EXAMPLES - -### Example 1: Remove a classification property definition -``` -PS C:\>Remove-FsrmClassificationPropertyDefinition -Name "Business Impact" -``` - -This command removes the classification property definition named "Business Impact". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of property names. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - -[Set-FsrmClassificationPropertyDefinition](./Set-FsrmClassificationPropertyDefinition.md) - -[New-FsrmClassificationPropertyDefinition](./New-FsrmClassificationPropertyDefinition.md) - -[Remove-FsrmClassificationPropertyDefinition](./Remove-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmClassificationRule.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmClassificationRule.md deleted file mode 100644 index 4999b1d7a1..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmClassificationRule.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmclassificationrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmClassificationRule - -## SYNOPSIS -Removes classification rules. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmClassificationRule [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmClassificationRule [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmClassificationRule** cmdlet removes one or more classification rules from the server. -After you remove a classification rule, the classification property that it was associated with assigns a value to all files in a specified directory. - -## EXAMPLES - -### Example 1: Remove a classification rule by using a name -``` -PS C:\>Remove-FsrmClassificationRule -Name "Find confidential files" -``` - -This command removes the classification rule named "Find confidential files". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of classification rules. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationRule](./Get-FsrmClassificationRule.md) - -[Set-FsrmClassificationRule](./Set-FsrmClassificationRule.md) - -[New-FsrmClassificationRule](./New-FsrmClassificationRule.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileGroup.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileGroup.md deleted file mode 100644 index 9fca211d72..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileGroup.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmfilegroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmFileGroup - -## SYNOPSIS -Removes file groups from the server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmFileGroup [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmFileGroup [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmFileGroup** cmdlet removes file groups from the server. -After you remove a file group, the server cannot define file screens and file screen exceptions for the collection of file name patterns that you defined in the file group. - -## EXAMPLES - -### Example 1: Remove a file group -``` -PS C:\>Remove-FsrmFileGroup -Name "Media Files" -``` - -This command removes the file group named "Media Files". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file groups. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileGroup](./Get-FsrmFileGroup.md) - -[Set-FsrmFileGroup](./Set-FsrmFileGroup.md) - -[New-FsrmFileGroup](./New-FsrmFileGroup.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileManagementJob.md deleted file mode 100644 index ee76b350ff..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileManagementJob.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmFileManagementJob - -## SYNOPSIS -Removes file management jobs. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmFileManagementJob [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmFileManagementJob [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmFileManagementJob** cmdlet removes one or more file management jobs from the server. - -## EXAMPLES - -### Example 1: Remove a file management job -``` -PS C:\>Remove-FsrmFileManagentJob -Name "Encrypt Sensitive Files" -``` - -This command removes the file management job named "Encrypt Sensitive Files" from the server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file management jobs. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) - -[Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) - -[Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreen.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreen.md deleted file mode 100644 index 95a577f856..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreen.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmfilescreen?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmFileScreen - -## SYNOPSIS -Removes a file screen. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmFileScreen [-Path] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmFileScreen [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmFileScreen** cmdlet removes a files screen from the server. -After you remove a file screen, the server does not block groups of files from being saved to the folder that you specify in the **Path** parameter. - -## EXAMPLES - -### Example 1: Remove a file screen -``` -PS C:\>Remove-FsrmFileScreen -Path "C:\shares" -``` - -This command removes the file screen from the path C:\shares. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreen](./Get-FsrmFileScreen.md) - -[Set-FsrmFileScreen](./Set-FsrmFileScreen.md) - -[Reset-FsrmFileScreen](./Reset-FsrmFileScreen.md) - -[New-FsrmFileScreen](./New-FsrmFileScreen.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreenException.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreenException.md deleted file mode 100644 index 176a5a46d7..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreenException.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmfilescreenexception?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmFileScreenException - -## SYNOPSIS -Removes a file screen exception. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmFileScreenException [-Path] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmFileScreenException [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmFileScreenException** cmdlet removes a file screen exception from the server. -After you remove a file screen exception from a subfolder, the server applies the file screen associated with the parent folder to the subfolder. - -## EXAMPLES - -### Example 1: Remove a file screen exception -``` -PS C:\>Remove-FsrmFileScreenException -Path "C:\Shares\Ctrshare03" -``` - -This command removes the file screen exception from the path C:\Shares\Ctrshare03. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder that is associated with a file screen exception. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreenException](./Get-FsrmFileScreenException.md) - -[Set-FsrmFileScreenException](./Set-FsrmFileScreenException.md) - -[New-FsrmFileScreenException](./New-FsrmFileScreenException.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreenTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreenTemplate.md deleted file mode 100644 index 99e2539ece..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmFileScreenTemplate.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmfilescreentemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmFileScreenTemplate - -## SYNOPSIS -Removes file screen templates. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmFileScreenTemplate [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmFileScreenTemplate [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmFileScreenTemplate** cmdlet removes one or more file screen templates. -When you remove a file screen template, the file screens that were created with the original file screen template are not affected. - -## EXAMPLES - -### Example 1: Remove a file screen template -``` -PS C:\>Remove-FsrmFileScreenTemplate -Name "Stop media files" -``` - -This command removes the file screen template named "Stop media files". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file screen templates. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreenTemplate](./Get-FsrmFileScreenTemplate.md) - -[Set-FsrmFileScreenTemplate](./Set-FsrmFileScreenTemplate.md) - -[New-FsrmFileScreenTemplate](./New-FsrmFileScreenTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmMgmtProperty.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmMgmtProperty.md deleted file mode 100644 index 6ddac3f755..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmMgmtProperty.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmmgmtproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmMgmtProperty - -## SYNOPSIS -Removes a management property. - -## SYNTAX - -``` -Remove-FsrmMgmtProperty [-Name] [-AsJob] [-CimSession ] [-Namespace ] [-Recurse] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmMgmtProperty** cmdlet removes a management property from a namespace. -A management property is a classification property that includes Folder in its AppliesTo property and whose Flags property does not include the Secure value. -You can use the Get-FsrmClassificationPropertyDefinition cmdlet to get definitions of classification properties. - -## EXAMPLES - -### Example 1: Remove all management properties -``` -PS C:\>Remove-FsrmMgmtProperty -Name "FolderUsage_MS" -``` - -This command removes all management properties from the server that have the value FolderUsage_MS. - -### Example 2: Remove a management property by using a namespace -``` -PS C:\>Remove-FsrmMgmtProperty -Name "FolderUsage_MS" -Namespace "C:\Shares" -``` - -This command removes all management properties from the namespace C:\Shares that have the value FolderUsage_MS. - -### Example 3: Remove all management property in a namespace hierarchy -``` -PS C:\>Remove-FsrmMgmtProperty -Name "FolderUsage_MS" -Namespace "C:\Shares" -Recurse -``` - -This command removes all management properties that have the value FolderUsage_MS from the namespace C:\Shares and any namespaces below it in the hierarchy. - -### Example 4: Remove all management properties in a namespace hierarchy -``` -The first command gets all management properties on the server and stores the results in the **$props** variable. -PS C:\>$props = Get-FsrmMgmtProperty - -The second command is a script that identifies management properties where the property applied on folders dos not exist anymore. The script uses the **Remove-FsrmMgmtProperty** cmdlet to remove the management properties for which there is no corresponding property definition on the server. -PS C:\>$nonExistingProperties = $props | where { $_.Exists -ne $true} -foreach ($candidate in $nonExistingProperties) -{foreach ($prop in $_.Properties) {Remove-FsrmMgmtProperty -Name $prop.Name -Namespace $candidate.Namespace}} -``` - -This example removes all management properties from namespaces that do not exist on the server. -Property definitions are removed from a server by an administrator or as a result of group policy updates. -When you remove a property definition, the management property values that the server sets on folders by using the property definition are obsolete. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a management property. -Specify the value of the **Name** property in a **FsrmClassificationPropertyDefinition** object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies a local path to a folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Recurse -Indicates that this cmdlet removes management properties for all folders that contain management properties in the namespace. -If you specify this parameter, you must specify the **Namespace** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmMgmtProperty](./Get-FsrmMgmtProperty.md) - -[Set-FsrmMgmtProperty](./Set-FsrmMgmtProperty.md) - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmQuota.md deleted file mode 100644 index 167e03878d..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmQuota.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmQuota - -## SYNOPSIS -Removes a FSRM quota from the server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmQuota [-Path] [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmQuota [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmQuota** cmdlet removes a FSRM quota from the server. -After you remove a quota, the disk space that the server allocates for the volume or folder to which the quota was applied is unlimited. - -## EXAMPLES - -### Example 1: Remove a quota -``` -PS C:\>Remove-FsrmQuota -Path "C:\Shares" -``` - -This command removes the quota from the path C:\Shares. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the local folder that contains the quota. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuota](./Get-FsrmQuota.md) - -[New-FsrmQuota](./New-FsrmQuota.md) - -[Set-FsrmQuota](./Set-FsrmQuota.md) - -[Reset-FsrmQuota](./Reset-FsrmQuota.md) - -[Update-FsrmQuota](./Update-FsrmQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmQuotaTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmQuotaTemplate.md deleted file mode 100644 index 2191236e42..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmQuotaTemplate.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmquotatemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmQuotaTemplate - -## SYNOPSIS -Removes FSRM quota templates. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmQuotaTemplate [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmQuotaTemplate [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmQuotaTemplate** cmdlet removesone or more File Server Resource Manager (FSRM) quota templates. -When you remove a quota template, the quotas that were derived from the quota template remain unchanged. - -## EXAMPLES - -### Example 1: Remove a quota template -``` -PS C:\>Remove-FsrmQuotaTemplate "1GB limit" -``` - -This command removes the quota template named "1GB limit". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of quota templates. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuotaTemplate](./Get-FsrmQuotaTemplate.md) - -[Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) - -[New-FsrmQuotaTemplate](./New-FsrmQuotaTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmStorageReport.md deleted file mode 100644 index 21a24460c1..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Remove-FsrmStorageReport.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/remove-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-FsrmStorageReport - -## SYNOPSIS -Removes storage reports. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-FsrmStorageReport [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-FsrmStorageReport [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-FsrmStorageReport** cmdlet removes one or more storage reports from the server. -You cannot remove an interactive or incident report. - -## EXAMPLES - -### Example 1: Remove a storage report -``` -PS C:\>Remove-FsrmStorageReport -Name "Monthly report" -``` - -This command removes the storage report named "Monthly report". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of storage reports. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmStorageReport](./Get-FsrmStorageReport.md) - -[Set-FsrmStorageReport](./Set-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[Start-FsrmStorageReport](./Start-FsrmStorageReport.md) - -[Stop-FsrmStorageReport](./Stop-FsrmStorageReport.md) - -[Wait-FsrmStorageReport](./Wait-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Reset-FsrmFileScreen.md b/docset/winserver2012-ps/fileserverresourcemanager/Reset-FsrmFileScreen.md deleted file mode 100644 index a748c99a3b..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Reset-FsrmFileScreen.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/reset-fsrmfilescreen?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-FsrmFileScreen - -## SYNOPSIS -Resets the default settings for all file screen parameters. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Reset-FsrmFileScreen [-Path] [-Template] [-AsJob] [-CimSession ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Reset-FsrmFileScreen [-Template] [-AsJob] [-CimSession ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Reset-FsrmFileScreen** cmdlet resets the default settings for all file screen parameters with the settings from the template that you specify. - -## EXAMPLES - -### Example 1: Reset a file screen -``` -PS C:\>Reset-FsrmFileScreen -Path "C:\shares" -Template "Filter Text files" -``` - -This command resets the file screen on C:\shares. -After the cmdlet runs, the file screen uses the settings from the template named "Filter Text files" and links to that template. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Template -Specifies a file screen template on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreen](./Get-FsrmFileScreen.md) - -[Set-FsrmFileScreen](./Set-FsrmFileScreen.md) - -[New-FsrmFileScreen](./New-FsrmFileScreen.md) - -[Remove-FsrmFileScreen](./Remove-FsrmFileScreen.md) - -[Get-FsrmFileScreenTemplate](./Get-FsrmFileScreenTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Reset-FsrmQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Reset-FsrmQuota.md deleted file mode 100644 index 052be1e432..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Reset-FsrmQuota.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/reset-fsrmquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-FsrmQuota - -## SYNOPSIS -Updates configuration settings of a FSRM quota. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Reset-FsrmQuota [-Path] [-Template] [-AsJob] [-CimSession ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Reset-FsrmQuota [-Template] [-AsJob] [-CimSession ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Reset-FsrmQuota** cmdlet updates the configuration settings of a File Server Resource Manager (FSRM) quota with the settings of a quota template. - -## EXAMPLES - -### Example 1: Update a quota -``` -PS C:\>Reset-FsrmQuota -Path "C:\Shares" -Template "100 MB Limit" -``` - -This command updates the quota on C:\Shares with the settings of the quota template named "100 MB Limit". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the local folder that contains the quota. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Template -Specifies the name of a quota template on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuota](./Get-FsrmQuota.md) - -[Set-FsrmQuota](./Set-FsrmQuota.md) - -[Update-FsrmQuota](./Update-FsrmQuota.md) - -[New-FsrmQuota](./New-FsrmQuota.md) - -[Remove-FsrmQuota](./Remove-FsrmQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Send-FsrmTestEmail.md b/docset/winserver2012-ps/fileserverresourcemanager/Send-FsrmTestEmail.md deleted file mode 100644 index 1ca0e4fb6c..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Send-FsrmTestEmail.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/send-fsrmtestemail?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Send-FsrmTestEmail - -## SYNOPSIS -Sends a test email message. - -## SYNTAX - -``` -Send-FsrmTestEmail [-AsJob] [-CimSession ] [-ThrottleLimit ] -ToEmailAddress - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Send-FsrmTestEmail** cmdlet sends an email message to test the email settings in File Server Resource Manager (FSRM). -This cmdlet tests the SMTP server that you specify in the Set-FsrmSetting cmdlet. -The subject and message body are predefined, localized text. - -## EXAMPLES - -### Example 1: Send a test email -``` -PS C:\>Send-FsrmTestEmail -ToEmailAddress "admin@contoso.com" -``` - -This command sends a test email message to admin@contoso.com. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToEmailAddress -Specifies a valid email address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmSetting](./Get-FsrmSetting.md) - -[Set-FsrmSetting](./Set-FsrmSetting.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmAdrSetting.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmAdrSetting.md deleted file mode 100644 index 804adde14d..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmAdrSetting.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmadrsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmAdrSetting - -## SYNOPSIS -Changes configuration settings for access denied remediation. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmAdrSetting [-Event] [-AllowRequests] [-AsJob] [-CimSession ] - [-DeviceTroubleshooting] [-DisplayMessage ] [-EmailMessage ] [-Enabled] [-EventLog] - [-IncludeDeviceClaims] [-IncludeUserClaims] [-MailCCAdmin] [-MailTo ] [-MailToOwner] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmAdrSetting [-AllowRequests] [-AsJob] [-CimSession ] [-DeviceTroubleshooting] - [-DisplayMessage ] [-EmailMessage ] [-Enabled] [-EventLog] [-IncludeDeviceClaims] - [-IncludeUserClaims] [-MailCCAdmin] [-MailTo ] [-MailToOwner] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmAdrSetting** cmdlet changes configuration settings for access denied remediation (ADR) for one or more events. -The File Server Resource Manager (FSRM) uses the ADR settings when a client cannot access a file. -Users get an access-denied message when they try to access shared files and folders on a file server for which they do not have permissions. - -## EXAMPLES - -### Example 1: Change ADR settings for an event -``` -PS C:\>Set-FsrmAdrSetting -Event AccessDenied -Enabled -DisplayMessage "Access to file is denied" -EmailMessage "Access to file is denied. You can email a request for permission to access the file." -AllowRequests -MailToOwner:$false -MailCCAdmin -MailTo "john@contoso.com" -IncludeDeviceClaims -IncludeUserClaims -EventLog -DeviceTroubleShooting -``` - -This command changes ADR settings for the AccessDenied event. -The command enables remediation for the AccessDenied event, specifies the display message and email message for the event, and indicates that users can request access by sending email. - -## PARAMETERS - -### -AllowRequests -Indicates that users can request access by sending email. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceTroubleshooting -Indicates that Windows shows the user the device claims in the access-denied message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayMessage -Specifies the message that the file server displays to the user when the server receives the event. -The length of the string must not exceed 10KB. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailMessage -Specifies the email message that the file server sends to the user when the server receives the event. -The length of the string must not exceed 10KB. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Indicates that remediation is enabled for events on this server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Event -Specifies an array of types of events that ADR handles. -The acceptable values for this parameter are: AccessDenied and FileNotFound. - -```yaml -Type: FsrmAdrEventEnum[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EventLog -Indicates that the server creates an Event Log entry for each access request email that the file server sends. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeDeviceClaims -Indicates that the file server includes device claims when a user requests access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeUserClaims -Indicates that the file server includes user claims when a user requests access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MailCCAdmin -Indicates that the file server includes the system administrator on the CC line of the email message when a user requests access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses to which the file server sends the request. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailToOwner -Indicates that the file server emails the data owner when a user requests access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmAdrSetting](./Get-FsrmAdrSetting.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmAutoQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmAutoQuota.md deleted file mode 100644 index 6ec971830a..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmAutoQuota.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmautoquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmAutoQuota - -## SYNOPSIS -Changes configuration settings of an auto apply quota. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmAutoQuota [-Path] [-AsJob] [-CimSession ] [-Disabled] [-PassThru] - [-Template ] [-ThrottleLimit ] [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmAutoQuota [-AsJob] [-CimSession ] [-Disabled] [-PassThru] [-Template ] - [-ThrottleLimit ] [-UpdateDerived] [-UpdateDerivedMatching] -InputObject [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmAutoQuota** cmdlet changes configuration settings of an auto apply quota. -If you want to keep the existing quotas unchanged but make the modified auto apply quota effective for new subfolders in the auto apply quota path, do not specify either the **UpdateDerived** or **UpdateDerivedMatching** parameters. - -When you make changes to an auto apply quota, you have the option of extending those changes to existing quotas in the auto apply quota path. -You can specify the **UpdateDerivedMatching** parameter to modify only those quotas that still match the original auto apply quota, or you can specify the **UpdateDerived** parameter to modify all quotas in the auto apply quota path, regardless of any modifications that you made to the quotas since you created them. - -## EXAMPLES - -### Example 1: Set the template for an auto apply quota -``` -PS C:\>Set-FsrmAutoQuota -Path "C:\Shares\CtrShare01" -Template "200 MB Limit Reports to User" -``` - -This command sets the template named "200 MB Limit Reports to User" for the auto apply quota on the folder named C:\Shares\CtrShare01. - -### Example 2: Set the template for all quotas -``` -PS C:\>Set-FsrmAutoQuota -Path "C:\Shares\CtrShare01" -Template "200 MB Limit Reports to User" -UpdateDerived -``` - -This command sets the template named "200 MB Limit Reports to User" for all existing quotas in the auto apply quota path named C:\Shares\CtrShare01. - -### Example 3: Set the template for unmodified quotas -``` -PS C:\>Set-FsrmAutoQuota -Path "C:\Shares\CtrShare01" -Template "200 MB Limit Reports to User" -UpdateDerivedMatching -``` - -This command sets the template named 200 MB Limit Reports to User for only the quotas in the auto apply quota path named C:\Shares\CtrShare01 that have not been modified since they were automatically generated. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the auto apply quota is inactive. -The server does not track quota data for the quota and does not run any action associated with quota thresholds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Template -Specifies a name of a quota template on the server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDerived -Indicates that the server modifies all existing quotas in the auto apply quota path. - -If you specify this parameter, you cannot specify the **UpdateDerivedMatching** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDerivedMatching -Indicates that the server updates only the quotas in the auto apply quota path that have not been modified since they were automatically generated. -Specify this parameter if you have quotas that have been modified since they were automatically generated, and you do not want to change them. - -If you specify this parameter, you cannot specify the **UpdateDerived** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMAutoQuota - -## NOTES - -## RELATED LINKS - -[Get-FsrmAutoQuota](./Get-FsrmAutoQuota.md) - -[Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) - -[New-FsrmAutoQuota](./New-FsrmAutoQuota.md) - -[Remove-FsrmAutoQuota](./Remove-FsrmAutoQuota.md) - -[Update-FsrmAutoQuota](./Update-FsrmAutoQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassification.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassification.md deleted file mode 100644 index fead106d2d..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassification.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmclassification?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmClassification - -## SYNOPSIS -Changes configuration settings for classification. - -## SYNTAX - -``` -Set-FsrmClassification [-AsJob] [-CimSession ] [-Continuous] [-ContinuousLog] - [-ContinuousLogSize ] [-ExcludeNamespace ] [-InputObject ] [-PassThru] - [-Schedule ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmClassification** cmdlet changes configuration settings for classification. - -## EXAMPLES - -### Example 1: Set classification to run continuously -``` -PS C:\>Set-FsrmClassification -Continuous -ContinuousLog -``` - -This command sets classification to run continuously and enables the continuous classification log. -If you have not previously created a classification schedule, the command results in an error. - -### Example 2: Set the schedule for classification -``` -The first command gets a **DateTime** object and stores it in the variable **$d**. -PS C:\>$d = Get-Date "12:00am" - -The second command creates a **FsrmScheduledTask** object that defines a schedule for the task of once a month on the first day of the month at midnight. The command stores the **FsrmScheduledTask** object in the **$task** variable. -PS C:\>$task = New-FsrmScheduledTask -Time $d.ToFileTimeUtc() -Monthly 1 - -The third command sets the schedule for classification to the schedule stored in the **$task** variable. -PS C:\>Set-FsrmClassification -Schedule $task -``` - -This example sets the schedule for classification to run once a month on the first day at midnight. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Continuous -Indicates that the server continuously applies classification to files in the background. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContinuousLog -Indicates that the server maintains a log of continuous classification activities. -You must specify the **Continuous** parameter to log classification activities. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContinuousLogSize -Specifies the maximum size of the log that contains continuous classification activity. -You must specify the **Continuous** parameter to log classification activities. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeNamespace -Specifies an array of strings that contain the list of folders to not include in classification (scheduled or continuous). - -You can include \[AllVolumes\] in each folder at the start of a path to indicate that the namespace is excluded on all volumes. -You can append the string /s to each namespace to exclude all folders and files in that namespace. -If /s is not appended to the namespace, only the files in the specified folder are excluded. -If one string is \[Default\], the server adds the default values to the exclude namespaces. -The boot volume is always excluded regardless of this value. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for performing the continuous classification. -Use the New-FsrmScheduledTask cmdlet to create a scheduled task object. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassification - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassification](./Get-FsrmClassification.md) - -[Start-FsrmClassification](./Start-FsrmClassification.md) - -[Stop-FsrmClassification](./Stop-FsrmClassification.md) - -[Wait-FsrmClassification](./Wait-FsrmClassification.md) - -[New-FsrmScheduledTask](./New-FsrmScheduledTask.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassificationPropertyDefinition.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassificationPropertyDefinition.md deleted file mode 100644 index 4cce5719dc..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassificationPropertyDefinition.md +++ /dev/null @@ -1,250 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmclassificationpropertydefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmClassificationPropertyDefinition - -## SYNOPSIS -Changes a classification property definition. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmClassificationPropertyDefinition [-Name] [-AsJob] [-CimSession ] - [-Description ] [-DisplayName ] [-Parameters ] [-PassThru] - [-PossibleValue ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmClassificationPropertyDefinition [-AsJob] [-CimSession ] [-Description ] - [-DisplayName ] [-Parameters ] [-PassThru] [-PossibleValue ] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmClassificationPropertyDefinition** cmdlet changes a classification property definition. - -## EXAMPLES - -### Example 1: Change the display name of a classification property definition -``` -PS C:\>Set-FsrmClassificationPropertyDefinition -Name "MgmtPI02" -DisplayName "Central Management Information" -``` - -This command changes the display name of the classification property definition named "MgmtPI02". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies an optional name for the property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of property names. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Parameters -Specifies an array of strings using the format \=\. -The File Classification Infrastructure and other management tools use these parameters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PossibleValue -Specifies an array of property values. -The default value is an empty list. -You can use the New-FsrmClassificationPropertyValue cmdlet to create possible values for a classification property. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationPropertyDefinition - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - -[New-FsrmClassificationPropertyDefinition](./New-FsrmClassificationPropertyDefinition.md) - -[Update-FsrmClassificationPropertyDefinition](./Update-FsrmClassificationPropertyDefinition.md) - -[Remove-FsrmClassificationPropertyDefinition](./Remove-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassificationRule.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassificationRule.md deleted file mode 100644 index f2e6b05020..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmClassificationRule.md +++ /dev/null @@ -1,380 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmclassificationrule?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmClassificationRule - -## SYNOPSIS -Changes configuration settings of classification rules. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmClassificationRule [-Name] [-AsJob] [-CimSession ] - [-ClassificationMechanism ] [-ContentRegularExpression ] [-ContentString ] - [-ContentStringCaseSensitive ] [-Description ] [-Disabled] [-Flags ] - [-Namespace ] [-Parameters ] [-PassThru] [-Property ] [-PropertyValue ] - [-ReevaluateProperty ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmClassificationRule [-AsJob] [-CimSession ] [-ClassificationMechanism ] - [-ContentRegularExpression ] [-ContentString ] [-ContentStringCaseSensitive ] - [-Description ] [-Disabled] [-Flags ] [-Namespace ] - [-Parameters ] [-PassThru] [-Property ] [-PropertyValue ] - [-ReevaluateProperty ] [-ThrottleLimit ] -InputObject - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmClassificationRule** cmdlet changes configuration settings of one or more classification rules. - -## EXAMPLES - -### Example 1: Change a classification rule -``` -PS C:\>Set-FsrmClassificationRule -Name "Find confidential files" -ContentString @("confidential", "secret") -``` - -This command changes the "Find confidential files" rule to search for the strings "confidential" and "secret". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClassificationMechanism -Specifies the name of a valid classification mechanism available on the server for assigning the property value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentRegularExpression -Specifies an array of regular expressions for pattern matching. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentString -Specifies an array of strings for the content classifier to search for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContentStringCaseSensitive -Specifies an array of content sensitive strings for the content classifier to search for. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the classification rule. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the classification rule is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Flags -Specifies an array of flags that define the possible states of the rule. - -```yaml -Type: RuleFlagsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of classification rules. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies an array of namespaces where the rule is applied. -Each value must be either a value of the FolderType property defined on the server (in the format "\[Folder type property name=\\]") or a static path. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies an array of strings using the format \=\. -The File Classification Infrastructure and other management tools use these parameters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Property -Specifies the name of a classification property definition to set. -Specify the value of the **Name** property in an **FsrmClassificationPropertyDefinition** object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyValue -Specifies the property value that the rule will assign. -The property value that you set must be a valid value supported by the classification mechanism that you specify in the **ClassificationMechanism** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReevaluateProperty -Specifies the evaluation policy of the rule. -The acceptable values for this parameter are: -- Never: Assign values to properties only if that property does not already have a value for the file. -- Overwrite: Reclassify files when the files change and overwrite this property. -- Aggregate: Reclassify files when the files change and aggregate the new value for the property with the existing value. - -```yaml -Type: RuleReevaluatePropertyEnum -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Never -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassificationRule - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassificationRule](./Get-FsrmClassificationRule.md) - -[New-FsrmClassificationRule](./New-FsrmClassificationRule.md) - -[Remove-FsrmClassificationRule](./Remove-FsrmClassificationRule.md) - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileGroup.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileGroup.md deleted file mode 100644 index 9bd71bf4ee..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileGroup.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmfilegroup?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmFileGroup - -## SYNOPSIS -Changes configuration settings for file groups. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmFileGroup [-Name] [-AsJob] [-CimSession ] [-Description ] - [-ExcludePattern ] [-IncludePattern ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmFileGroup [-AsJob] [-CimSession ] [-Description ] [-ExcludePattern ] - [-IncludePattern ] [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmFileGroup** cmdlet changes configuration settings for one or more file groups on the server. -The file group consists of two collections of wildcard patterns for file names. -One collection indicates file names that the server includes for file screens, and the other collection indicates file names that the server does not include for file screens. - -## EXAMPLES - -### Example 1: Change the include pattern of a file group -``` -PS C:\>Set-FsrmFileGroup -Name "Media Files" -IncludePattern @("*.mp3", "*.wmv") -``` - -This command changes the file group named "Media Files". -After the cmdlet runs, the file group includes only files whose name ends in mp3 or wmv. - -### Example 2: Change the include pattern of a file group by using an object variable -``` -The first command gets the file group named "Media Files" and stored the results in the variable **$Group**. -PS C:\>$Group = Get-FsrmFileGroup "Media Files" - -The second command specifies an include pattern that includes .wma files for the file group stored in the variable **$Group**. The command stores the result in the **$list** variable. -PS C:\>$list = $Group.IncludePattern + "*.wma" - -The third command sets the include pattern for the file group named "Media Files" to the include pattern stored in the variable **$list**. -PS C:\>Set-FsrmFileGroup -Name "Media Files" -IncludePattern $list -``` - -This example changes the file group named "Media Files". -After the cmdlet runs, the file group also includes .wma files. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludePattern -Specifies an array of pattern strings that can include * and ? -as wildcard characters. -The maximum size of a string is 1 KB. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludePattern -Specifies an array of pattern strings that can include * and ? -as wildcard characters. -The maximum size of a string is 1 KB. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file groups. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileGroup - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileGroup](./Get-FsrmFileGroup.md) - -[New-FsrmFileGroup](./New-FsrmFileGroup.md) - -[Remove-FsrmFileGroup](./Remove-FsrmFileGroup.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileManagementJob.md deleted file mode 100644 index d30caa8ecb..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileManagementJob.md +++ /dev/null @@ -1,447 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmFileManagementJob - -## SYNOPSIS -Changes configuration settings of a file management job. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmFileManagementJob [-Name] [-Action ] [-AsJob] [-CimSession ] - [-Condition ] [-Continuous] [-ContinuousLog] [-ContinuousLogSize ] - [-Description ] [-Disabled] [-MailTo ] [-Namespace ] [-Notification ] - [-Parameters ] [-PassThru] [-ReportFormat ] - [-ReportLog ] [-Schedule ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmFileManagementJob [-Action ] [-AsJob] [-CimSession ] - [-Condition ] [-Continuous] [-ContinuousLog] [-ContinuousLogSize ] - [-Description ] [-Disabled] [-MailTo ] [-Namespace ] [-Notification ] - [-Parameters ] [-PassThru] [-ReportFormat ] - [-ReportLog ] [-Schedule ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmFileManagementJob** cmdlet changes configuration settings of a file management job. -You must specify at least one other parameter in addition to the **Name** parameter. - -## EXAMPLES - -### Example 1: Change the condition for a file management job -``` -The first command returns a condition object for file management job that verifies that a file has a PII classification property set to true. The command stores the results in the **$condition** variable. -PS C:\>$condition = New-FsrmFmjCondition -Property "PII" -Condition Equal -Value "1" - -The second command gets the file management job named "Expire stale data" and stores the results in the **$current** variable. -PS C:\>$current = Get-FsrmFileManagementJob -Name "Expire stale data" - -The third command adds the new condition to the existing conditions of the file management job. -PS C:\>$newConditions = $current.Conditions + $condition - -The fourth command sets the condition of the file management job named "Expire stale data" to the condition stored in the **$newConditions** variable. -PS C:\>Set-FsrmFileManagementJob "Expire stale data" -Condition $newConditions -``` - -This example changes the file management job named Expire stale data to include only files that have the PII property set to true in addition to the existing conditions. - -## PARAMETERS - -### -Action -Specifies a **FsrmFmjAction** object. -You can use the New-FsrmFmjAction cmdlet to create a **FsrmFmjAction** object. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Condition -Specifies a **FsrmFmjCondition** object. -You can use the New-FsrmFmjCondition cmdlet to create a **FsrmFmjCondition** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Continuous -Indicates that the server continuously applies classification to files in the background. - -If you specify this parameter, you cannot specify any notifications and the conditions that you specify cannot include any objects where the classification property is set to the following values: -- File.DateCreated -- File.DateLastModified -- File.DateLastAccessed - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContinuousLog -Indicates that the server maintains a log of continuous classification activities. -You must specify the **Continuous** parameter to log classification activities. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ContinuousLogSize -Specifies the maximum size of the log that contains continuous classification activity. -You must specify the **Continuous** parameter to log classification activities. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file management job. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the file management job is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses to which the file server sends the email. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the file management job. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies an array of namespaces that are part of the scope. -Each value must be either a value of the FolderType property defined on the server (in the format "\[Folder type property name=\\]") or a static path. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notification -Specifies a **FsrmFmjNotificationAction** object. -You can use the New-FsrmFmjNotificationAction cmdlet to create a **FsrmFmjNotificationAction** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parameters -Specifies an array of strings using the format \=\. -The File Classification Infrastructure and other management tools use these parameters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFormat -Specifies an array of report formats that the file management job produces. -The acceptable values for this parameter are: -- DHTML -- HTML -- XML -- CSV -- Text - -```yaml -Type: FmjReportFormatsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: {"DHTML", "XML"} -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLog -Specifies an array of report types that the file management job generates. -The acceptable values for this parameter are: -- Information -- Error -- Audit - -```yaml -Type: FmjReportLogsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for performing the continuous classification. -Use the New-FsrmScheduledTask cmdlet to create a scheduled task object. -Any duration information in the FSRM scheduled task object is ignored. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) - -[Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) - -[Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) - -[Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) - -[New-FsrmScheduledTask](./New-FsrmScheduledTask.md) - -[New-FsrmFmjCondition](./New-FsrmFmjCondition.md) - -[New-FsrmFmjNotificationAction](./New-FsrmFmjNotificationAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreen.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreen.md deleted file mode 100644 index cf0034b520..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreen.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmfilescreen?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmFileScreen - -## SYNOPSIS -Changes configuration settings of a file screen. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmFileScreen [-Path] [-Active] [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-Notification ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmFileScreen [-Active] [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-Notification ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmFileScreen** cmdlet changes configuration settings of a file screen on the server. -A file screen blocks users from saving groups of files on a volume or in a folder tree. - -If you specify the **Active** parameter, the file screen prevents users from saving files that are members of blocked file groups, and generates notifications when users try to save blocked files. -The file screen does not prevent users and applications from accessing files that were saved to the path before the file screen was created, regardless of whether the files are members of blocked file groups. - -## EXAMPLES - -### Example 1: Change the include group for a file screen -``` -PS C:\>Set-FsrmFileScreen -Path "C:\share1" -IncludeGroup @("Media Files", "Text Files") -``` - -This command changes the file screen on c:\share1 to include both Media Files and Text Files. - -## PARAMETERS - -### -Active -Indicates that the server fails any I/O operation that violates the file screen. -If you do not specify this parameter, the server does not fail violating I/O operations and still runs any action that is associated with the file screen. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file screen. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroup -Specifies an array of names of file groups. -The file groups contain the file name patterns that the server uses to specify the files that are blocked by this screen. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Notification -Specifies an array of notification action objects. -You can use the New-FsrmFmjNotificationAction cmdlet to create a **FsrmFmjNotificationAction** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreen - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreen](./Get-FsrmFileScreen.md) - -[New-FsrmFileScreen](./New-FsrmFileScreen.md) - -[Reset-FsrmFileScreen](./Reset-FsrmFileScreen.md) - -[Remove-FsrmFileScreen](./Remove-FsrmFileScreen.md) - -[Get-FsrmFileGroup](./Get-FsrmFileGroup.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreenException.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreenException.md deleted file mode 100644 index 8147351e9b..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreenException.md +++ /dev/null @@ -1,215 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmfilescreenexception?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmFileScreenException - -## SYNOPSIS -Changes configuration settings of a file screen exception. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmFileScreenException [-Path] [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmFileScreenException [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmFileScreenException** cmdlet changes configuration settings of a file screen exception. -You can use this cmdlet to change the description of a file screen exception and change the file groups that you want to exclude from file screening. - -## EXAMPLES - -### Example 1: Change the include group for a file screen exception -``` -PS C:\>New-FsrmFileScreenException -Path "C:\Shares\Ctrshare03" -IncludeGroup "Text Files" -``` - -This command changes the file screen exception on C:\Shares\Ctrshare03 to allow users to create files that are part of the "Text Files" file group. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file screen exception. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroup -Specifies an array of names of file groups that you want to exclude from file screening. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder that is associated with a file screen exception. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenException - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreenException](./Get-FsrmFileScreenException.md) - -[New-FsrmFileScreenException](./New-FsrmFileScreenException.md) - -[Remove-FsrmFileScreenException](./Remove-FsrmFileScreenException.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreenTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreenTemplate.md deleted file mode 100644 index 7d15b23f71..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmFileScreenTemplate.md +++ /dev/null @@ -1,292 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmfilescreentemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmFileScreenTemplate - -## SYNOPSIS -Changes configuration settings of a file screen template. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmFileScreenTemplate [-Name] [-Active] [-AsJob] [-CimSession ] - [-Description ] [-IncludeGroup ] [-Notification ] [-PassThru] - [-ThrottleLimit ] [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmFileScreenTemplate [-Active] [-AsJob] [-CimSession ] [-Description ] - [-IncludeGroup ] [-Notification ] [-PassThru] [-ThrottleLimit ] - [-UpdateDerived] [-UpdateDerivedMatching] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmFileScreenTemplate** cmdlet changes configuration settings of a file screen template. - -When you make changes to a file screen template, you have the option of extending those changes to existing file screens that were created with the original file screen template. -You can specify the **UpdateDerivedMatching** parameter to modify only those quotas that still match the original file screen template, or you can specify the **UpdateDerived** parameter to modify all file screens that were created with the original file screen template, regardless of any modifications that you made to the file screens. - -## EXAMPLES - -### Example 1: Change the include group for a file screen template -``` -PS C:\>Set-FsrmFileScreenTemplate -Name "Filter Media files" -IncludeGroup @("Media Files", "Text Files") -``` - -This command changes a file screen template named "Filter Media files" to include both media files and text files. - -### Example 2: Changes the include group for a file screen template and derived file screen templates -``` -PS C:\>Set-FsrmFileScreenTemplate "1GB limit" -IncludeGroup @("Media Files", "Text Files") -UpdateDerived -``` - -This command updates a file screen template named "1GB limit" to include both media files and text files. -The server also updates these settings in any file screens that derive from this template. - -## PARAMETERS - -### -Active -Indicates that the server fails any I/O operation that violates the file screen. -If you do not specify this parameter, the server does not fail violating I/O operations and still runs any action that is associated with the file screen. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the file screen template. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeGroup -Specifies an array of names of file groups that you want to exclude from file screening. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a file screen template. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Notification -Specifies an array of notification action objects. -You can use the New-FsrmFmjNotificationAction cmdlet to create a **FsrmFmjNotificationAction** object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDerived -Indicates that the server modifies all existing file screens that were created with the original file screen template. -If you specify this parameter, you cannot specify the **UpdateDerivedMatching** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UpdateDerivedMatching -Indicates that the server updates only the file screens that you have not modified since you created them with the original file screen template. -If you specify this parameter, you cannot specify the **UpdateDerived** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileScreenTemplate - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileScreenTemplate](./Get-FsrmFileScreenTemplate.md) - -[New-FsrmFileScreenTemplate](./New-FsrmFileScreenTemplate.md) - -[Remove-FsrmFileScreenTemplate](./Remove-FsrmFileScreenTemplate.md) - -[New-FsrmFmjNotificationAction](./New-FsrmFmjNotificationAction.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmMgmtProperty.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmMgmtProperty.md deleted file mode 100644 index ddf44a6cd4..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmMgmtProperty.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmmgmtproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmMgmtProperty - -## SYNOPSIS -Changes the setting of a management property. - -## SYNTAX - -``` -Set-FsrmMgmtProperty [-AsJob] [-CimSession ] [-Name ] [-Namespace ] - [-ThrottleLimit ] [-Value ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmMgmtProperty** cmdlet changes the setting of a management property value. -If the folder that you specify in the **Namespace** parameter does not exist, the cmdlet still succeeds. -If the folder is renamed or moved, the namespace retains its management properties. - -A management property is a classification property that includes Folder in its AppliesTo property and whose Flags property does not include the Secure value. -You can use the Get-FsrmClassificationPropertyDefinition cmdlet to get definitions of classification properties. - -## EXAMPLES - -### Example 1: Change a management property value -``` -PS C:\>Set-FsrmMgmtProperty -Namespace "C:\Shares" -Name "FolderUsage_MS" -Value "User Data" -``` - -This command changes the Folder Usage property to have the value "User Data" for the C:\Shares namespace. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a management property. -Specify the value of the Name property in a **FsrmClassificationPropertyDefinition** object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies a local path to a folder. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies a value that the cmdlet assigns to the management property. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMMgmtProperty - -## NOTES - -## RELATED LINKS - -[Get-FsrmMgmtProperty](./Get-FsrmMgmtProperty.md) - -[Remove-FsrmMgmtProperty](./Remove-FsrmMgmtProperty.md) - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmQuota.md deleted file mode 100644 index fdaf52216b..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmQuota.md +++ /dev/null @@ -1,266 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmQuota - -## SYNOPSIS -Changes configuration settings for a FSRM quota. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmQuota [-Path] [-AsJob] [-CimSession ] [-Description ] [-Disabled] - [-PassThru] [-Size ] [-SoftLimit] [-Threshold ] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmQuota [-AsJob] [-CimSession ] [-Description ] [-Disabled] [-PassThru] - [-Size ] [-SoftLimit] [-Threshold ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmQuota** cmdlet changes configuration settings for a File Server Resource Manager (FSRM) quota on the server. - -## EXAMPLES - -### Example 1: Change the size limit of a quota -``` -PS C:\>Set-FsrmQuota -Path "C:\Shares" -Description "limit usage to 1.5 GB" -Size 1.5GB -``` - -This command changes the quota on C:\Shares to have a 1.5GB limit. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the quota. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disabled -Indicates that the quota is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Size -Specifies the space limit that the quota template enforces. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SoftLimit -Indicates that the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -Specifies an array of threshold objects. -You can use the New-FsrmQuotaThreshold cmdlet to create a threshold object. -The object defines a percentage of used space from the available space that can be reached during a file operation, and a set of actions that the server takes when a quota reaches the threshold. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuota - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuota](./Get-FsrmQuota.md) - -[New-FsrmQuota](./New-FsrmQuota.md) - -[Reset-FsrmQuota](./Reset-FsrmQuota.md) - -[Update-FsrmQuota](./Update-FsrmQuota.md) - -[Remove-FsrmQuota](./Remove-FsrmQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmQuotaTemplate.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmQuotaTemplate.md deleted file mode 100644 index cedebd813e..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmQuotaTemplate.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmquotatemplate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmQuotaTemplate - -## SYNOPSIS -Changes configuration settings for FSRM quota templates. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmQuotaTemplate [-Name] [-AsJob] [-CimSession ] [-Description ] - [-PassThru] [-Size ] [-SoftLimit] [-Threshold ] [-ThrottleLimit ] - [-UpdateDerived] [-UpdateDerivedMatching] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmQuotaTemplate [-AsJob] [-CimSession ] [-Description ] [-PassThru] - [-Size ] [-SoftLimit] [-Threshold ] [-ThrottleLimit ] [-UpdateDerived] - [-UpdateDerivedMatching] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmQuotaTemplate** cmdlet changes configuration settings for one or more File Server Resource Manager (FSRM) quota templates. - -When you make changes to a quota template, you have the option of extending those changes to existing quotas that are derived from the quota template. -You can specify the **UpdateDerivedMatching** parameter to modify only those quotas that still match the original quota template, or you can specify the **UpdateDerived** parameter to modify all quotas that are derived from the quota template, regardless of any modifications that you made to the quotas since you created them. - -## EXAMPLES - -### Example 1: Change the size limit of a quota template -``` -PS C:\>Set-FsrmQuotaTemplate -Name "1GB limit" -Description "limit usage to 1.5 GB." -Size 1.5GB -``` - -This command changes the quota template named "1GB limit" to have a 1.5GB limit, and adds a description to the quota template. - -### Example 2: Change the size limit of all quotas that are derived from a quota template -``` -PS C:\>Set-FsrmQuotaTemplate "1GB limit" -Description "limit usage to 1.5 GB." -Size 1.5GB -UpdateDerived -``` - -This command changes the quota template named "1GB limit" to have a 1.5GB limit. -The **UpdateDerived** parameter indicates that this command updates all quotas on the server that are derived from the quota template to have a 1.5GB limit. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the quota. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of quota templates. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Size -Specifies the size limit that the quota enforces. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SoftLimit -Indicates that the quota reports on the disk usage with respect to the size limit and run thresholds, but does not enforce the size limit. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Threshold -Specifies an array of threshold objects. - -The threshold object defines a percentage of used space from the available space that can be reached during a file operation, and a set of actions that the server takes when a quota reaches the threshold. -To perform the action when the quota is exceeded, set the threshold to 100 (percent). -You can use the New-FsrmQuotaThreshold cmdlet to create a threshold object. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDerived -Indicates that the server modifies all quotas that are derived from the quota template. -If you specify this parameter, you cannot specify the **UpdateDerivedMatching** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UpdateDerivedMatching -Indicates that the server updates only the quotas that are derived from the quota template that you have not modified since you created the quotas. -Specify this parameter if you have quotas that have been modified since they were automatically generated, and you do not want to change them. - -If you specify this parameter, you cannot specify the **UpdateDerived** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMQuotaTemplate - -## NOTES - -## RELATED LINKS - -[Get-FsrmQuotaTemplate](./Get-FsrmQuotaTemplate.md) - -[New-FsrmQuotaTemplate](./New-FsrmQuotaTemplate.md) - -[Remove-FsrmQuotaTemplate](./Remove-FsrmQuotaTemplate.md) - -[New-FsrmQuotaThreshold](./New-FsrmQuotaThreshold.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmSetting.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmSetting.md deleted file mode 100644 index 4129a094d2..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmSetting.md +++ /dev/null @@ -1,825 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmSetting - -## SYNOPSIS -Changes global FSRM settings for the computer. - -## SYNTAX - -``` -Set-FsrmSetting [-AdminEmailAddress ] [-AsJob] [-CimSession ] - [-CommandNotificationLimit ] [-EmailNotificationLimit ] [-EventNotificationLimit ] - [-FromEmailAddress ] [-InputObject ] [-PassThru] - [-ReportClassificationFormat ] - [-ReportClassificationLog ] [-ReportClassificationMailTo ] - [-ReportFileGroupIncluded ] [-ReportFileOwnerFilePattern ] [-ReportFileOwnerUser ] - [-ReportFileScreenAuditDaysSince ] [-ReportFileScreenAuditEnable] - [-ReportFileScreenAuditUser ] [-ReportLargeFileMinimum ] [-ReportLargeFilePattern ] - [-ReportLeastAccessedFilePattern ] [-ReportLeastAccessedMinimum ] - [-ReportLimitMaxDuplicateGroup ] [-ReportLimitMaxFile ] [-ReportLimitMaxFileGroup ] - [-ReportLimitMaxFileScreenEvent ] [-ReportLimitMaxFilesPerDuplicateGroup ] - [-ReportLimitMaxFilesPerFileGroup ] [-ReportLimitMaxFilesPerOwner ] - [-ReportLimitMaxFilesPerPropertyValue ] [-ReportLimitMaxOwner ] - [-ReportLimitMaxPropertyValue ] [-ReportLimitMaxQuota ] [-ReportLocationIncident ] - [-ReportLocationOnDemand ] [-ReportLocationScheduled ] - [-ReportMostAccessedFilePattern ] [-ReportMostAccessedMaximum ] - [-ReportNotificationLimit ] [-ReportPropertyFilePattern ] [-ReportPropertyName ] - [-ReportQuotaMinimumUsage ] [-SmtpServer ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmSetting** cmdlet changes global File Server Resource Manager (FSRM) settings for the computer. - -## EXAMPLES - -### Example 1: Change the FSRM setting for administrator email address -``` -PS C:\>Set-FsrmSetting -AdminEmailAddress "john@contoso.com" -``` - -This command specifies the address "john@contoso.com" for the recipient of email that the server sends to the administrator. - -### Example 2: Change the FSRM setting for command notification limit -``` -PS C:\>Set-FsrmSetting -CommandNotificationLimit 80 -``` - -This command specifies 80 as the minimum number of seconds between individual running events of a command-type notification. - -### Example 3: Change the FSRM setting for report classification format -``` -PS C:\>Set-FsrmSetting -ReportClassificationFormat @('Xml') -``` - -This command specifies XML as the format of classification reports that the server generates. - -### Example 4: Change the FSRM setting for report classification log type -``` -PS C:\>Set-FsrmSetting -ReportClassificationLog @('ErrorsInSystemLog') -``` - -This command specifies ErrorsInSystemLog as the type of log that the File Classification Infrastructure generates during classification. - -### Example 5: Change the FSRM settings for large file reports and quota usage reports -``` -PS C:\>Set-FsrmSetting -ReportLargeFilePattern '*' -ReportLimitMaxQuota 100 -``` - -This command specifies the wildcard character (*) to indicate that the large file report includes any files that match the value set for the **ReportLargeFileMinimum** parameter. -The command also specifies that 100 is the maximum number of quotas to include in a quota usage report. - -### Example 6: Change the FSRM setting for the SMTP server and file by owner reports -``` -PS C:\>Set-FsrmSetting -SmtpServer "10.121.24.132" -ReportFileOwnerFilePattern '*.xml' -``` - -This command specifies "10.121.24.132" as the IP address of the SMTP server that FSRM uses to send email. -The command also specifies "*.XML" as the file pattern to match for the file by owner report. - -## PARAMETERS - -### -AdminEmailAddress -Specifies a semicolon-separated list of email addresses for the recipients of any email that the server sends to the administrator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CommandNotificationLimit -Specifies the minimum number of seconds between individual running events of a command-type notification. -If multiple command notifications occur, the server runs the command notification only if at least this amount of time has passed since the server last performed this action. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EmailNotificationLimit -Specifies the minimum number of seconds between individual running events of an email-type notification. -If multiple command notifications occur, the server runs the command notification only if at least this amount of time has passed since the server last performed this action. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EventNotificationLimit -Specifies the minimum number of seconds between individual running events of an event-type notification. -If multiple command notifications occur, the server runs the command notification only if at least this amount of time has passed since the server last performed this action. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FromEmailAddress -Specifies the default email address from which FSRM sends email messages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportClassificationFormat -Specifies an array of formats of classification reports that the server generates. -The acceptable values for this parameter are: -- DHTML -- HTML -- XML -- CSV -- Text - -```yaml -Type: FsrmReportClassificationFormatEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportClassificationLog -Specifies an array of types of logs that the File Classification Infrastructure can generate during classification. -The acceptable values for this parameter are: -- None -- ClassificationsInLogFile -- ErrorsInLogFile -- ClassificationsInSystemLog -- ErrorsInSystemLog - -```yaml -Type: FsrmReportClassificationLogEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportClassificationMailTo -Specifies a semicolon-separated list of email addresses. -The server sends the classification reports to the email addresses after a scheduled classification is complete. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFileGroupIncluded -Specifies an array of names of file groups to include in the report. -Each string must be the name of a valid file group. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFileOwnerFilePattern -Specifies a file pattern string that indicates which files to include in the file by owner report. -You can use the wildcard characters * and ? -in the string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFileOwnerUser -Specifies an array of users, in **Domain\User** format, to include files for in the file by owner report. -The default value is an empty list, which indicates all users. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFileScreenAuditDaysSince -Specifies the minimum number of days since the audit event to include in the report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFileScreenAuditEnable -Indicates that file screen auditing is enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFileScreenAuditUser -Specifies an array of user email addresses to include audit events for. -The default value is an empty list, which indicates all users. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLargeFileMinimum -Specifies the minimum file size to include in the large file report. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLargeFilePattern -Specifies a string of files to include in the large file report. -You can use the wildcard characters * and ? -in the string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLeastAccessedFilePattern -Specifies a string of files to include in the least frequently accessed report. -You can use the wildcard characters * and ? -in the string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLeastAccessedMinimum -Specifies the minimum number of days since the report was last accessed, to include in the least frequently accessed report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxDuplicateGroup -Specifies the maximum number of groups of duplicate files to include in the duplicate files report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFile -Specifies the maximum number of files to include in a storage report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFileGroup -Specifies the maximum number of file groups to include in a file group report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFileScreenEvent -Specifies the maximum number of file screens events to include in a file screen audit report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFilesPerDuplicateGroup -Specifies the maximum number of files in an individual duplicate group to include in a duplicate files report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFilesPerFileGroup -Specifies the maximum number of files in any file group to include in a file group report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFilesPerOwner -Specifies the maximum number of files for any owner to include in a files by owner report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxFilesPerPropertyValue -Specifies the maximum number of files for each property value to include in a files by property report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxOwner -Specifies the maximum number of owners to include in a files by owner report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxPropertyValue -Specifies the maximum number of property values to include in a files by property report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLimitMaxQuota -Specifies the maximum number of quotas to include in a quota usage report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLocationIncident -Specifies a path to a folder where the server stores incident reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLocationOnDemand -Specifies a path to a folder where the server stores on demand reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportLocationScheduled -Specifies a path to a folder where the server stores scheduled reports. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportMostAccessedFilePattern -Specifies a string of files to include in the most frequently accessed report. -You can use the wildcard characters * and ? -in the string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportMostAccessedMaximum -Specifies the maximum number of days since the report was last accessed, to include in the most frequently accessed report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportNotificationLimit -Specifies the minimum number of seconds between individual running events of a report notification. -If multiple report notifications occur, the server runs the report notification only if at least this amount of time have passed since the server last performed this action. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportPropertyFilePattern -Specifies a string of files to include in the file by property report. -You can use the wildcard characters * and ? -in the string. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportPropertyName -Specifies the property name to report on for a file by property report. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportQuotaMinimumUsage -Specifies the minimum quota usage level to include in the quota usage report. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmtpServer -Specifies the fully qualified domain name (FQDN) or IP address of the SMTP server that FSRM uses to send email. - -You can use the Send-FsrmTestEmail cmdlet to send an email messages to test the SMTP server that you specify. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmSetting](./Get-FsrmSetting.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmStorageReport.md deleted file mode 100644 index 67f5ab00ec..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Set-FsrmStorageReport.md +++ /dev/null @@ -1,552 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/set-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-FsrmStorageReport - -## SYNOPSIS -Changes settings of a storage report. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-FsrmStorageReport [-Name] [-AsJob] [-CimSession ] [-FileGroupIncluded ] - [-FileOwnerFilePattern ] [-FileOwnerUser ] [-FileScreenAuditDaysSince ] - [-FileScreenAuditUser ] [-FolderPropertyName ] [-LargeFileMinimum ] - [-LargeFilePattern ] [-LeastAccessedFilePattern ] [-LeastAccessedMinimum ] - [-MailTo ] [-MostAccessedFilePattern ] [-MostAccessedMaximum ] [-Namespace ] - [-PassThru] [-PropertyFilePattern ] [-PropertyName ] [-QuotaMinimumUsage ] - [-ReportFormat ] [-ReportType ] - [-Schedule ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-FsrmStorageReport [-AsJob] [-CimSession ] [-FileGroupIncluded ] - [-FileOwnerFilePattern ] [-FileOwnerUser ] [-FileScreenAuditDaysSince ] - [-FileScreenAuditUser ] [-FolderPropertyName ] [-LargeFileMinimum ] - [-LargeFilePattern ] [-LeastAccessedFilePattern ] [-LeastAccessedMinimum ] - [-MailTo ] [-MostAccessedFilePattern ] [-MostAccessedMaximum ] [-Namespace ] - [-PassThru] [-PropertyFilePattern ] [-PropertyName ] [-QuotaMinimumUsage ] - [-ReportFormat ] [-ReportType ] - [-Schedule ] [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-FsrmStorageReport** cmdlet changes settings of a storage report on the server. -You cannot change the settings of an interactive storage report or a storage report that does not have a schedule. -You must specify the **Name** parameter and at least one additional parameter. - -## EXAMPLES - -### Example 1: Change report types of a storage report -``` -PS C:\>Set-FsrmStorageReport -Name "Get storage usage info" -ReportTypes @(LargeFiles, DuplicateFiles) -``` - -This command changes the storage report named "Get storage usage info" to generate a LargeFiles and a DuplicateFiles report. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileGroupIncluded -Specifies an array of names of file groups to include in the report. -Each string must be the name of a valid file group. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileOwnerFilePattern -Specifies a string of files to include in the file by owner report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set FilesByOwner for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileOwnerUser -Specifies an array of users, in **Domain\User** format, to include files for in the file by owner report. -The default value is an empty list, which indicates all users. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileScreenAuditDaysSince -Specifies the minimum number of days since the audit event to include in the report. -If you specify this parameter, you must set FileScreenAuditFiles for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FileScreenAuditUser -Specifies an array of user email addresses to include audit events for. -The default value is an empty list, which indicates all users. -If you specify this parameter, you must set FileScreenAuditFiles for the **ReportType** parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FolderPropertyName -Specifies a name of the classification property name to report on for a folder by property report. -Specify the value of the Name property in an **FsrmClassificationPropertyDefinition** object. -If you specify this parameter, you must set FoldersByProperty for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LargeFileMinimum -Specifies the minimum file size to include in the large file report. -If you specify this parameter, you must set LargeFiles for the **ReportType** parameter. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LargeFilePattern -Specifies a string of files to include in the large file report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set LargeFiles for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LeastAccessedFilePattern -Specifies a string of files to include in the least frequently accessed report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set LeastRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LeastAccessedMinimum -Specifies the minimum number of days since the report was last accessed, to include in the least frequently accessed report. -If you specify this parameter, you must set LeastRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MailTo -Specifies a semicolon-separated list of email addresses for the recipients of an email. -\[Admin Email\] is a valid email address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MostAccessedFilePattern -Specifies a string of files to include in the most frequently accessed report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set MostRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MostAccessedMaximum -Specifies the maximum number of days since the report was last accessed, to include in the most frequently accessed report. -If you specify this parameter, you must set MostRecentlyAccessed for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names for the storage reports. -If you do not specify a name for a storage report, the server generates a standard name. -You must specify this parameter if you specify the **Interactive** parameter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Namespace -Specifies an array of namespaces that are part of the scope of the report. -Each string must be either a value of the FolderType property on the server, the string "All Shares", or a static path. -The FolderType properties must be in the format \[Folder type property name=\\]. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyFilePattern -Specifies a string of files to include in the file by property report. -You can use the wildcard characters * and ? -in the string. -If you specify this parameter, you must set FilesByProperty for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropertyName -Specifies the name of the classification property to report on for a file by property report. -Specify the value of the Name property in a **FsrmClassificationPropertyDefinition** object. -If you specify this parameter, you must set FilesByProperty for the **ReportType** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QuotaMinimumUsage -Specifies the minimum quota usage level to include in the quota usage report. -If you specify this parameter, you must set QuotaUsage for the **ReportType** parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportFormat -Specifies an array of report formats that the classification report produces. -The acceptable values for this parameter are: -- DHTML -- HTML -- XML -- CSV -- Text - -```yaml -Type: StorageReportReportFormatsEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -Specifies the types of reports that the action generates. -Specify this parameter only if you set the **Type** parameter to Report.The acceptable values for this parameter are: -- DuplicateFiles -- FilesByFileGroup -- FilesByOwner -- FilesByProperty -- LargeFiles -- LeastRecentlyAccessed -- MostRecentlyAccessed -- QuotaUsage - -```yaml -Type: StorageReportReportTypeEnum[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Schedule -Specifies a File Server Resource Manager (FSRM) scheduled task object that describes the schedule for running the storage report. -Use the New-FsrmScheduledTask cmdlet to create a scheduled task object. - -```yaml -Type: CimInstance -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport - -## NOTES - -## RELATED LINKS - -[Get-FsrmStorageReport](./Get-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[Start-FsrmStorageReport](./Start-FsrmStorageReport.md) - -[Wait-FsrmStorageReport](./Wait-FsrmStorageReport.md) - -[Stop-FsrmStorageReport](./Stop-FsrmStorageReport.md) - -[Remove-FsrmStorageReport](./Remove-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmClassification.md b/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmClassification.md deleted file mode 100644 index a08cf04bcf..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmClassification.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/start-fsrmclassification?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-FsrmClassification - -## SYNOPSIS -Starts the classification process. - -## SYNTAX - -``` -Start-FsrmClassification [-AsJob] [-CimSession ] [-Queue] [-RunDuration ] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-FsrmClassification** cmdlet starts the classification process. -The classification process runs classification rules on files on the server and generates the classification report. - -## EXAMPLES - -### Example 1: Start the classification process -``` -PS C:\>Start-FsrmClassification -RunDuration 4 -``` - -This command starts the classification process and specifies that the server runs the classification task no longer than 4 hours before canceling it. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Queue -Indicates that the server adds the classification task to a queue and the task should run in the next 5 minutes. -Any tasks that the server queues during the next 5 minutes run together. -If you do not specify this parameter, the server runs the classification immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RunDuration -Specifies the number of hours that the server runs the classification task before canceling it. -The value 0 indicates that the server runs the task to completion. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassification - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassification](./Get-FsrmClassification.md) - -[Stop-FsrmClassification](./Stop-FsrmClassification.md) - -[New-FsrmClassificationRule](./New-FsrmClassificationRule.md) - -[Set-FsrmClassification](./Set-FsrmClassification.md) - -[Wait-FsrmClassification](./Wait-FsrmClassification.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmFileManagementJob.md deleted file mode 100644 index 83b5cb0329..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmFileManagementJob.md +++ /dev/null @@ -1,214 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/start-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-FsrmFileManagementJob - -## SYNOPSIS -Starts a file management job. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Start-FsrmFileManagementJob [-Name] [-AsJob] [-CimSession ] [-Queue] - [-RunDuration ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Start-FsrmFileManagementJob [-AsJob] [-CimSession ] [-Queue] [-RunDuration ] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-FsrmFileManagementJob** cmdlet attempts to start a file management job. -If you specify the **Queue** parameter, the start is delayed by approximately 5 minutes to wait for other file management jobs that the server can run at the same time. - -## EXAMPLES - -### Example 1: Start a file management job -``` -PS C:\>Start-FsrmFileManagementJob -Name "Expire stale Data" -``` - -This command starts the file management job named "Expire stale Data" immediately. - -### Example 2: Queue a file management job and set the run duration -``` -PS C:\>Start-FsrmFileManagementJob -Name "Expire stale Data" -Queue -RunDuration 4 -``` - -This command queues the file management job named "Expire stale Data" to start in the next 5 minutes and specifies that the server does not run the job any longer than 4 hours. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file management jobs. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Queue -Indicates that the server adds the file management job to a queue and the task should run the next 5 minutes. -Any tasks that the server queues during the next 5 minutes are run together. -If you do not specify this parameter, the server runs the file management job immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunDuration -Specifies the number of hours that the server runs the task before canceling it. -The value 0 indicates that the server runs the task to completion. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) - -[Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) - -[Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmStorageReport.md deleted file mode 100644 index a23db21d53..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Start-FsrmStorageReport.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/start-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-FsrmStorageReport - -## SYNOPSIS -Starts generating storage reports. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Start-FsrmStorageReport [-Name] [-AsJob] [-CimSession ] [-Queue] - [-RunDuration ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Start-FsrmStorageReport [-AsJob] [-CimSession ] [-Queue] [-RunDuration ] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-FsrmStorageReport** cmdlet starts generating one or more storage reports on demand. -You cannot use this cmdlet to start interactive storage reports or storage reports that do not have a schedule. - -You can view the reports immediately after the server generates them or e-mail the reports to a group of administrators. -If you choose to open the reports immediately, you must wait while the reports are generated. -Processing time varies, depending on the types of reports and the scope of the data. - -## EXAMPLES - -### Example 1: Start a storage report -``` -PS C:\>Start-FsrmStorageReport "Monthly report" -``` - -This command starts the storage report named "Monthly report" immediately. - -### Example 2: Queue a storage report and set the run duration -``` -PS C:\>Start-FsrmStorageReport "Monthly report" -Queue -RunDuration 4 -``` - -This command queues the storage report named "Monthly report" to start in the next 5 minutes and specifies that the server does not run the report job any longer than 4 hours. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of storage reports. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Queue -Indicates that the server adds the report to a queue and the report should run in the next 5 minutes. -Any reports that the server queues during the next 5 minutes are run together. -If you do not specify this parameter, the server runs the report immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RunDuration -Specifies the number of hours that the server runs the report job before canceling it. -The value 0 indicates that the server runs the report job to completion. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport - -## NOTES - -## RELATED LINKS - -[Get-FsrmStorageReport](./Get-FsrmStorageReport.md) - -[Set-FsrmStorageReport](./Set-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[Stop-FsrmStorageReport](./Stop-FsrmStorageReport.md) - -[Wait-FsrmStorageReport](./Wait-FsrmStorageReport.md) - -[Remove-FsrmStorageReport](./Remove-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmClassification.md b/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmClassification.md deleted file mode 100644 index bd018a2033..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmClassification.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/stop-fsrmclassification?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-FsrmClassification - -## SYNOPSIS -Stops the running instance of a classification. - -## SYNTAX - -``` -Stop-FsrmClassification [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-FsrmClassification** cmdlet stops the running instance of a classification job on the server. -If the cmdlet cannot stop the running or queued classification on the server, the cmdlet fails and returns an error. - -This cmdlet returns a status of success in the following conditions: -- The classification is not currently running on the server. -- The classification is currently running and the server has started the process of cancelling the classification. -- The classification is queued on the server and the server has successfully removed the classification from the queue. - -## EXAMPLES - -### Example 1: Stop the running classification -``` -PS C:\>Stop-FsrmClassification -``` - -This command stops the running instance of a classification. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassification](./Get-FsrmClassification.md) - -[Set-FsrmClassification](./Set-FsrmClassification.md) - -[Start-FsrmClassification](./Start-FsrmClassification.md) - -[Wait-FsrmClassification](./Wait-FsrmClassification.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmFileManagementJob.md deleted file mode 100644 index 92b2a3ffdb..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmFileManagementJob.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/stop-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-FsrmFileManagementJob - -## SYNOPSIS -Stops the running instance of a file management job. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-FsrmFileManagementJob [-Name] [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-FsrmFileManagementJob [-AsJob] [-CimSession ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-FsrmFileManagementJob** cmdlet stops the running instance of a file management job. -This cmdlet returns one of the following values for the running status of the file management job: -- NotRunning -- Queued -- Running - -This cmdlet returns a success status in the following conditions: -- The server is not running the job. -- The server is currently canceling the job. -- The server is running the job and has started cancellation of the job. -- The job is queued on the server and has removed the job from the queue. - -This cmdlet returns a failure status if the server cannot stop a file management job that is running or is queued. - -## EXAMPLES - -### Example 1: Stop a file management job -``` -PS C:\>Start-FsrmFileManagementJob -Name "Expire stale data" PS C:\>Stop-FsrmFileManagementJob -Name "Expire stale data" -``` - -This first command starts the file management job named "Expire stale data". - -This second command stops the file management job named "Expire stale data". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file management jobs. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) - -[Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) - -[Wait-FsrmFileManagementJob](./Wait-FsrmFileManagementJob.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmStorageReport.md deleted file mode 100644 index 7fb91847de..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Stop-FsrmStorageReport.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/stop-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-FsrmStorageReport - -## SYNOPSIS -Stops the running instance of storage reports. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-FsrmStorageReport [-Name] [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-FsrmStorageReport [-AsJob] [-CimSession ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-FsrmStorageReport** cmdlet stops the running instance of one or more storage reports on the server. -This cmdlet returns one of the following values for the running status of the file management job: -- NotRunning -- Queued -- Running - -This cmdlet returns a success status in the following conditions: -- The server is not running the report job. -- The server is currently canceling the report job. -- The server is running the report job and has started cancellation of the report job. -- The server has removed the report job from the queue. - -This cmdlet returns a failure status if the server cannot stop a storage report job that the server is running or has queued. - -## EXAMPLES - -### Example 1: Stop a storage report -``` -PS C:\>Start-FsrmFileManagementJob "Expire stale data" PS C:\>Stop-FsrmFileManagementJob "Expire stale data" -``` - -This first command starts the storage report named "Expire stale data". - -The second command stops the storage report job named "Expire stale data". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of storage reports. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmStorageReport](./Get-FsrmStorageReport.md) - -[Set-FsrmStorageReport](./Set-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[Start-FsrmStorageReport](./Start-FsrmStorageReport.md) - -[Wait-FsrmStorageReport](./Wait-FsrmStorageReport.md) - -[Remove-FsrmStorageReport](./Remove-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmAutoQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmAutoQuota.md deleted file mode 100644 index ceb9f54111..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmAutoQuota.md +++ /dev/null @@ -1,192 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/update-fsrmautoquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-FsrmAutoQuota - -## SYNOPSIS -Updates the properties of an auto apply quota. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Update-FsrmAutoQuota [-Path] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Update-FsrmAutoQuota [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Update-FsrmAutoQuota** cmdlet updates the properties of an auto apply quota and the quotas that derive from the automatic quota. -To change the properties of an auto apply quota, change the properties of the template from which the automatic quota is derived, and then use this cmdlet to update the properties of the auto apply quota. - -Updating the properties of an auto apply quota is a long-running process. -Update an auto apply quota only when you have changed the properties of the template from which the auto apply quota is derived. - -## EXAMPLES - -### Example 1: Update an auto apply quota -``` -PS C:\>Update-FsrmAutoQuota -Path "C:\Contoso\west" -``` - -This command updates the auto apply quota in the path "C:\Contoso\west" and any quotas that derive from this auto apply quota. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a valid local path to a folder. -The server updates the auto apply quota on each of the subfolders in this folder. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmAutoQuota](./Get-FsrmAutoQuota.md) - -[Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) - -[New-FsrmAutoQuota](./New-FsrmAutoQuota.md) - -[Remove-FsrmAutoQuota](./Remove-FsrmAutoQuota.md) - -[Set-FsrmQuotaTemplate](./Set-FsrmQuotaTemplate.md) - -[Get-FsrmQuotaTemplate](./Get-FsrmQuotaTemplate.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmClassificationPropertyDefinition.md b/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmClassificationPropertyDefinition.md deleted file mode 100644 index 14b0e7d483..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmClassificationPropertyDefinition.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/update-fsrmclassificationpropertydefinition?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-FsrmClassificationPropertyDefinition - -## SYNOPSIS -Updates the classification property definitions. - -## SYNTAX - -``` -Update-FsrmClassificationPropertyDefinition [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Update-FsrmClassificationPropertyDefinition** cmdlet synchronizes the classification property definitions on the server with the Resource property definitions in Active Directory Domain Service (AD DS). - -## EXAMPLES - -### Example 1: Update the classification property definitions -``` -PS C:\>Update-FsrmClassificationPropertyDefinition -``` - -This command updates the classification property definitions on the server. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Remove-FsrmClassificationPropertyDefinition](./Remove-FsrmClassificationPropertyDefinition.md) - -[Get-FsrmClassificationPropertyDefinition](./Get-FsrmClassificationPropertyDefinition.md) - -[New-FsrmClassificationPropertyDefinition](./New-FsrmClassificationPropertyDefinition.md) - -[Set-FsrmClassificationPropertyDefinition](./Set-FsrmClassificationPropertyDefinition.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmQuota.md b/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmQuota.md deleted file mode 100644 index 692881d3f1..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Update-FsrmQuota.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/update-fsrmquota?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-FsrmQuota - -## SYNOPSIS -Starts a quota scan on a path. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Update-FsrmQuota [-Path] [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Update-FsrmQuota [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Update-FsrmQuota** cmdlet starts a quota scan on a path. - -Although the server monitors quota usage on a continuing basis, there are instances in which the quota usage can be out of synchronization with the actual usage. -In this case, you can use this cmdlet to refresh the quota usage. -For example, if you disable a quota to investigate or troubleshoot an issue, and later enable the quota, use this cmdlet to perform a manual scan. - -A quota scan is a long-running process. -Start a quota scan only when quota usage is out of synchronization with the actual usage. - -## EXAMPLES - -### Example 1: Update a quota -``` -PS C:\>Update-FsrmQuota -Path "C:\Shares" -``` - -This command starts a quota scan on the path C:\Shares. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the local folder that contains the quota. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-FsrmAutoQuota](./Get-FsrmAutoQuota.md) - -[Set-FsrmAutoQuota](./Set-FsrmAutoQuota.md) - -[New-FsrmAutoQuota](./New-FsrmAutoQuota.md) - -[Remove-FsrmAutoQuota](./Remove-FsrmAutoQuota.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmClassification.md b/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmClassification.md deleted file mode 100644 index c0061c45af..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmClassification.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/wait-fsrmclassification?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Wait-FsrmClassification - -## SYNOPSIS -Waits for a period of time or until classification is finished running. - -## SYNTAX - -``` -Wait-FsrmClassification [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Timeout ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Wait-FsrmClassification** cmdlet waits for a period of time or until classification is finished running. -The cmdlet returns when the server finishes running the classification process or when the time that you specify in the **Timeout** parameter has elapsed. - -## EXAMPLES - -### Example 1: Wait for a classification -``` -PS C:\>Start-FsrmClassification PS C:\>Wait-FsrmClassification -``` - -The first command starts the classification. - -The second command waits for the classification to finish running. - -### Example 2: Wait for and stop the classification -``` -The first command starts the classification process. -PS C:\>Start-FsrmClassification - -The second command waits for the classification to finish running. If the classification is not completed in 10 minutes, the server ends the classification process and the cmdlet returns. -PS C:\>Wait-FsrmClassification -Timeout 600 - -The third command ensures that the classification has stopped running. -PS C:\>Stop-FsrmClassification -``` - -This example waits for the classification to finish running and then stops the classification. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the number of seconds to wait for classification and the reports to complete. -The cmdlet returns when the period expires or classification completes. -To wait indefinitely, set the value to -1. -The value must be in the range from -1 through 2,147,483. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMClassification - -## NOTES - -## RELATED LINKS - -[Get-FsrmClassification](./Get-FsrmClassification.md) - -[Set-FsrmClassification](./Set-FsrmClassification.md) - -[Start-FsrmClassification](./Start-FsrmClassification.md) - -[Stop-FsrmClassification](./Stop-FsrmClassification.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmFileManagementJob.md b/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmFileManagementJob.md deleted file mode 100644 index 4c512eafcf..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmFileManagementJob.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/wait-fsrmfilemanagementjob?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Wait-FsrmFileManagementJob - -## SYNOPSIS -Waits for file management jobs to finish running. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Wait-FsrmFileManagementJob [-Name] [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Timeout ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Wait-FsrmFileManagementJob [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Timeout ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Wait-FsrmFileManagementJob** cmdlet waits for the specified period of time or until the server finishes running one or more file management job. - -## EXAMPLES - -### Example 1: Wait for a file management job to finish -``` -PS C:\>Start-FsrmFileManagementJob -Name "Expire stale data" PS C:\>Wait-FsrmFileManagementJob -Name "Expire stale data" -``` - -This command waits for the file management job named "Expire stale data" to finish running. - -### Example 2: Wait for and stop a file management job -``` -The first command starts the file management job named "Expire stale data". -PS C:\>Start-FsrmFileManagementJob -Name "Expire stale data" - -The second command waits for the file management job to finish running. If the file management job is not completed in 10 minutes, the server ends the file management job and the cmdlet returns. -PS C:\>Wait-FsrmFileManagementJob -Name "Expire stale data" -Timeout 600 - -The third command ensures that the file management job has stopped running. -PS C:\>Stop-FsrmFileManagementJob -Name "Expire stale data" -``` - -This example waits for the file management job named "Expire stale data" to finish running and then stops the job. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of file management jobs. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the number of seconds that the server waits for the file management job to complete. -To wait indefinitely, set the value to -1. -The value must be in the range from -1 through 2,147,483. -If the server is not running the job or the value is set to 0, the cmdlet returns immediately. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMFileManagementJob - -## NOTES - -## RELATED LINKS - -[Get-FsrmFileManagementJob](./Get-FsrmFileManagementJob.md) - -[Set-FsrmFileManagementJob](./Set-FsrmFileManagementJob.md) - -[Remove-FsrmFileManagementJob](./Remove-FsrmFileManagementJob.md) - -[New-FsrmFileManagementJob](./New-FsrmFileManagementJob.md) - -[Start-FsrmFileManagementJob](./Start-FsrmFileManagementJob.md) - -[Stop-FsrmFileManagementJob](./Stop-FsrmFileManagementJob.md) - diff --git a/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmStorageReport.md b/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmStorageReport.md deleted file mode 100644 index 1cb28f02ee..0000000000 --- a/docset/winserver2012-ps/fileserverresourcemanager/Wait-FsrmStorageReport.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: FSRM_Cmdlets.xml -Module Name: FileServerResourceManager -online version: https://learn.microsoft.com/powershell/module/fileserverresourcemanager/wait-fsrmstoragereport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Wait-FsrmStorageReport - -## SYNOPSIS -Waits for a period of time or until storage reports is finished running. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Wait-FsrmStorageReport [-Name] [-AsJob] [-CimSession ] [-ThrottleLimit ] - [-Timeout ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Wait-FsrmStorageReport [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Timeout ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Wait-FsrmStorageReport** cmdlet waits for a period of time or until one or more storage reports are finished running. -The cmdlet returns when the server finishes running the storage reports or when the time that you specify in the **Timeout** parameter has elapsed. - -## EXAMPLES - -### Example 1: Wait for a storage report -``` -PS C:\>Start-FsrmStorageReport -Name "Monthly report" PS C:\>Wait-FsrmStorageReport -Name "Monthly report" -``` - -The first command starts the report named "Monthly report". - -The second command waits for the report to finish running. - -### Example 2: Wait for and stop the storage report -``` -The first command starts the report named "Monthly report". -PS C:\>Start-FsrmStorageReport -Name "Monthly report" - -The second command waits for the report to finish running. If the report is not completed in 10 minutes, the server ends the report job and the cmdlet returns. -PS C:\>Wait-FsrmStorageReport -Name "Monthly report" -Timeout 600 - -The third command ensures that the report has stopped running. -PS C:\>Stop- FsrmStorageReport -Name "Monthly report" -``` - -This example waits for the report to finish running and then stops the report. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of storage reports. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the number of seconds to wait for reports to complete. -The cmdlet returns when the period expires or the report completes. -To wait indefinitely, set the value to -1. -The value must be in the range from -1 through 2,147,483. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_FSRMStorageReport - -## NOTES - -## RELATED LINKS - -[Get-FsrmStorageReport](./Get-FsrmStorageReport.md) - -[Set-FsrmStorageReport](./Set-FsrmStorageReport.md) - -[New-FsrmStorageReport](./New-FsrmStorageReport.md) - -[Start-FsrmStorageReport](./Start-FsrmStorageReport.md) - -[Stop-FsrmStorageReport](./Stop-FsrmStorageReport.md) - -[Remove-FsrmStorageReport](./Remove-FsrmStorageReport.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Backup-GPO.md b/docset/winserver2012-ps/grouppolicy/Backup-GPO.md deleted file mode 100644 index a8bf3c0180..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Backup-GPO.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/backup-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Backup-GPO - -## SYNOPSIS -Backs up one GPO or all the GPOs in a domain. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Backup-GPO [-Comment ] [-Domain ] [-Server ] -Guid -Path [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Backup-GPO [-All] [-Comment ] [-Domain ] [-Server ] -Path [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Backup-GPO [-Name] [-Comment ] [-Domain ] [-Server ] -Path [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The Backup-GPO cmdlet backs up a specified GPO or all the GPOs in a domain to a backup directory. -The backup directory and GPO must already exist. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Backup-Gpo -Name TestGPO -Path C:\GpoBackups -Comment "Weekly Backup" - -DisplayName : TestGPO - -GpoId : 35c12ab3-956c-45d5-973b-46b17d225f47 - -Id : 2b509d4e-40f5-4337-82f7-458584555d0c - -BackupDirectory : C:\GpoBackups - -CreationTime : 2/25/2009 8:48:19 PM - -DomainName : contoso.com - -Comment : Weekly Backup -``` - -Description - ------------ - -This command backs up the "TestGPO" GPO to the C:\GpoBackups directory. -The specified comment is included in the GPO backup. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Backup-Gpo -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Domain contoso.com -Server DC1 -Path \\Server1\GpoBackups -``` - -Description - ------------ - -This command backs up the GPO with the specified GUID in the contoso.com domain to the \\\\Server1\GpoBackups directory. -The domain controller at DC1.contoso.com is contacted to complete the operation. - -If the domain of the user running the session (or, for startup and shutdown scripts, the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Backup-Gpo -All -Path \\Server1\GpoBackups -``` - -Description - ------------ - -This command backs up all the GPOs in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) to the \\\\Server1\GpoBackups directory. - -## PARAMETERS - -### -All -Specifies that all the GPOs in the domain are backed up. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Comment -Includes a comment for the backed-up GPO. -The comment string must be enclosed in double-quotation or single-quotation marks and can contain 2,047 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Backup-GPO cmdlet, the GPO to back up must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO to backup by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO to backup by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the backup directory; for example, "C:\Backups" or "\\\\MyServer\Backups". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.SalesDomain.Contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -A GPO to be backed up. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.GpoBackup -Backup-GPO returns an object that represents the file that holds the settings of the backed-up GPO. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Import-GPO](./Import-GPO.md) - -[Restore-GPO](./Restore-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Copy-GPO.md b/docset/winserver2012-ps/grouppolicy/Copy-GPO.md deleted file mode 100644 index 69dcdb3d71..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Copy-GPO.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/copy-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Copy-GPO - -## SYNOPSIS -Copies a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Copy-GPO [-CopyAcl] [-MigrationTable ] [-SourceDomain ] [-SourceDomainController ] - [-TargetDomain ] [-TargetDomainController ] -SourceGuid -TargetName [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Copy-GPO [-SourceName] [-CopyAcl] [-MigrationTable ] [-SourceDomain ] - [-SourceDomainController ] [-TargetDomain ] [-TargetDomainController ] - -TargetName [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Copy-GPO cmdlet creates a (destination) GPO and copies the settings from the source GPO to the new GPO. -The cmdlet can be used to copy a GPO from one domain to another domain within the same forest. -You can specify a migration table to map security principals and paths when copying across domains. -You can also specify whether to copy the access control list (ACL) from the source GPO to the destination GPO. - -Note: Copy-GPO will not copy the source GPO if a GPO with the specified (target) display name already exists in the destination domain. -In this case, an error occurs and the GPO is not copied. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Copy-GPO -SourceName TestGpo1 -TargetName TestGpo2 - -DisplayName : TestGpo2 - -DomainName : contoso.com - -Owner : CONTOSO\Domain - -Admins Id : 37eeb072-cc31-42bb-8c3a-446c2b6ddd3f - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/25/2009 9:12:05 PM - -ModificationTime : 2/25/2009 9:12:05 PM - -UserVersion : AD Version: 1, SysVol Version: 1 - -ComputerVersion : AD Version: 1, SysVol Version: 1 - -WmiFilter : -``` - -Description - ------------ - -This command copies the "TestGpo1" GPO to a GPO named "TestGpo2". -The GPOs exist in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Copy-GPO -SourceName TestGpo1 -SourceDomain test.contoso.com TargetName TestGpo1 -TargetDomain sales.contoso.com -``` - -Description - ------------ - -This command copies the "TestGpo1" GPO from the test.contoso.com domain to a GPO named TestGpo1 in the sales.contoso.com domain. - -A trust relationship must exist between the source domain and the destination domain. -In addition, if the source domain or the destination domain (or both) is different than the domain of the user that is running the session (or, for startup and shutdown scripts, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>get-gpo -all -domain sales1.contoso.com | foreach-object {$_ | copy-gpo -targetName ($_.DisplayName) -targetdomain sales2.contoso.com -copyacl -migrationtable c:\tables\MigrationTable.migtable} -``` - -Description - ------------ - -This command copies all the GPOs in the sales1.contoso.com domain to the sales2.contoso.com domain. - -First, all the GPOs in the source domain are retrieved by using the Get-GPO cmdlet with the All parameter. -The output of Get-GPO is piped into the foreach-object command. -When each GPO is evaluated, it is piped into Copy-GPO and its display name is specified for the TargetName parameter "-targetName ($_.DisplayName)". -The CopyACL parameter is specified to copy the ACLs for each GPO to the destination domain. -The MigrationTable parameter specifies a migration table to use to migrate Security principals and UNC paths to the destination domain. -Both the CopyACL and the MigrationTable parameters are optional. - -If a GPO with the same display name as a source GPO already exists in the destination domain, an error occurs when this command attempts to copy the source GPO. -Because this command copies all GPOs in the source domain, errors occur for default GPOs; for example, the "Default Domain Policy" GPO and the "Default Domain Controllers Policy" GPO. -These GPOs are not copied. -You can suppress these error messages by supplying the ErrorAction parameter with a value of SilentlyContinue to Copy-GPO. -For more information about the ErrorAction parameter, see about_CommonParameters. - -The (destination) GPOs that were successfully copied are returned by this command. -By default, they are printed to the display, but you can add commands to the end of the pipeline to further configure these GPOs. -For example you can add a Set-GPLinks cmdlet to the end of the pipeline to link all the destination GPOs to a site, domain, or organizational unit. - -A trust relationship must exist between the source domain and the destination domain. -In addition, if the source domain or the destination domain (or both) is different than the domain of the user that is running the session (or, for startup and shutdown scripts, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -## PARAMETERS - -### -CopyAcl -Copies the Access Control List (ACL) of the source GPO to the destination (target) GPO. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MigrationTable -Specifies the location of the migration table to use for the command. -You must specify the full path to the file; for example, "\\\\Server1\MigrationTables\TestToSalesTable.migtable". -If you supply a migration table, security principals and UNC paths are mapped to the destination GPO when you copy a GPO across domains. -If you do not supply a migration table, security principals and UNC paths are not modified in the destination GPO. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDomain -Specifies the domain of the source GPO. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -If you do not specify the SourceDomain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the SourceDomain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDomainController -Specifies the name of the domain controller that this cmdlet contacts for the source domain. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the SourceDomainController parameter, the PDC emulator is contacted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceGuid -Specifies the source GPO by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the SourceGuid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SourceName -Specifies the source GPO by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the SourceGuid parameter to uniquely identify a GPO. - -You can also refer to the SourceName parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetDomain -Specifies the domain to which you want to copy the GPO (the destination domain). -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -If you do not specify the TargetDomain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetDomainController -Specifies the name of the domain controller that this cmdlet contacts for the destination domain. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the TargetDomainController parameter, the PDC emulator is contacted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -Specifies the display name for the destination GPO. -If another GPO with the same display name exists in the destination (target) domain, an error occurs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -The cmdlet takes a GPO as input. -GPO objects that are piped into the cmdlet are used as the source GPO. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -This cmdlet outputs a copy of the specified GPO. - -## NOTES -* You can use the Copy-GPO cmdlet to copy a GPO within a domain or from one domain to another within the same forest. - - You can use the SourceDomain and TargetDomain parameters to explicitly specify the source domain or the target domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPO](./Get-GPO.md) - -[Import-GPO](./Import-GPO.md) - -[New-GPO](./New-GPO.md) - -[Restore-GPO](./Restore-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPInheritance.md b/docset/winserver2012-ps/grouppolicy/Get-GPInheritance.md deleted file mode 100644 index 4b102d6e34..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPInheritance.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gpinheritance?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPInheritance - -## SYNOPSIS -Retrieves Group Policy inheritance information for a specified domain or OU. - -## SYNTAX - -``` -Get-GPInheritance [-Target] [-Domain ] [-Server ] -``` - -## DESCRIPTION -The Get-GPInheritance cmdlet returns information about Group Policy inheritance for a specified domain or OU. - -This information includes the following: - -- A list of GPOs that are linked directly to the location (the GpoLinks property). - -- A list of GPOs that are applied to the location when Group Policy is processed on a client (the InheritedGpoLinks property). - -- Whether inheritance is blocked for the location (the GpoInheritanceBlocked property). - -Note: The InheritedGpoLinks property contains a list of the GPOs are applied to the OU or domain when Group Policy is processed on a client;. -The GPOs are listed according to the order of precedence with which they are applied. -This list includes (in the following order): - -- Inherited GPOs that are linked, enabled, and enforced at higher levels of the Group Policy hierarchy (for example, a site). - -- GPOs that are linked and enabled directly at the specified location. - -- If inheritance is not blocked for the specified location, inherited GPOs that are linked and enabled -- but not enforced -- at higher levels of the Group Policy hierarchy. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-GPInheritance -target "ou=MyOU,dc=contoso,dc=com" - -ContainerName : myou - -ContainerType : OU - -Path : ou=myou,dc=contoso,dc=com - -GpoInheritanceBlocked : No - -GpoLinks : {TestGPO-0, TestGPO-1, TestGPO-2, TestGPO-3...} - -InheritedGpoLinks : {TestGPO-2, TestGPO-3, Default Domain Policy} -``` - -Description - ------------ - -This command retrieves Group Policy inheritance information for the OU named 'MyOU' in the contoso.com domain. - -The GpoLinks property contains a list of all the GPOs that are linked directly to the GPO, whether their links are enabled or not. - -The InheritedGpoLinks property contains a list of all the GPOs that are applied when Group Policy is processed on the client. -TestGPO-2 and TestGPO-3 appear in this list because their links are enabled. - -The "Default Domain Policy" GPO is inherited from the contoso.com domain. -If inheritance is blocked, it does not appear in the InheritedGpoLinks property unless its link is enforced (at the domain). -If its link is enforced, it appears first in the list. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPInheritance -Target "dc=contoso,dc=com" -Domain contoso.com -Server DomainController1 - -Name : contoso.com - -ContainerType : Domain - -Path : dc=contoso,dc=com - -GpoInheritanceBlocked : No - -GpoLinks : {Default Domain Policy} - -InheritedGpoLinks : {Default Domain Policy} -``` - -Description - ------------ - -This command retrieves Group Policy inheritance information for the contoso.com domain. -The domain controller with the host name DomainController1 is contacted to complete the operation. - -Note: The domain does not have to be explicitly specified (by using the Domain parameter) in this example. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is the same as the target domain, or a trust exists between it and the target domain, you do not have to specify the Domain parameter. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | foreach-object { Get-GPO -Name ($_.DisplayName)} - -DisplayName : TestGPO-3 - -DomainName : contoso.com - -Owner : CONTOSO\Domain Admins - -Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/27/2009 2:59:51 PM - -ModificationTime : 2/27/2009 4:00:44 PM - -UserVersion : AD Version: 13, SysVol Version: 13 - -ComputerVersion : AD Version: 0, SysVol Version: 0 - -WmiFilter : - - - -DisplayName : TestGPO-2 - -DomainName : contoso.com - -Owner : CONTOSO\Domain Admins - -Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/26/2009 11:28:08 PM - -ModificationTime : 3/1/2009 11:07:30 AM - -UserVersion : AD Version: 0, SysVol Version: 0 - -ComputerVersion : AD Version: 1, SysVol Version: 1 - -WmiFilter : -``` - -Description - ------------ - -This command evaluates the SOM object (Microsoft.GroupPolicy.SOM) returned by Get-GPInheritance and returns the GPOs that are linked to the "MyOU" organizational unit. -You can use this command to set properties of the GPOs by piping its output into other cmdlets. -For example, you can pipe the output to the Set-GPPermissions command to delegate permissions to administrators of the OU for each of the GPOs linked to the OU. - -The GpoLinks property of the SOM object contains a list of all the GPO links for the OU. -Each object in this list is of type Microsoft.GroupPolicy.GpoLink. -The following shows one such object: - -GpoId : d02126d4-82e8-4e87-b4a0-2d44b6891411 - -DisplayName : TestGPO-3 - -Enabled : True - -Enforced : False - -Target : ou=myou,dc=contoso,dc=com - -Order : 1 - -The collection is piped into a foreach-object command, which retrieves each GPO by using the DisplayName property of the GpoLink object. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPInheritance cmdlet, this is typically the domain of the container (domain or OU) for which you want to retrieve inheritance information. -If the specified domain is different than the domain of the container, a trust must exist between the two domains. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to Server by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the domain or the OU for which to retrieve the Group Policy inheritance information by its LDAP distinguished name. -For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". - -You can also refer to the Target parameter by its built-in alias, "path". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Som -An object that represents a domain or an OU. - -## OUTPUTS - -### Microsoft.GroupPolicy.Som -Get-GPInheritance returns an object that represents the domain or OU. -The GpoInheritanceBlocked property indicates whether inheritance is blocked. -You can modify inheritance for the domain or OU by using the Set-GPInheritance cmdlet. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Set-GPInheritance](./Set-GPInheritance.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPO.md b/docset/winserver2012-ps/grouppolicy/Get-GPO.md deleted file mode 100644 index 40153c420c..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPO.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPO - -## SYNOPSIS -Gets one GPO or all the GPOs in a domain. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-GPO [-Guid] [[-Domain] ] [[-Server] ] [-All] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-GPO [[-Domain] ] [[-Server] ] [-All] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-GPO [-Name] [[-Domain] ] [[-Server] ] [-All] -``` - -## DESCRIPTION -The Get-GPO cmdlet gets one GPO or all the GPOs in a domain. -You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain by specifying the All parameter. - -The Get-GPO cmdlet returns one or more objects that represent the requested GPOs. -By default, properties of the requested GPOs are printed to the display; however, you can also pipe the output of the Get-GPO cmdlet to other Group Policy cmdlets. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-GPO -name "Group Policy Test" - -DisplayName : Group Policy Test - -DomainName : contoso.com - -Owner : CONTOSO\Domain Admins - -Id : 31a09564-cd4a-4520-98fa-446a2af23b4b - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/26/2009 12:15:42 AM - -ModificationTime : 2/26/2009 12:15:42 AM - -UserVersion : AD Version: 0, SysVol Version: 0 - -ComputerVersion : AD Version: 0, SysVol Version: 0 - -WmiFilter : -``` - -Description - ------------ - -This command retrieves the "Group Policy Test" GPO. -The GPO must exist in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer). -The command retrieves the GPO information by contacting the primary domain controller (PDC). - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPO -Guid 31a09564-cd4a-4520-98fa-446a2af23b4b -Domain sales.contoso.com - -DisplayName : Group Policy Test - -DomainName : sales.contoso.com - -Owner : SALES\Domain Admins - -Id : 31a09564-cd4a-4520-98fa-446a2af23b4b - -GpoStatus : AllSettingsEnabled - -Description : - -CreationTime : 2/26/2009 12:15:42 AM - -ModificationTime : 2/26/2009 12:15:42 AM - -UserVersion : AD Version: 0, SysVol Version: 0 - -ComputerVersion : AD Version: 0, SysVol Version: 0 - -WmiFilter : -``` - -Description - ------------ - -This command retrieves the GPO that has the ID (GUID) 331a09564-cd4a-4520-98fa-446a2af23b4b in the sales.contoso.com domain. -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different that sales.contoso.com, a trust must exist between the two domains. -The command retrieves the GPO information by contacting the PDC (in the sales.contoso.com domain). - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-GPO -All -Domain sales.contoso.com -``` - -Description - ------------ - -This command retrieves all the GPOs in the sales.contoso.com domain. - -## PARAMETERS - -### -All -Retrieves all the GPOs in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPO cmdlet, the GPO (or GPOs) to retrieve must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO to retrieve by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO to retrieve by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -A GPO for which to get information. -You can pipe GPO objects into this cmdlet to display information about the GPOs. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Get-GPO returns an object that represents the requested GPO. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - - Only one domain can be used by an instance of this cmdlet. -If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. -(This is because "domainname" is a built-in alias for the Domain parameter, and the Domain parameter can take its value by property name from the pipeline.) A non-terminating error occurs for any GPOs in the collection that are not in this domain. -If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. - -## RELATED LINKS - -[New-GPO](./New-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPOReport.md b/docset/winserver2012-ps/grouppolicy/Get-GPOReport.md deleted file mode 100644 index f15ea4bca3..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPOReport.md +++ /dev/null @@ -1,256 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gporeport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPOReport - -## SYNOPSIS -Generates a report either in XML or HTML format for a specified GPO or for all GPOs in a domain. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-GPOReport [-Guid] [-ReportType] [[-Path] ] [[-Domain] ] - [[-Server] ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-GPOReport [-ReportType] [[-Path] ] [[-Domain] ] [[-Server] ] [-All] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-GPOReport [-Name] [-ReportType] [[-Path] ] [[-Domain] ] - [[-Server] ] -``` - -## DESCRIPTION -The Get-GPOReport cmdlet generates a report in either XML or HTML format that describes properties and policy settings for a specified GPO or for all GPOs in a domain. -The information that is reported for each GPO includes: details, links, security filtering, WMI filtering, delegation, and computer and user configurations. - -You can specify the All parameter to generate a report for every GPO in the domain, or you can specify either the Name or Guid parameter to generate a report for a single GPO. -You can also pipe GPO objects into this cmdlet. -If you specify a file by using the Path parameter, the report is written to a file; otherwise, it is printed to the display. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-GPOReport -Name TestGPO1 -ReportType HTML -Path C:\GPOReports\GPOReport1.html -``` - -Description - ------------ - -This command generates a report in HTML format for the GPO TestGPO1 and writes it to the file C:\GPOReports\GPOReport1.html - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPOReport -All -Domain sales.contoso.com -Server DC1 -ReportType XML -Path C:\GPOReports\GPOReportsAll.xml -``` - -Description - ------------ - -This command generates a report in XML format for each GPO in the sales.contoso.com domain and writes it to the file C:\GPOReports\GPOReportsAll.xml. -The DC1.sales.contoso.com domain controller is contacted to complete the operation. - -If the domain of the user account (or, for startup and shutdown scripts, the computer account) is different from sales.contoso2.com, a trust must exist between the two domains. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML -``` - -Description - ------------ - -This command generates a report in XML format for the GPO with the specified GUID. -Because no path parameter is supplied, the report is written to the display. - -## PARAMETERS - -### -All -If present, a report is generated for all GPOs in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 6 -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPOReport cmdlet: - -- If a single GPO is specified, it must exist in this domain. - -- If the All parameter is specified, a report is generated for each GPO in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO for which to generate the report by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO for which to generate the report by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: NewGPO -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the report file; for example, c:\Reports\GpoReport.xml. -If no path is specified, the report is printed to the display. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -Specifies the format of the report. -You must specify either Html (for HTML format) or Xml (for XML format). -These values are not case sensitive. - -The following values are permitted for this object type. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -An object that represents a GPO. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### None -This cmdlet does not generate any output. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - - Only one domain can be used by an instance of this cmdlet. -If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. -(This is because "domainname" is a built-in alias for the Domain parameter, and the Domain parameter can take its value by property name from the pipeline.) A non-terminating error occurs for any GPOs in the collection that are not in this domain. -If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPPermission.md b/docset/winserver2012-ps/grouppolicy/Get-GPPermission.md deleted file mode 100644 index 03f6d77995..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPPermission.md +++ /dev/null @@ -1,315 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gppermission?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPPermission - -## SYNOPSIS -Gets the permission level for one or more security principals on a specified GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-GPPermission [-All] [-DomainName ] [-Server ] [-TargetName ] - [-TargetType ] -Guid -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-GPPermission [-Name] [-All] [-DomainName ] [-Server ] [-TargetName ] - [-TargetType ] -``` - -## DESCRIPTION -Gets the permission level for one or more security principals on the specified GPO. -You can use the TargetName and TargetType parameters to specify a user, security group, or computer for which to retrieve the permission level. -You can use the All parameter to retrieve the permission level for each security principal (user, security group, or computer) that has permissions on the GPO. -You can specify the GPO by its display name or by its GUID. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group - -Trustee : Domain Users - -TrusteeType : Group - -PermissionLevel : GpoRead - -Inherited : False -``` - -Description - ------------ - -This command gets the permission level for the "Domain Users" group on the GPO named TestGpo. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPPermission -Domain sales.contoso.com -Server DC1 -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -TargetName "Domain Admins" -TargetType Group -``` - -Description - ------------ - -This command gets the permission level for the "Domain Admins" group on the GPO with the GUID fa4a9473-6e2a-4b78-175e68d97bde in the Sales.Contoso.com domain. -The DC1.sales.contoso.com domain controller is contacted to complete the operation. - -If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different from the sales.contoso.com domain, a trust must exist between the two domains, or the command fails. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-GPPermission -Name TestGPO -All - -Trustee : Authenticated Users -TrusteeType : WellKnownGroup -Permission : GpoApply -Inherited : False - -Trustee : Domain Admins -TrusteeType : Group -Permission : GpoEditDeleteModifySecurity -Inherited : False - -Trustee : Enterprise Admins -TrusteeType : Group -Permission : GpoEditDeleteModifySecurity -Inherited : False - -Trustee : ENTERPRISE DOMAIN CONTROLLERS -TrusteeType : WellKnownGroup -Permission : GpoRead -Inherited : False - -Trustee : SYSTEM -TrusteeType : WellKnownGroup -Permission : GpoEditDeleteModifySecurity -Inherited : False -``` - -Description - ------------ - -This command gets the permission level for each security principal that has permissions on the GPO. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "contoso\Domain Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_.DisplayName}} - -Default Domain Policy -TestGPO-1 -TestGPO-2 Default Domain Controllers Policy -Internet Security -TestGPO -``` - -Description - ------------ - -This command lists the display name of each GPO (in the domain) on which the specified security principal has permissions. - -First, Get-GPO is used to retrieve all the GPOs in the domain (Get-GPO -All). -Then, the collection is piped into the foreach-object command. -As each GPO is evaluated, it is piped into Get-GPPermissions. -If a permission level is returned, the DisplayName property of the GPO is printed ($_.DisplayName). - -Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. -This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. -Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed for GPOS on which the security principal does not have permissions. -For more information about the ErrorAction parameter, see about_CommonParameters. - -## PARAMETERS - -### -All -Gets the permission level for each user, group, or computer that has permissions on the GPO. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPPermission cmdlet, the GPO for which to get the permission level must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Server parameter by its built-in alias, "domain". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: domain - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO from which to retrieve the permission level by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO from which to retrieve the permission level by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: displayname - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -The name of the security principal for which to retrieve the permission level. -You can specify a user, a security group, or a computer. -You can use either the domain-qualified name of the security principal (domain\account) or just its name. - -For example, in the contoso.com domain, to specify: - -- The user "someuser", use "contoso\someuser" or "someuser". - -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". - -- The computer "computer-01", use "contoso\computer-01" or "computer-01". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of security principal for which to retrieve the permission level. -You must specify Computer, User, or Group. - -The following values are permitted for this object type. - -- Computer - -- User - -- Group - -```yaml -Type: PermissionTrusteeType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -A GPO for which to retrieve the permission level. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### -Get-GPPermission returns an object that represents permissions for the specified security principal (user, group, or computer) on the GPO. - -## NOTES -* You can use the DomainName parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses the default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell® or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Set-GPPermission](./Set-GPPermission.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPPrefRegistryValue.md b/docset/winserver2012-ps/grouppolicy/Get-GPPrefRegistryValue.md deleted file mode 100644 index 584acf497f..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPPrefRegistryValue.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gpprefregistryvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPPrefRegistryValue - -## SYNOPSIS -Retrieves one or more Registry preference items under either Computer Configuration or User Configuration in a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-GPPrefRegistryValue [-Domain ] [-Order ] [-Server ] [-ValueName ] - -Context -Guid -Key -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-GPPrefRegistryValue [-Name] [-Domain ] [-Order ] [-Server ] - [-ValueName ] -Context -Key -``` - -## DESCRIPTION -The Get-GPPrefRegistryValue cmdlet retrieves one or more Registry preference items under either Computer Configuration or User Configuration in a GPO. -You must specify the Context parameter (User or Computer) to indicate whether to retrieve the Registry preference item from Computer Configuration or User Configuration. -. You can specify the GPO by its display name or by its GUID. - -You can retrieve Registry preference items for a specific registry value, or for a key and any of its first-level registry values: - -- To retrieve any Registry preference items that configure a specific registry value, specify both the Key and the ValueName parameters. - -- To retrieve all the Registry preference items that configure a registry key and any (first-level) registry values directly under the key, specify the Key parameter without the ValueName parameter. - -If you specify only a key, the cmdlet also returns its first-level subkeys for which there are Registry preference items that configure the subkey, its values, or any of its subkeys (at any level) or their values. -You can use this information to browse for Registry preference items. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>get-gpprefregistryvalue -name testgpo -context user -key hklm\software\microsoft\examplekey -valuename valueone - -KeyPath : SOFTWARE\Microsoft\ExampleKey -FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey -Hive : LocalMachine -Action : Create -Order : 1 -DisabledDirectly : False -DisabledByAncestor : False -Value : NewData1 -Type : String -ValueName : ValueOne -HasValue : True -``` - -Description - ------------ - -This command retrieves the Registry preference item that is configured for the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration in the "TestGPO" GPO. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>get-gpprefregistryvalue -name testgpo -context user -key hklm\software\microsoft\examplekey - -KeyPath : SOFTWARE\Microsoft\ExampleKey -FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey -Hive : LocalMachine -Action : Create -Order : 1 -DisabledDirectly : False -DisabledByAncestor : False -Value : NewData1 -Type : String -ValueName : ValueOne -HasValue : True - -KeyPath : SOFTWARE\Microsoft\ExampleKey -FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey -Hive : LocalMachine -Action : Create -Order : 2 -DisabledDirectly : False -DisabledByAncestor : False -Value : NewData2 -Type : String -ValueName : Valuetwo -HasValue : True - - - -KeyPath : SOFTWARE\Microsoft\ExampleKey\Subkey1 -FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\Subkey1 -Hive : LocalMachine - -KeyPath : SOFTWARE\Microsoft\ExampleKey\SubKey2 -FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\SubKey2 -Hive : LocalMachine -``` - -Description - ------------ - -This command retrieves all the Registry preference items that are configured for the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" and any of its first-level values from User Configuration in the "TestGPO" GPO. - -In this example, Registry preference items that configure the following two first-level values of the registry key are returned: ValueOne and ValueTwo. -Two subkeys of the key are also returned. -This is because there are Registry preference items in User Configuration associated with each subkey. - -## PARAMETERS - -### -Context -Specifies whether the Registry preference item is retrieved from User Configuration or Computer Configuration in the GPO. -You must specify either User or Computer. - -The following values are permitted for this object type. - -```yaml -Type: GpoConfiguration -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPPrefRegistryValue cmdlet, the GPO for which to retrieve the Registry preference item must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: domainname - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO from which to retrieve the Registry preference item by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies the registry key for the Registry preference item to retrieve; for example: HKEY_CURRENT_USER\Control Panel\Colors. - -You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). -Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. - -The Key parameter can be specified with or without the ValueName parameter: - -- If the ValueName parameter is specified, all Registry preference items that configure the registry value are retrieved. - -- If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are retrieved. - -You can also refer to the Key parameter by its built-in alias, "FullKeyPath". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: FullKeyPath - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO from which to retrieve the Registry preference item by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: displayname - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Specifies the order in which the Registry preference item is applied, relative to the other Registry preference items in the GPO, on a client. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValueName -Specifies the name of a registry value for which to retrieve all Registry preference items. -For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. -For the default value of a registry key, specify either "(default)" or an empty string (""). - -When you want to retrieve Registry preference items for a registry key and all its first-level values, do not specify this parameter. -When you want to retrieve Registry preference items only for a specific registry value, specify this parameter together with the Key parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -This cmdlet takes a GPO as input. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.PreferenceRegistrySetting -This cmdlet returns PreferenceRegistrySetting objects. -You can pipe these objects to the following cmdlets: - -Set-GPPrefRegistryValue - -Remove-GPPrefRegistryValue - -## NOTES -* If a Registry preference item for the specified registry key or value is not found, a non-terminating error occurs. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell® or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Remove-GPPrefRegistryValue](./Remove-GPPrefRegistryValue.md) - -[Set-GPPrefRegistryValue](./Set-GPPrefRegistryValue.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPRegistryValue.md b/docset/winserver2012-ps/grouppolicy/Get-GPRegistryValue.md deleted file mode 100644 index 12eaf63919..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPRegistryValue.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gpregistryvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPRegistryValue - -## SYNOPSIS -Retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-GPRegistryValue [-Domain ] [-Server ] [-ValueName ] -Guid -Key -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-GPRegistryValue [-Name] [-Domain ] [-Server ] [-ValueName ] -Key -``` - -## DESCRIPTION -The Get-GPRegistryValue cmdlet retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. - -You can retrieve registry-based policy settings for a specific registry value, or for all the registry values under a key: - -- To retrieve the registry-based policy setting that configures a specific registry value, specify both the Key and the ValueName parameters. - -- To retrieve all the registry-based policy settings that configure values directly under a registry key, specify the Key parameter without the ValueName parameter. - -If you specify only a key, in addition to the policy settings that configure values under the key, the following first-level subkeys of the key are returned: - -- first-level subkeys that have a policy setting that configures a value. - -- first-level subkeys that have a subkey (at any level) with a policy setting that configures a value. - -You can use this information to browse for registry-based policy settings. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-GPRegistryValue -Name TestGPO -Key HKCU\Software\Policies\Microsoft\ExampleKey -ValueName ValueOne - -KeyPath : Software\Policies\Microsoft\ExampleKey -FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey -Hive : CurrentUser -PolicyState : Set -Value : DataString 1 -Type : String -ValueName : ValueOne -HasValue : True -``` - -Description - ------------ - -This command retrieves the registry-based policy setting that configures the registry value "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey ValueOne" from User Configuration in the "TestGPO" GPO. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPRegistryValue -Name TestGPO -Key HKCU\Software\Policies\Microsoft\ExampleKey - -KeyPath : Software\Policies\Microsoft\ExampleKey -FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey -Hive : CurrentUser -PolicyState : Set -Value : DataString 1 -Type : String -ValueName : ValueOne -HasValue : True - -KeyPath : Software\Policies\Microsoft\ExampleKey -FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey -Hive : CurrentUser -PolicyState : Delete -Value : -Type : String -ValueName : ValueTwo -HasValue : True - - -KeyPath : Software\Policies\Microsoft\ExampleKey\Subkey1 -FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\Subkey1 -Hive : CurrentUser - -KeyPath : Software\Policies\Microsoft\ExampleKey\SubKey2 -FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\SubKey2 -Hive : CurrentUser -``` - -Description - ------------ - -This command retrieves all the registry-based policy settings that configure registry values under the key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" from User Configuration in the "TestGPO" GPO. -Subkeys (of this key) that have registry-based policy settings, are also returned. -The second registry-based policy setting (ValueTwo) is disabled (its PolicyState property is set to Delete). - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPRegistryValue cmdlet, the GPO for which to retrieve registry-based policy settings must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: domainname - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies the registry key for which to retrieve the registry-based policy setting (or settings). -For example: "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". - -The key must be in one of the two following registry hives: - -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. - -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. - -You can specify: - -- The Key parameter without the ValueName parameter to retrieve all the registry-based policy settings that configure values directly under that key. - -- The Key parameter together with the ValueName parameter to retrieve the registry-based policy setting that configures a specific registry value. - -You can also refer to the Key parameter by its built-in alias "FullKeyPath". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: FullKeyPath - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO from which to retrieve the registry-based policy setting by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: displayname - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.SalesDomain.Contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValueName -Specifies the name of a registry value for which to retrieve the registry-based policy setting. -For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a value with the following name: UseDomainNameDevolution. -For the default value of a registry key, specify "(default)" or an empty string (""). - -You must also specify the Key parameter with this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -A GPO for which to retrieve registry-based policy settings. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.PolicyRegistrySetting -Get-GPRegistryValue returns PolicyRegistrySetting objects that represent registry-based policy settings. -These objects can be piped into the following cmdlets: - -Set-GPRegistryValue - -Remove-GPRegistryValue - -## NOTES -* The hive of the registry key that you specify (HKLM or HKCU) indicates whether the registry-based policy setting is retrieved from Computer Configuration or User Configuration. - - If the specified registry key cannot be located in policy (the registry key is not configured), a corresponding error message is displayed. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell® or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Remove-GPRegistryValue](./Remove-GPRegistryValue.md) - -[Set-GPRegistryValue](./Set-GPRegistryValue.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPResultantSetOfPolicy.md b/docset/winserver2012-ps/grouppolicy/Get-GPResultantSetOfPolicy.md deleted file mode 100644 index eb2c3362fd..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPResultantSetOfPolicy.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gpresultantsetofpolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPResultantSetOfPolicy - -## SYNOPSIS -Outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file. - -## SYNTAX - -``` -Get-GPResultantSetOfPolicy [-Computer ] [-User ] -Path -ReportType -``` - -## DESCRIPTION -The Get-GPResultantSetOfPolicy cmdlet outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>get-GPResultantSetOfPolicy -reporttype xml -path c:\reports\LocalUserAndComputerReport.xml - -RsopMode : Logging -Namespace : \\COMPUTER-02-PC\Root\Rsop\NS2BBE3F29_794F_4EAE_B9DB_0A2310622534 -LoggingComputer : COMPUTER-02 -LoggingUser : CONTOSO\someuser -LoggingMode : UserAndComputer -``` - -Description - ------------ - -This command generates a report for the user (CONTOSO\someuser) that is running the session and the computer (COMPUTER-02) on which the session is running. -The report is generated in XML format, and is written to the specified file. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPResultantSetOfPolicy -reporttype xml -computer computer-08.contso.com -path c:\reports\computer-08.xml - -RsopMode : Logging -Namespace : \\computer-08.contoso.com\Root\Rsop\NS643B2E66_8F54_4407_A813_7D47173B0922 -LoggingComputer : computer-08.contoso.com -LoggingUser : CONTOSO\Administrator -LoggingMode : Computer -``` - -Description - ------------ - -This command generates a report for the specified computer. -The computer is specified by its fully qualified domain name (FQDN), computer-08.contoso.com. -The report is generated in XML format, and is written to the specified file. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-GPResultantSetOfPolicy -user contoso\someuser -reporttype html -path c:\reports\UserReport.html - -RsopMode : Logging -Namespace : \\COMPUTER-02\Root\Rsop\NS78355E76_C754_41B5_8F5E_B61551837A62 -LoggingComputer : COMPUTER-02 -LoggingUser : contoso\someuser -LoggingMode : User -``` - -Description - ------------ - -This command generates a report for the specified user (contoso\someuser) in HTML format and saves it to the specified file. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Get-GPResultantSetOfPolicy -user someuser -computer contoso.com\computer-08 -reporttype html -path c:\reports\UserAndComputerReport.html - -RsopMode : Logging -Namespace : \\computer-08\Root\Rsop\NS72116C25_6570_4586_9B79_FC4F71372E57 -LoggingComputer : contoso.com\computer-08 -LoggingUser : someuser -LoggingMode : UserAndComputer -``` - -Description - ------------ - -This command generates a report for the specified computer (contoso.com\computer-08) and user (someuser) in HTML format and saves it to the specified file. - -## PARAMETERS - -### -Computer -Specifies the name of the computer for which to generate the report. -You can specify the computer name in one of the following formats: - -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. - -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. - -- NetBIOS domain name\computer name; for example, sales\computer-01. - -- Computer name (host name): for example, computer-01. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the report file; for example, c:\Reports\GpRsopReport.xml. - -You can also refer to the Path parameter by its built-in alias, "filepath". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReportType -Specifies the format of the RSoP report. -You must specify either Html (for HTML format) or Xml (for XML format). -These values are not case sensitive. - -The following values are permitted for this object type. - -```yaml -Type: ReportType -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -User -Specifies the user name of the user for which to generate the report. -You can specify the user name in one of the following formats: - -- Fully qualified domain name (FQDN)\user name; for example, sales.contoso.com\someuser. - -- NetBIOS domain name\user name; for example, sales\someuser. - -- User name: for example, someuser. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet does not take any object as input. - -## OUTPUTS - -### Microsoft.GroupPolicy.GPRsop -Get-GPResultantSetOfPolicy returns an RSoP object. - -## NOTES -* The Get-GPResultantSetOfPolicy cmdlet provides only the logging results for a specified computer and user. You must use the GPMC to generate RSoP modeling information. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/grouppolicy/Get-GPStarterGPO.md b/docset/winserver2012-ps/grouppolicy/Get-GPStarterGPO.md deleted file mode 100644 index 6d774ed9fc..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Get-GPStarterGPO.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/get-gpstartergpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-GPStarterGPO - -## SYNOPSIS -Gets one Starter GPO or all Starter GPOs in a domain. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-GPStarterGPO [-All] [-Domain ] [-Server ] -Guid -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-GPStarterGPO [-All] [-Domain ] [-Server ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-GPStarterGPO [-Name] [-All] [-Domain ] [-Server ] -``` - -## DESCRIPTION -The Get-GPStarterGPO cmdlet gets one Starter GPO or all Starter GPOs in a domain. -You can specify the Starter GPO to retrieve either by display name or by GUID, or you can specify the All parameter to get all the Starter GPOs in the domain. - -You can use this cmdlet to get information about a StarterGPO, or you can create a new GPO from a specified Starter GPO by piping the output of this cmdlet into the New-GPO cmdlet. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Get-GPStarterGPO -Name "Windows Vista EC User" - -DisplayName : Windows Vista EC User -Id : 8780588e-ef91-442b-bd5f-2d50de7abf76 -Owner : BUILTIN\Administrators -Created : 9/10/2008 12:18:46 PM -Modified : 4/26/2008 3:25:52 PM -UserVersion : -ComputerVersion : -StarterGpoVersion : 0 -StarterGpoType : System -Author : Microsoft -Description : This Starter GPO contains the user Group Policy settings recommended for the Enterprise Client (EC) environment described in the Windows Vista security guide. - -For more information about each of these settings, see the Windows Vista Security Guide (http://go. microsoft.com/fwlink/?LinkID=121852). -``` - -Description - ------------ - -This command gets the "Windows Vista EC User" Starter GPO. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Get-GPStarterGPO -Name "Windows Vista EC User" | New-GPO -Name TestGPO-Comment "Create a GPO by using a Starter GPO" - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -GpoId : f2828b5c-363a-41f6-afb1-5fa111df715f -GpoStatus : AllSettingsEnabled -Description : Create a GPO by using a Starter GPO -CreatedTime : 2/5/2009 6:46:04 PM -LastModified : 2/5/2009 6:46:04 PM -UserVersion : AD Version: 1, SysVol Version: 1 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : -``` - -Description - ------------ - -This command creates a GPO named TestGPO from the "Windows Vista EC User" Starter GPO. -The Starter GPO is retrieved by the Get-GPStarterGPO command and is then piped into the New-GPO command to create the new GPO. - -## PARAMETERS - -### -All -Returns all the Starter GPOs in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Get-GPStarterGPO cmdlet, the Starter GPO must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: domainname - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -Specifies the Starter GPO to retrieve by its globally unique identifier (GUID). -The GUID uniquely identifies the Starter GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the Starter GPO to retrieve by its display name. - -The display name is not guaranteed to be unique in the domain. -If another Starter GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a Starter GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: displayname - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.SalesDomain.Contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.StarterGpo -A Starter GPO. - -## OUTPUTS - -### Microsoft.GroupPolicy.StarterGpo object -Get-GPStarterGPO returns a Starter GPO object. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session, for example, the domain of the user who started the session by opening Windows PowerShell® or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[New-GPO](./New-GPO.md) - -[New-GPStarterGPO](./New-GPStarterGPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/GroupPolicy.md b/docset/winserver2012-ps/grouppolicy/GroupPolicy.md deleted file mode 100644 index 811fa4dd0c..0000000000 --- a/docset/winserver2012-ps/grouppolicy/GroupPolicy.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 03e49e3a-be77-4422-9d97-8fe355c2284c -Module Name: GroupPolicy ---- - -# GroupPolicy Module -## Description -This topic contains brief descriptions of the Windows PowerShell cmdlets that are used to administer Group Policy in Windows Server and Windows client with Remote Server Administration Tools (RSAT) installed. (RSAT includes the GPMC and the Group Policy cmdlets). - -Each cmdlet in the table is linked to additional information about that cmdlet. - -## GroupPolicy Cmdlets -### [Backup-GPO](./Backup-GPO.md) -Backs up one GPO or all the GPOs in a domain. - -### [Copy-GPO](./Copy-GPO.md) -Copies a GPO. - -### [Get-GPInheritance](./Get-GPInheritance.md) -Retrieves Group Policy inheritance information for a specified domain or OU. - -### [Get-GPO](./Get-GPO.md) -Gets one GPO or all the GPOs in a domain. - -### [Get-GPOReport](./Get-GPOReport.md) -Generates a report either in XML or HTML format for a specified GPO or for all GPOs in a domain. - -### [Get-GPPermission](./Get-GPPermission.md) -Gets the permission level for one or more security principals on a specified GPO. - -### [Get-GPPrefRegistryValue](./Get-GPPrefRegistryValue.md) -Retrieves one or more Registry preference items under either Computer Configuration or User Configuration in a GPO. - -### [Get-GPRegistryValue](./Get-GPRegistryValue.md) -Retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. - -### [Get-GPResultantSetOfPolicy](./Get-GPResultantSetOfPolicy.md) -Outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file. - -### [Get-GPStarterGPO](./Get-GPStarterGPO.md) -Gets one Starter GPO or all Starter GPOs in a domain. - -### [Import-GPO](./Import-GPO.md) -Imports the Group Policy settings from a backed-up GPO into a specified GPO. - -### [Invoke-GPUpdate](./Invoke-GPUpdate.md) -Schedule a remote Group Policy refresh (gpupdate) on the specified computer. - -### [New-GPLink](./New-GPLink.md) -Links a GPO to a site, domain, or organizational unit (OU). - -### [New-GPO](./New-GPO.md) -Creates a new GPO. - -### [New-GPStarterGPO](./New-GPStarterGPO.md) -Creates a new Starter GPO. - -### [Remove-GPLink](./Remove-GPLink.md) -Removes a GPO link from a site, domain or OU. - -### [Remove-GPO](./Remove-GPO.md) -Deletes a GPO. - -### [Remove-GPPrefRegistryValue](./Remove-GPPrefRegistryValue.md) -Removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. - -### [Remove-GPRegistryValue](./Remove-GPRegistryValue.md) -Removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO. - -### [Rename-GPO](./Rename-GPO.md) -Assigns a new display name to a GPO. - -### [Restore-GPO](./Restore-GPO.md) -Restores one GPO or all GPOs in a domain from one or more GPO backup files. - -### [Set-GPInheritance](./Set-GPInheritance.md) -Blocks or unblocks inheritance for a specified domain or organizational unit (OU). - -### [Set-GPLink](./Set-GPLink.md) -Sets the properties of the specified GPO link. - -### [Set-GPPermission](./Set-GPPermission.md) -Grants a level of permissions to a security principal for one GPO or all the GPOs in a domain. - -### [Set-GPPrefRegistryValue](./Set-GPPrefRegistryValue.md) -Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. - -### [Set-GPRegistryValue](./Set-GPRegistryValue.md) -Configures one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. - diff --git a/docset/winserver2012-ps/grouppolicy/Import-GPO.md b/docset/winserver2012-ps/grouppolicy/Import-GPO.md deleted file mode 100644 index 07a6f6ad43..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Import-GPO.md +++ /dev/null @@ -1,356 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/import-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-GPO - -## SYNOPSIS -Imports the Group Policy settings from a backed-up GPO into a specified GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Import-GPO [-CreateIfNeeded] [-Domain ] [-MigrationTable ] [-Server ] - [-TargetGuid ] [-TargetName ] -BackupId -Path [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Import-GPO [-CreateIfNeeded] [-Domain ] [-MigrationTable ] [-Server ] - [-TargetGuid ] [-TargetName ] -BackupGpoName -Path [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Import-GPO cmdlet imports the settings from a GPO backup into a specified target GPO. -The target GPO can be in a different domain or forest than that from which the backup was made and it does not have to exist prior to the operation. - -Use the Path parameter to specify the location of the backup and then use the BackupGpoName parameter to specify the GPO name of the backup to use, or the BackupId parameter to specify the backup ID (GUID) of the backup to use. - -Note that if you specify a GPO name, the cmdlet imports the most recent backup. -To import an earlier version of a GPO backup, you must use the BackupID parameter to specify the unique backup ID for the particular version. -This is the GUID that uniquely identifies the backup within its backup directory. - -Use the TargetName parameter or the TargetGuid parameter to specify the target GPO into which the settings should be imported. -Use the optional MigrationTable parameter to map security principals and UNC paths across domains. -Use the CreateIfNeeded parameter to create a new GPO if the specified target GPO does not exist. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>import-gpo -BackupGpoName TestGPO -TargetName TestGPO -path c:\backups - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 87d38d82-cc2d-4bf7-ad9f-4083a60316eb -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/3/2009 1:03:28 PM -ModificationTime : 3/6/2009 5:03:29 PM -UserVersion : AD Version: 9, SysVol Version: 9 -ComputerVersion : AD Version: 5, SysVol Version: 5 -WmiFilter : -``` - -Description - ------------ - -This command imports the settings from the most recent backup of the GPO named TestGPO in the c:\backups directory into a GPO of the same name in the current domain. -If a GPO named TestGPO does not exist in the current domain, the command fails because the CreateIfNeeded parameter is not specified. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>import-gpo -BackupId A491D730-F3ED-464C-B8C9-F50562C536AA -TargetName TestGPO -path c:\backups -CreateIfNeeded - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 87d38d82-cc2d-4bf7-ad9f-4083a60316eb -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/3/2009 1:03:28 PM -ModificationTime : 3/6/2009 5:11:49 PM -UserVersion : AD Version: 10, SysVol Version: 10 -ComputerVersion : AD Version: 6, SysVol Version: 6 -WmiFilter : -``` - -Description - ------------ - -This command imports the settings from the specified backup in the c:\backups directory into a GPO that is named TestGPO in the current domain. -The BackupId parameter is used to specify the GUID of the GPO backup to use. -Because the CreateIfNeeded parameter is specified, if a GPO named TestGPO does not exist in the current domain, one is created before the settings are imported. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Import-GPO -BackupGpoName TestGPO -Path D:\Backups -TargetName NewTestGPO -MigrationTable D:\Tables\Migtable1.mitable -CreateIfNeeded - -DisplayName : NewTestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 87d38d82-cc2d-4bf7-ad9f-4083a60316eb -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/3/2009 1:03:28 PM -ModificationTime : 3/6/2009 5:11:49 PM -UserVersion : AD Version: 1, SysVol Version: 1 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : -``` - -Description - ------------ - -This command imports the settings from the most recent backup of the GPO named TestGPO from the d:\backups directory to a GPO named NewTestGPO in the current domain. -The specified migration table is used to migrate security principals and UNC paths to the new GPO. -Because the CreateIfNeeded parameter is specified, the GPO is created if it does not already exist. - -## PARAMETERS - -### -BackupGpoName -Specifies the display name of the backed-up GPO from which to import the settings. -The most recent backup of the GPO is used. -You can use the BackupId parameter to specify a particular version to use when multiple backups of the same GPO exist in the backup directory. - -You can also refer to the BackupGpoName parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: displayname - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -BackupId -Specifies the backup ID of a GPO backup. -The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. -You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. - -Note: The backup ID is different from the ID of the GPO that was backed up. - -You can also refer to the BackupId parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CreateIfNeeded -Specifies that a new GPO is created from the backup if the specified target GPO does not exist. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Import-GPO cmdlet, this is the domain into which you want to import the GPO. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: domainname - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MigrationTable -Specifies the path to a migration table file. -You can use a migration table to map security principals and UNC paths across domains. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the backup directory. - -You can also refer to the Path parameter by its built-in aliases: "backuplocation" or "backupdirectory". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: backuplocation - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetGuid -Specifies the GUID of the GPO into which the settings are to be imported. -Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. - -You must specify either the TargetGuid parameter or the TargetName parameter. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -Specifies the display name of the GPO into which the settings are to be imported. -Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. - -You must specify either the TargetGuid parameter or the TargetName parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.GpoBackup -An object that represents a GPO backup on the file system. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Import-GPO returns an object that represents the GPO after the settings have been imported. - -## NOTES -* You can use the Import-GPO to copy settings from a GPO backup in one domain to the same domain or another domain in the same or different forest. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session for example, the domain of the user who started the session by opening Windows PowerShell® or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Backup-GPO](./Backup-GPO.md) - -[Restore-GPO](./Restore-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Invoke-GPUpdate.md b/docset/winserver2012-ps/grouppolicy/Invoke-GPUpdate.md deleted file mode 100644 index 09316186f7..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Invoke-GPUpdate.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/invoke-gpupdate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-GPUpdate - -## SYNOPSIS -Schedule a remote Group Policy refresh (gpupdate) on the specified computer. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Invoke-GPUpdate [[-Computer] ] [[-RandomDelayInMinutes] ] [-AsJob] [-Boot] [-Force] [-LogOff] - [-Target ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Invoke-GPUpdate [[-Computer] ] [[-RandomDelayInMinutes] ] [-AsJob] [-Boot] [-LogOff] [-Sync] - [-Target ] -``` - -## DESCRIPTION -The Invoke-GPUpdate cmdlet refreshes Group Policy settings, including security settings that are set on remote computers by scheduling the running of the Gpupdate command on a remote computer. -You can combine this cmdlet in a scripted fashion to schedule the Gpupdate command on a group of computers. - -The refresh can be scheduled to immediately start a refresh of policy settings or wait for a specified period of time, up to a maximum of 31 days. -To avoid putting a load on the network, the refresh times will be offset by a random delay. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -PS C:\>Invoke-GPUpdate -``` - -Description - ------------ - -This command schedules a Group Policy refresh on the computer on which you are running the Invoke-GPUpdate cmdlet. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -PS C:\>Invoke-GPUpdate -computer COMPUTER-02 -Target user -Sync -``` - -Description - ------------ - -This command schedules a Group Policy refresh on a remote computer (CONTOSO\COMPUTER-02) which will only schedule to update the user policy settings in synchronous mode. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Boot -Causes a computer restart after the Group Policy settings are applied. -This is required for those Group Policy client side extensions (CSEs) that do not process Group Policy on a background update cycle, but do process Group Policy at computer startup, for example, per-computer Software Installation policy settings. - -This parameter has no effect if there are no CSEs called that require a restart. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Computer -Specifies the name of the computer for which to schedule a Group Policy refresh. -You can specify the computer name in one of the following formats: - -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. - -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. - -- NetBIOS domain name\computer name; for example, sales\computer-01. - -- Computer name (host name): for example, computer-01. - -If the computer name is not specified the computer, on which the Invoke-GPUpdate cmdlet was run, will have the Group Policy settings refreshed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Force -Reapplies all policy settings. -By default, Group Policy is only refreshed when policy settings have changed. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogOff -Causes a logoff after the policy settings have been updated. -This is required for those Group Policy client-side extensions (CSEs) that do not process Group Policy on a background update cycle but do process Group Policy when a user logs on. -Examples include per-user Software Installation policy settings and the Folder Redirection extension. - -This parameter has no effect if there are no CSEs called that require a logoff. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RandomDelayInMinutes -Specifies the delay, in minutes that Task Scheduler will wait, with a random factor added to lower the network load, before running a scheduled Group Policy refresh. - -You can specify a delay in from 0 minutes to a maximum of 44640 minutes (31 days): - -- A value of 0 will cause the Group Policy refresh to run as soon as the gpupdate task has been scheduled. - --A value in the range of 1 to the maximum value of 44640 minutes cause the Group Policy refresh to delay the specified number of minutes plus a random offset before starting the Group Policy refresh. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Sync -Causes the next foreground Group Policy application to be done synchronously. -Foreground Group Policy applications occur at computer startup and user logon. -You can specify this for the user, computer or both using the Target parameter. - -On a client computer, by default, Group Policy processes synchronously at computer startup and asynchronously at user logon. - -On a server, by default Group Policy processes synchronously at computer startup and at user logon. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies that only user or computer policy settings are refreshed. -By default, both user and computer policy settings are refreshed. -You can specify one of two allowable values for this parameter: - -- User - -- Computer - -If the target parameter is not specified both user and computer policy settings will be refreshed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet does not take any object as input. - -## OUTPUTS - -### None -Invoke-GPUpdate does not return an object. - -## NOTES -* The Invoke-GPUpdate cmdlet does not support scheduling a Group Policy refresh for computers running Windows XP or earlier. -* In order to successfully schedule a Group Policy refresh for computers using the Invoke-GPUpdate cmdlet, the following Firewall rules must be set on each client computer to allow the following connections: - - --Remote Scheduled Tasks Management (RPC) - - --Remote Scheduled Tasks Management (RPC-ERMAP) - - --Windows Management Instrumentation (WMI-IN) - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/grouppolicy/New-GPLink.md b/docset/winserver2012-ps/grouppolicy/New-GPLink.md deleted file mode 100644 index a64dfc5daf..0000000000 --- a/docset/winserver2012-ps/grouppolicy/New-GPLink.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/new-gplink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-GPLink - -## SYNOPSIS -Links a GPO to a site, domain, or organizational unit (OU). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-GPLink [-Domain ] [-Enforced ] [-LinkEnabled ] [-Order ] - [-Server ] -Guid -Target [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-GPLink [-Name] [-Domain ] [-Enforced ] [-LinkEnabled ] - [-Order ] [-Server ] -Target [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The New-GPLink cmdlet links a GPO to a site, domain, or OU. -By default, the link is enabled, which means that the settings of the GPO are applied at the level of the target Active Directory container (site, domain, or OU) according to the rules of inheritance and precedence when Group Policy is processed. - -You can specify the GPO by either its display name or its GUID; or the GPO can be piped into the cmdlet. -You specify the site, domain, or OU to link to by its LDAP distinguished name. -You can use other parameters to specify whether the link is enabled, whether the link is enforced, and the order in which it is applied at the site, domain, or OU. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-GPO -Name "MyGPO" | New-GPLink -target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes - -GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 -DisplayName : MyGPO -Enabled : True -Enforced : False -Target : OU=MyOU,DC=contoso,DC=com -Order : 1 -``` - -Description - ------------ - -This command creates the "MyGPO" GPO in the domain of the user (or, for a startup or shutdown script, the computer) and links it to the "MyOU" organizational unit in the contoso.com domain. -If the domain of the user (or the computer) is different than contoso.com, a trust relationship must exist between the two domains. - -Because New-GPLink can take a GPO as input, you can insert any command that returns a GPO between New-GPO and New-GPLink to configure the GPO. -For example, you can insert Set-GPPermissions commands to set permissions on the GPO, Set-GPRegistryValue commands to configure one or more registry-based policy settings for the GPO, or Set-GPPrefRegistryValue commands to configure one or more Registry preference items for the GPO. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>new-gplink -name testgpo -target "dc=contoso,dc=com" - -GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 -DisplayName : TestGPO -Enabled : True -Enforced : False -Target : DC=contoso,DC=com -Order : 2 -``` - -Description - ------------ - -This command links the "TestGPO" GPO in the domain of the user (or, for a startup or shutdown script, the computer) to the contoso.com domain. -If the domain of the user (or the computer) is different than contoso.com, a trust relationship must exist between the two domains. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>new-gplink -name testgpo -target "test-site" -enforced yes - -GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 -DisplayName : TestGPO -Enabled : True -Enforced : True -Target : CN=test-site,cn=Sites,CN=Configuration,DC=contoso,DC=com -Order : 1 -``` - -Description - ------------ - -This command links the "TestGPO" GPO to the "test-site" site and sets the link to enforced. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the New-GPLink cmdlet: - -- The GPO to link from must exist in this domain. - -- The Active Directory container to link to must exist in a domain that has a trust relationship with this domain. - -Note: To specify a domain to link to, use the Target parameter. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enforced -Specifies whether the GPO link is enforced. -You can specify Yes or No. -By default, GPO links are not enforced. - -By setting the GPO link to enforced, you ensure the following: - -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. - -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. - -This option should be used sparingly. -Casual use of this option complicates troubleshooting. - -The following values are permitted for this object type. - -```yaml -Type: EnforceLink -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO to link by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO in the domain. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LinkEnabled -Specifies whether the GPO link is enabled. -You can specify Yes or No. - -By default, Group Policy processing is enabled for all GPO links. -You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. -Disabling a GPO link does not disable the GPO itself. -If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. - -The following values are permitted for this object type. - -```yaml -Type: EnableLink -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Disabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO to link by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Specifies the link order for the GPO link. -You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. - -The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. -When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. -Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. -A lower number indicates higher precedence. - -By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). -Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. -You can change the link order of a GPO link with the Set-GPLink cmdlet. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the LDAP distinguished name of the site, domain, or OU to which to link the GPO. -For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -A GPO to be linked to an Active Directory container. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.GpoLink -New-GPLink returns an object that represents the link between the GPO and the site, domain, or OU. - -## NOTES -* To link a GPO to a site, domain, or OU, you must have Link GPOs permission on that site, domain, or OU. By default, only domain administrators and enterprise administrators have this privilege for domains and OUs. Enterprise administrators and domain administrators of the forest root domain have this privilege for sites. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Remove-GPLink](./Remove-GPLink.md) - -[Set-GPLink](./Set-GPLink.md) - diff --git a/docset/winserver2012-ps/grouppolicy/New-GPO.md b/docset/winserver2012-ps/grouppolicy/New-GPO.md deleted file mode 100644 index d9af36058c..0000000000 --- a/docset/winserver2012-ps/grouppolicy/New-GPO.md +++ /dev/null @@ -1,301 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/new-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-GPO - -## SYNOPSIS -Creates a new GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-GPO [-Name] [-Comment ] [-Domain ] [-Server ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-GPO [-Name] [-Comment ] [-Domain ] [-Server ] -StarterGpoName - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -New-GPO [-Name] [-Comment ] [-Domain ] [-Server ] -StarterGpoGuid - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The New-GPO cmdlet creates a new GPO with a specified name. -By default, the newly created GPO is not linked to a site, domain, or organizational unit (OU). - -You can use this cmdlet to create a GPO that is based on a starter GPO by specifying the GUID or the display name of the Starter GPO, or by piping a StarterGpo object into the cmdlet. - -The cmdlet returns a GPO object, which represents the newly created GPO, that you can pipe to other Group Policy cmdlets. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-GPO -Name TestGPO -comment "This is a test GPO." - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : b8c1f2c2-fbd3-4a1f-94e1-3e156a65a29a -GpoStatus : AllSettingsEnabled -Description : This is a test GPO. -CreationTime : 3/2/2009 3:37:23 AM -ModificationTime : 3/2/2009 3:37:22 AM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command creates a GPO in the domain of the user. -The GPO is created with the specified comment. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>New-GPO -Name FromStarterGPO -StarterGPOName "Windows Vista EC Computer Starter GPO" -``` - -Description - ------------ - -This command creates a GPO in the domain of the user. -The GPO is pre-populated with the settings of the Starter GPO. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>new-gpo -name TestGPO | new-gplink -target "ou=marketing,dc=contoso,dc=com" | set-gppermissions -permissionlevel gpoedit -targetname "Marketing Admins" -targettype group - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : b8c1f2c2-fbd3-4a1f-94e1-3e156a65a29a -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/2/2009 3:37:23 AM -ModificationTime : 3/2/2009 3:37:22 AM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command creates a new GPO ("TestGPO"), links it to the "Marketing" OU in the contoso.com domain, and grants the "Marketing Admins" security group permissions to edit the GPO. - -A GPO object is returned by the command, so you could continue to configure the new GPO by piping the output to other cmdlets. -For example, you could set Registry preference items or registry-based policy settings by piping the output to Set-GPPrefRegistryValue or to Set-GPRegistryValue. - -## PARAMETERS - -### -Comment -Includes a comment for the new GPO. -The comment string must be enclosed in double- or single-quotation marks and can contain 2,047 characters. - -Use the comment to document the GPO and its implementation in your environment. -Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). - -For the New-GPO cmdlet: - -- The new GPO is created in this domain. - -- If a Starter GPO is specified, it must exist in this domain. - -If you do not specify the Domain parameter, then the domain of the user running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full help. - -If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user (or computer). - -You can also refer to Domain by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Current domain -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Assigns a display name to the new GPO. - -If another GPO with the same display name exists in the domain an error occurs. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.SalesDomain.Contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StarterGpoGuid -Specifies a Starter GPO by its globally unique identifier (GUID). -The GUID uniquely identifies the Starter GPO. -If a Starter GPO is specified, the GPO is created with its settings. - -You can also refer to the StarterGpoGuid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StarterGpoName -Specifies a Starter GPO by its display name. -The name can contain 255 characters. -If the name includes blank characters, enclose the name in double-quotation marks or single-quotation marks. -If a Starter GPO is specified, the GPO is created with its settings. - -The display name is not guaranteed to be unique in the domain. -If another Starter GPO with the same display name exists in the domain, an error occurs. -You can use the StarterGpoGuid parameter to uniquely identify a Starter GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.StarterGpo -A Starter GPO that has predefined settings. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -New-GPO returns the GPO that was created. - -## NOTES -* Only domain administrators, enterprise administrators, and members of the Group Policy creator owners group can create GPOs. These users must run Windows PowerShell in an elevated state. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/grouppolicy/New-GPStarterGPO.md b/docset/winserver2012-ps/grouppolicy/New-GPStarterGPO.md deleted file mode 100644 index c6a11aad29..0000000000 --- a/docset/winserver2012-ps/grouppolicy/New-GPStarterGPO.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/new-gpstartergpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-GPStarterGPO - -## SYNOPSIS -Creates a new Starter GPO. - -## SYNTAX - -``` -New-GPStarterGPO [-Name] [-Comment ] [-Domain ] [-Server ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The New-GPStarterGPO cmdlet creates a Starter GPO with the specified name. -If the Starter GPOs folder does not exist in the SYSVOL when the New-GPStarterGPO cmdlet is called, it is created and populated with the eight Starter GPOs that ship with Group Policy. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>New-GPStarterGPO -Name StarterSecurity -Comment "Security Template" -``` - -Description - ------------ - -This command creates a Starter GPO with the display name StarterSecurity. -The Starter GPO is annotated with the specified comment. - -## PARAMETERS - -### -Comment -Includes a comment for the new Starter GPO. -The comment string must be enclosed in double-quotation marks or single-quotation marks and can contain 2,047 characters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -Note: Cross-domain creation of Starter GPOs is not supported. -If you specify a domain that is different from the domain of the user that is running the current session, an error occurs. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the display name for the new Starter GPO. - -If another Starter GPO with the same display name exists in the domain, an error occurs. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: NewGPO -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.SalesDomain.Contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator will be contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet does not accept any input. - -## OUTPUTS - -### Microsoft.GroupPolicy.StarterGpo -New-StarterGPO returns the Starter GPO that was created. - -## NOTES - -## RELATED LINKS - -[Get-GPStarterGPO](./Get-GPStarterGPO.md) - -[New-GPO](./New-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Remove-GPLink.md b/docset/winserver2012-ps/grouppolicy/Remove-GPLink.md deleted file mode 100644 index 287a1f6255..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Remove-GPLink.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/remove-gplink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-GPLink - -## SYNOPSIS -Removes a GPO link from a site, domain or OU. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-GPLink [-Domain ] [-Server ] -Guid -Target [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-GPLink [-Name] [-Domain ] [-Server ] -Target [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Remove-GPLink cmdlet deletes the link between a GPO and a specified site, domain, or OU. -This cmdlet does not delete the actual GPO or any other links between the specified GPO and other sites, domains, or OUs. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-GPLink -Name "MyGPO" -Target "ou=MyOU,dc=contoso,dc=com" - -DisplayName : MyGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/26/2009 11:28:08 PM -ModificationTime : 3/5/2009 3:36:34 PM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : -``` - -Description - ------------ - -This command removes the link between the "MyGPO" GPO and the "MyOU" organizational unit in the contoso.com domain. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-GPLink -Name "MyGPO" -Target "Default-First-Site-Name" -``` - -Description - ------------ - -This command removes the link between the "MyGPO" GPO and the default site. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | Rem ove-GPLink - -DisplayName : TestGPO-3 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/27/2009 2:59:51 PM -ModificationTime : 3/5/2009 3:36:37 PM -UserVersion : AD Version: 13, SysVol Version: 13 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : - -DisplayName : TestGPO-2 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/26/2009 11:28:08 PM -ModificationTime : 3/5/2009 3:36:34 PM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : -``` - -Description - ------------ - -This command removes the links for all the GPOs that are linked to the "MyOU" organizational unit in the contoso.com domain. - -Get-GPInheritance is used to get a Microsoft.GroupPolicy.Som object for the OU. -The GpoLinks property of the SOM object contains all the GPO links for GPOs that are linked to the OU (links that are inherited from higher-level containers are not included). -This collection is piped into Remove-GPLink. -The GPOs for which links have been removed are returned. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Remove-GPLink cmdlet: - -- The GPO that is linked must exist in this domain. - -- The Active Directory container (site, domain, or OU) that is linked must exist in a domain that has a trust relationship with this domain. - -Note: To specify a domain to link to, use the Target parameter. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO for which to remove the link by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in aliases, "id" and "gpoid". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO for which to remove the link by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the LDAP distinguished name of the site, domain, or OU from which to remove the link. -For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.GpoLink -An object that represents the link between a GPO and a site, domain, or OU. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Remove-GPLink returns the GPO for which the link has been removed. - -## NOTES - -## RELATED LINKS - -[New-GPLink](./New-GPLink.md) - -[Set-GPLink](./Set-GPLink.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Remove-GPO.md b/docset/winserver2012-ps/grouppolicy/Remove-GPO.md deleted file mode 100644 index 60c71ddf64..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Remove-GPO.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/remove-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-GPO - -## SYNOPSIS -Deletes a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-GPO [-Domain ] [-KeepLinks] [-Server ] -Guid [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-GPO [-Name] [-Domain ] [-KeepLinks] [-Server ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Remove-GPO cmdlet removes the GPO container and data from the directory service and the system volume folder (SysVol). - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-GPO -guid 50cc3e45-0b14-46dd-8b4d-afa012bc331c -Domain contoso.com -KeepLinks -``` - -Description - ------------ - -Removes the GPO that has the GUID 50cc3e45-0b14-46dd-8b4d-afa012bc331c from the contoso.com domain. -Because the KeepLinks parameter is specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are preserved. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-GPO -Name TestGPO -``` - -Description - ------------ - -Removes the "TestGPO" GPO from the domain of the user that is running the session (or, for startup and shutdown scripts, the domain of the computer). -Because the KeepLinks parameter is not specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are deleted. - -## PARAMETERS - -### -Domain -Specifies the domain in which you want to remove a GPO. -You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). - -If you do not specify the Domain parameter, the domain of the computer that you are logged on to is used. - -If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO to delete by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KeepLinks -Preserves the links to the GPO in the specified domain (including OUs) and all sites when the GPO is removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO to delete by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -A GPO to be deleted. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### None -This cmdlet does not output any objects. - -## NOTES -* When you delete a GPO, by default, all links to that GPO in the domain of the GPO are deleted. To delete a link to a GPO, you must have permission to link Group Policy Objects for the organizational unit or domain. If you do not have rights to delete a link, the GPO is deleted, but the link remains. Links from other domains and sites are not deleted. The link to a deleted GPO appears in the GPMC as Not Found. To delete Not Found links, you must either have permission on the site, domain, or organizational unit containing the link, or ask someone with sufficient rights to delete it. - -## RELATED LINKS - -[Get-GPO](./Get-GPO.md) - -[New-GPO](./New-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Remove-GPPrefRegistryValue.md b/docset/winserver2012-ps/grouppolicy/Remove-GPPrefRegistryValue.md deleted file mode 100644 index f9dc46b454..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Remove-GPPrefRegistryValue.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/remove-gpprefregistryvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-GPPrefRegistryValue - -## SYNOPSIS -Removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-GPPrefRegistryValue [[-Server] ] [-Domain ] [-Order ] [-ValueName ] - -Context -Guid -Key [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-GPPrefRegistryValue [-Name] [[-Server] ] [-Domain ] [-Order ] - [-ValueName ] -Context -Key [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Remove-GPPrefRegistryValue cmdlet removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. -You must specify the Context parameter (User or Computer) to indicate whether to remove the Registry preference item from Computer Configuration or User Configuration. -. You can specify the GPO by its display name or by its GUID. - -You can specify either a key or a value: - -- If you specify a key, all Registry preference items that configure that registry key or any of its (first-level) values are removed from the specified configuration in the GPO. -Registry preference items that configure subkeys of that key (or their values) are not affected. -For a key, specify the Key parameter without the ValueName parameter. - -- If you specify a value, all Registry preference items that configure that registry value are removed from the specified configuration in the GPO. -For a value, specify the Key parameter without the ValueName parameter. - -This cmdlet can take input from the pipeline: - -- You can pipe GPO objects to this cmdlet to remove a specified Registry preference item from one or more GPOs. - -- You can pipe PreferencRegistrySetting objects to this cmdlet to remove one or more Registry preference items from a specified GPO. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-GPPrefRegistryValue -Name TestGPO -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 92f79f6c-61ce-47d9-8dc6-f78c5cea93ac -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/28/2009 5:15:04 PM -ModificationTime : 2/28/2009 5:15:32 PM -UserVersion : AD Version: 5, SysVol Version: 5 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command removes all Registry preference items that configure the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration in the "TestGPO" GPO. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-GPPrefRegistryValue -Name TestGPO -Context Computer -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 92f79f6c-61ce-47d9-8dc6-f78c5cea93ac -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/28/2009 5:15:04 PM -ModificationTime : 2/28/2009 5:15:32 PM -UserVersion : AD Version: 5, SysVol Version: 5 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command removes Registry preference items that configure any (first-level) values under the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" or the key itself from Computer Configuration in the "TestGPO" GPO. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -ErrorAction SilentlyContinue - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : a83ad1da-9fd4-4005-96b1-7e98042d04de -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/28/2009 5:21:05 PM -ModificationTime : 2/28/2009 5:21:17 PM -UserVersion : AD Version: 5, SysVol Version: 5 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : - - -DisplayName : TestGPO-1 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 277eafe8-5dbf-4e3f-86dc-557eee14d0a4 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/28/2009 2:35:24 PM -ModificationTime : 2/28/2009 5:21:17 PM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command removes any Registry preference items that configure the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration for all GPOs in the domain. -It returns each GPO from which at least one Registry preference item is removed. - -Note: The Remove-GPPrefRegistryValue returns a non-terminating error for each GPO that does not have a Registry preference item associated with the specified registry value. -In this command, these error messages are suppressed by setting the ErrorAction parameter to SilentlyContinue (-ErrorAction SilentlyContinue). -For more information about the ErrorAction parameter, see about_CommonParameters. - -## PARAMETERS - -### -Context -Specifies whether the Registry preference item (or items) are removed from Computer Configuration or User Configuration in the specified GPO. -You must specify either User or Computer. - -The following values are permitted for this object type. - -```yaml -Type: GpoConfiguration -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Remove-GPPrefRegistryValue cmdlet, the GPO from which to remove the Registry preference item (or items) must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO from which to remove the Registry preference item by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies a registry key for which to remove one or more Registry preference items; for example, "HKCU\Control Panel\Colors". - -You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). -Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. - -The Key parameter can be specified with or without the ValueName parameter: - -- If the ValueName parameter is specified, all Registry preference items that configure the registry value are removed. - -- If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are removed. - -You can also refer to the Key parameter by its built-in alias, "FullKeyPath". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO from which to remove the Registry preference item by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Specifies the order in which a Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValueName -Specifies the name of a registry value for which to remove all Registry preference items. -If you specify the ValueName parameter, you must also specify the Key parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PreferenceRegistrySetting -This cmdlet takes a GPO or a PreferenceRegistrySetting object as input. -You can pipe in one or more PreferenceRegistrySetting objects (for example, from Get-GPPrefRegistryValue) to remove one or more Registry preference items from a specified GPO. -You can pipe in one or more GPO objects (for example, from Get-GPO) to remove a specified Registry preference item from each GPO. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Remove-GPPrefRegistryValue returns the GPO from which the Registry preference item (or items) has been removed. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPPrefRegistryValue](./Get-GPPrefRegistryValue.md) - -[Set-GPPrefRegistryValue](./Set-GPPrefRegistryValue.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Remove-GPRegistryValue.md b/docset/winserver2012-ps/grouppolicy/Remove-GPRegistryValue.md deleted file mode 100644 index 551cc77c8f..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Remove-GPRegistryValue.md +++ /dev/null @@ -1,290 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/remove-gpregistryvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-GPRegistryValue - -## SYNOPSIS -Removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-GPRegistryValue [-Guid] [-Key] [[-ValueName] ] [[-Domain] ] - [[-Server] ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-GPRegistryValue [-Name] [-Key] [[-ValueName] ] [[-Domain] ] - [[-Server] ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Remove-GPRegistryValue cmdlet removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO. -You can specify the GPO by its display name or by its GUID. - -You can specify either a key or a value: - -- If you specify a key, registry-based policy settings that configure any of its (first-level) values are removed. -However, if there are registry-based policy settings that configure any subkeys or their values, an error occurs and no policy settings are removed (including those for first-level values of the key). -For a key, specify the Key parameter without the ValueName parameter. - -- If you specify a value, the registry-based policy setting that configures that registry value is removed. -For a value, specify the Key parameter without the ValueName parameter. - -This cmdlet can take input from the pipeline: - -- You can pipe GPO objects to this cmdlet to remove a specified registry-based policy setting from one or more GPOs. - -- You can pipe PolicyRegistrySetting objects to this cmdlet to remove one or more registry-based policy settings from a specified GPO. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Remove-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName ScreenSaveTimeOut - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 35c12ab3-956c-45d5-973b-46b17d225f47 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/24/2009 4:41:03 PM -ModificationTime : 2/25/2009 12:45:52 PM -UserVersion : AD Version: 4, SysVol Version: 4 -ComputerVersion : AD Version: 34, SysVol Version: 34 -WmiFilter : -``` - -Description - ------------ - -This command removes the registry-based policy setting for the registry value "HKEY_CURRENT_USER\Software\Policies\Microsoft\Windows\Control Panel\Desktop ScreenSaveTimeout" from the "TestGPO" GPO. -The registry value is no longer modified when the GPO is applied on a client. -Removing a policy setting does not delete the registry value on a client. -To delete the registry value when the GPO is applied on a client, you must disable the policy setting by using the Set-GPRegistryValue cmdlet. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Remove-GPRegistryValue -Name TestGPO -Key HKCU\Software\Policies\Microsoft\ExampleKey -``` - -Description - ------------ - -This command removes all the registry-based policy settings that configure (first-level) registry values under the key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" from User Configuration in the "TestGPO" GPO. -If there are registry-based policy settings in User Configuration that configure registry values for any subkeys of this key, an error occurs and no (first-level) policy settings are removed. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Remove-GPRegistryValue cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO from which to remove the registry-based policy setting by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies a registry key for which to remove one or more registry-based policy settings (for example: HKLM\Software\Policies\Microsoft\WindowsNT\DNSClient\UseDomainNameDevolution). - -The key must be in one of the two following registry hives: - -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. - -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. - -The Key parameter can be specified with or without the ValueName parameter: - -- If the ValueName parameter is specified, the registry-based policy setting that configures that registry value is removed. - -- If the ValueName parameter is not specified, all registry-based policy settings that configure any of the (first-level) values of the registry key are removed. -If there are registry-based policy settings that configure any subkeys or their values, an error occurs. - -You can also refer to the Key parameter by its built-in alias, "FullKeyPath". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO from which to remove the registry-based policy setting by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ValueName -Specifies the name of the registry value for which to remove the registry-based policy setting (for example: UseDomainNameDevolution). -If you specify the ValueName parameter, you must also specify the Key parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PolicyRegistrySetting -A GPO (from which to remove a registry-based policy setting), or a PolicyRegistrySetting object that represents a registry-based policy setting (to remove from a specified GPO). -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Remove-GPRegistryValue returns the GPO from which the registry-based policy setting (or settings) has been removed. - -## NOTES -* The hive of the registry key that you specify -- HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU) indicates whether the registry-based policy setting is removed from Computer Configuration or User Configuration. - - If a value for the registry key cannot be located (the registry key is not configured) or if subkeys are present, an error occurs and a corresponding error message is displayed. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPRegistryValue](./Get-GPRegistryValue.md) - -[Set-GPRegistryValue](./Set-GPRegistryValue.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Rename-GPO.md b/docset/winserver2012-ps/grouppolicy/Rename-GPO.md deleted file mode 100644 index 3a51b94490..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Rename-GPO.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/rename-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-GPO - -## SYNOPSIS -Assigns a new display name to a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Rename-GPO [-Domain ] [-Server ] -Guid -TargetName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Rename-GPO [-Name] [-Domain ] [-Server ] -TargetName [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Rename-GPO cmdlet assigns a different, non-null display name to a GPO. -This cmdlet has no effect on the GUID of the GPO. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>rename-gpo -name sampleGPO -targetname securityGPO - -DisplayName : securityGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 2c08f9b5-32c3-43fa-af8f-f1939b1ac8a0 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/6/2009 4:20:25 PM -ModificationTime : 3/6/2009 4:20:24 PM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command renames the GPO named sampleGPO to securityGPO. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Rename-GPO cmdlet, this is the domain of the GPO that you want to rename. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO to rename by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO to rename by its current display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -Specifies the new display name of the GPO. -Because the display name may not be unique, an error is returned if another GPO in the domain has the same display name. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -The GPO to rename. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Rename-GPO returns the GPO (with the new display name). - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Copy-GPO](./Copy-GPO.md) - -[Get-GPO](./Get-GPO.md) - -[New-GPO](./New-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Restore-GPO.md b/docset/winserver2012-ps/grouppolicy/Restore-GPO.md deleted file mode 100644 index aad7bcf851..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Restore-GPO.md +++ /dev/null @@ -1,309 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/restore-gpo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-GPO - -## SYNOPSIS -Restores one GPO or all GPOs in a domain from one or more GPO backup files. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Restore-GPO [-Domain ] [-Server ] -BackupId -Path [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Restore-GPO [-Domain ] [-Server ] [-All] -Path [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Restore-GPO [-Domain ] [-Server ] -Guid -Path [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Restore-GPO [-Name] [-Domain ] [-Server ] -Path [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Restore-GPO cmdlet restores a GPO backup to the original domain from which it was saved. -If the original domain is not available, or if the GPO no longer exists in the domain, the cmdlet fails. - -You can: - -- Use the Guid parameter or the Name parameter to restore a GPO from its most recent backup. - -- Use the All parameter to restore all GPOs in the domain from their most recent backups. - -- Use the BackupId parameter to restore a GPO from a specific backup. -This parameter enables you to restore a GPO from a backup prior to the most recent one. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Restore-GPO -Name "TestGPO" -Path \\Server1\Backups -``` - -Description - ------------ - -This command restores the GPO named TestGpo from the \\\\Server1\Backups directory. -The most recent backup is restored. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Restore-GPO -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Path \\Server1\Backups -``` - -Description - ------------ - -This command restores the GPO with the GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde from the \\\\Server1\Backups directory. -The most recent backup is restored. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Restore-GPO -All -Domain contoso.com -Path \\Server1\Backups -``` - -Description - ------------ - -This command restores all of the GPOs in the contoso.com domain previously backed up to \\\\Server1\Backup. -Each GPO is restored using its most recent backup. - -If the domain of user that is running the session (or, for a startup or shutdown script, the domain of the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Restore-GPO -BackupId 0fc29b3c-fb83-4076-babb-6194c1b4fc26 -Path \\Server1\Backups -``` - -Description - ------------ - -This command restores a GPO from the backup specified by the BackupId parameter. -The BackupId parameter can be used to restore a GPO from a backup prior to the most recent backup. - -## PARAMETERS - -### -All -Restores all GPOs in the domain that have backups in the backup directory. -Each GPO is restored from its most recent backup in the directory. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupId -Specifies the backup ID of a GPO backup. -The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. -You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. - -Note: The backup ID is different from the ID of the GPO that was backed up (specified by the Guid parameter). - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Restore-GPO cmdlet, this is the domain in which you want to restore the GPO. -This must be the domain from which the GPO was backed up. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO to restore by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -The GPO is restored from its most recent backup in the backup directory. -To specify a different backup than the most recent backup, use the BackupId parameter. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO to restore by its display name. -The GPO is restored from its most recent backup in the backup directory. -To specify a different backup than the most recent backup, use the BackupId parameter. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the backup directory. - -You can also refer to the Path parameter by its built-in alias, "backuplocation". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.BackupGpo -A GPO backup, a separate file that holds the settings of a GPO that can be imported elsewhere to recreate the GPO. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Restore-GPO returns the restored GPO. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Backup-GPO](./Backup-GPO.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Set-GPInheritance.md b/docset/winserver2012-ps/grouppolicy/Set-GPInheritance.md deleted file mode 100644 index 27cb2f8b3a..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Set-GPInheritance.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/set-gpinheritance?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-GPInheritance - -## SYNOPSIS -Blocks or unblocks inheritance for a specified domain or organizational unit (OU). - -## SYNTAX - -``` -Set-GPInheritance [-Target] [-Domain ] [-Server ] -IsBlocked - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Set-GPInheritance cmdlet blocks or unblocks inheritance for a specified domain or organizational unit (OU). - -GPOs are applied according to the Group Policy hierarchy in the following order: local GPO, GPOs linked to the site, GPOs linked to the domain, GPOs linked to OUs. -By default, an Active Directory container inherits settings from GPOs that are applied at the next higher level in the hierarchy. -Blocking inheritance prevents the settings in GPOs that are linked to higher-level sites, domains, or organizational units from being automatically inherited by the specified domain or OU, unless the link (at the higher-level container) for a GPO is enforced. - -You use the Target parameter to specify the LDAP distinguished name of the domain or OU, and use the IsBlocked parameter to specify whether to block or unblock inheritance. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes - -Name : myou -ContainerType : OU -Path : ou=myou,dc=contoso,dc=com -GpoInheritanceBlocked : Yes -GpoLinks : {TestGPO-1, TestGPO-2} -InheritedGpoLinks : {TestGPO-1, TestGPO-2} -``` - -Description - ------------ - -This command blocks inheritance for the "MyOU" OU in the contoso.com domain. -GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the "MyOU" OU are not applied (unless their links are enforced) when Group Policy is processed for the OU on the client. - -Because inheritance is blocked, only GPOs that are linked directly to the "MyOU" OU (and those that are enforced at higher-level containers) appear in the InheritedGpoLinks list. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-GPInheritance -Target "dc=northwest, dc=contoso, dc=com" -IsBlocked No -``` - -Description - ------------ - -This command unblocks inheritance for the northwest.contoso.com domain. -GPOs linked to higher-level sites or domains are applied to this domain when Group Policy is processed on the client. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-GPInheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked No - -Name : myou -ContainerType : OU -Path : ou=myou,dc=contoso,dc=com -GpoInheritanceBlocked : No -GpoLinks : {TestGPO-1, TestGPO-2} -InheritedGpoLinks : {TestGPO-1, TestGPO-2, Default Domain Policy} -``` - -Description - ------------ - -This command blocks inheritance for the "MyOU" OU in the contoso.com domain. -GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the "MyOU" OU, are applied when Group Policy is processed for the OU on the client. - -Because inheritance is not blocked, GPOs that are inherited from higher-level containers appear in the InheritedGpoLinks list (together with GPOs that are linked directly to the OU). -For example, the "Default Domain Policy" GPO is linked at the domain level. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Set-GPInheritance cmdlet, this is typically the domain of the Active Directory container (domain or OU) for which you want to block or unblock inheritance. -If the domain for the cmdlet is different than the domain of the container, a trust must exist between the two domains. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsBlocked -Specifies whether to block inheritance for the domain or OU. -You must specify Yes or No. - -The following values are permitted for this object type. - -```yaml -Type: BlockInheritance -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the domain or the OU for which to block or unblock inheritance by its LDAP distinguished name. -For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". - -You can also refer to the Target parameter by its built-in alias, "path". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Som -This cmdlet takes an object that represents a domain or an OU as input. - -## OUTPUTS - -### Microsoft.GroupPolicy.Som -Set-GPInheritance returns an object that represents the domain or OU after the operation is applied. -The properties of this object that are displayed by default describe the Group Policy inheritance information for the domain or OU. -The GpoInheritanceBlocked property indicates whether inheritance is blocked. - -## NOTES -* GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of this cmdlet can complicate troubleshooting. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPInheritance](./Get-GPInheritance.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Set-GPLink.md b/docset/winserver2012-ps/grouppolicy/Set-GPLink.md deleted file mode 100644 index c78dcda232..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Set-GPLink.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/set-gplink?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-GPLink - -## SYNOPSIS -Sets the properties of the specified GPO link. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-GPLink [-Domain ] [-Enforced ] [-LinkEnabled ] [-Order ] - [-Server ] -Guid -Target [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-GPLink [-Name] [-Domain ] [-Enforced ] [-LinkEnabled ] - [-Order ] [-Server ] -Target [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The Set-GPLink cmdlet sets the properties of a GPO link. - -You can set the following properties: - -- Enabled. -If the GPO link is enabled, the settings of the GPO are applied when Group Policy is processed for the site, domain or OU. - -- Enforced. -If the GPO link is enforced, it cannot be blocked at a lower-level (in the Group Policy processing hierarchy) container. - -- Order. -The order specifies the precedence that the settings of the GPO take over conflicting settings in other GPOs that are linked (and enabled) to the same site, domain, or OU. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-GPLink -Name TestGPO -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes - -GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 -DisplayName : Test2GPO -Enabled : True -Enforced : False -Target : OU=MyOU,DC=contoso,DC=com -Order : 1 -``` - -Description - ------------ - -This command enables the link between the "TestGPO" GPO and the MyOU organizational unit in the contoso.com domain. -The Enforced and Order properties are not changed. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-GPLink -Name TestGPO -Domain north.contoso.com -Target "dc=south, dc=contoso, dc=com" -LinkEnabled Yes -Enforced Yes -Order 1 -``` - -Description - ------------ - -This command enables the link between the "TestGPO" GPO in the north.contoso.com domain and the south.contoso.com domain. -The link is set to enforced, so it cannot be blocked at lower-level containers (for example OUs in the south.contoso.com domain). -Because the order is set to 1, the settings of the "testGPO" GPO will be applied with the highest precedence (except for enforced links) when Group policy is processed for the south.contoso.com domain container. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>set-gplink -guid 77c5285d-952e-4559-94ef-a02f5c107799 -target "test-site" -enforced yes - -GpoId : 77c5285d-952e-4559-94ef-a02f5c107799 -DisplayName : TestGPO -Enabled : True -Enforced : True -Target : CN=test-site,cn=Sites,CN=Configuration,DC=contoso,DC=com -Order : 1 -``` - -Description - ------------ - -This command sets the enforced property of the link between the GPO that has ID 77c5285d-952e-4559-94ef-a02f5c107799 and the test site. -Inheritance cannot be blocked for this link at containers that are at lower-levels of the Group Policy hierarchy. - -## PARAMETERS - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Set-GPLink cmdlet: - -- The GPO that is linked from must exist in this domain. - -- The Active Directory container that is linked to must exist in a domain that has a trust relationship with this domain. - -Note: To specify a domain to link to, use the Target parameter. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enforced -Specifies whether the GPO link is enforced. -You can specify Yes or No. -By default, GPO links are not enforced. - -By setting the GPO link to enforced, you ensure the following: - -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. - -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. - -This option should be used sparingly. -Casual use of this option complicates troubleshooting. - -The following values are permitted for this object type. - -```yaml -Type: EnforceLink -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO of the link by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LinkEnabled -Specifies whether the GPO link is enabled. -You can specify Yes or No. - -By default, Group Policy processing is enabled for all GPO links. -You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. -Disabling a GPO link does not disable the GPO itself. -If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. - -The following values are permitted for this object type. - -```yaml -Type: EnableLink -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Enabled -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO of the link by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Specifies the link order for the GPO link. -You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. - -The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. -When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. -Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. -A lower number indicates higher precedence. - -By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). -Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Target -Specifies the LDAP distinguished name of the site, domain, or OU of the link. -For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.GpoLink -A GPO link between a GPO and a site, domain, or OU. - -## OUTPUTS - -### Microsoft.GroupPolicy.GpoLink -Set-GPLink returns the GPO link after the change has been applied. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[New-GPLink](./New-GPLink.md) - -[Remove-GPLink](./Remove-GPLink.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Set-GPPermission.md b/docset/winserver2012-ps/grouppolicy/Set-GPPermission.md deleted file mode 100644 index e9c9ed80fa..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Set-GPPermission.md +++ /dev/null @@ -1,367 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/set-gppermission?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-GPPermission - -## SYNOPSIS -Grants a level of permissions to a security principal for one GPO or all the GPOs in a domain. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-GPPermission [-DomainName ] [-Replace] [-Server ] -Guid - -PermissionLevel -TargetName -TargetType [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-GPPermission [-DomainName ] [-Replace] [-Server ] [-All] - -PermissionLevel -TargetName -TargetType [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-GPPermission [-Name] [-DomainName ] [-Replace] [-Server ] - -PermissionLevel -TargetName -TargetType [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -Grants a level of permissions to a security principal (user, security group, or computer) for one GPO or all the GPOs in a domain. -You use the TargetName and TargetType parameters to specify a user, security group, or computer for which to set the permission level. -You can use the Name or the Guid parameter to set the permission level for the security principal on a single GPO, or you can use the All parameter to set the permission level for the security principal on all GPOs in the domain. - -By default, if the security principal already has a higher permission level than the specified permission level, the change is not applied. -You can specify the Replace parameter, to remove the existing permission level from the GPO before the new permission level is set. -This ensures that the existing permission level is replaced by the new permission level. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group -PermissionLevel GpoRead -``` - -Description - ------------ - -This command sets the permission level for the "Domain Users" security group to GpoRead for the GPO named "TestGpo". -Because the Replace parameter is not specified, if the group already has a permission level higher than GpoRead, such as GpoEdit, no action is taken. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-GPPermission -All -TargetName "Marketing Admins" -TargetType Group -PermissionLevel GpoEdit -Replace -``` - -Description - ------------ - -This command sets the permission level for the "Marketing Admins" security group to GpoEdit on all GPOs in the domain. -This includes GPOs that are not linked to any site, domain, or OU. -Because the Replace parameter is specified, the new permission level overwrites the existing permissions set for the group. - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "Marketing Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_ | Set-GPPermission -Replace -PermissionLevel GpoApply -TargetName "Marketing Admins" -TargetType group }} - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 24f217d4-1403-4d43-9247-d17eeedb22f0 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/1/2009 10:51:34 PM -ModificationTime : 3/2/2009 12:53:40 AM -UserVersion : AD Version: 8, SysVol Version: 8 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : - - -DisplayName : TestGPO-1 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : fe2f7402-101b-4b3c-87e4-85d3f47735cb -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/1/2009 7:22:03 PM -ModificationTime : 3/2/2009 12:53:54 AM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 0, SysVol Version: 0 -WmiFilter : -``` - -Description - ------------ - -This command replaces the current permission level of the "Marketing Admins" security group with GpoApply for all GPOs on which the group has permissions. -The command returns each GPO for which the new permission level is set. - -First, Get-GPO is used to retrieve all the GPOs in the domain (Get-GPO -All). -Then, the collection is piped into the foreach-object command. -As each GPO is evaluated, it is piped into Get-GPPermissions. -If a permission level for the "Marketing Admins" group is returned, the GPO is piped into Set-gppermission to set the permission level for the group. -The Replace parameter is specified to make sure that the previous permission level is overwritten. - -Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. -This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. -Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed for GPOS on which the security principal does not have permissions. -For more information about the ErrorAction parameter, see about_CommonParameters. - -## PARAMETERS - -### -All -Specifies that the permission level is set for the specified security principal for all GPOs in the domain. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainName -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Set-GPPermission cmdlet, the GPO for which to get the permission level must exist in this domain. - -If you do not specify the DomainName parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Server parameter by its built-in alias, "domain". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: domain - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO for which to set the permission level by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: id - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO for which to set the permission level by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: displayname - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -PermissionLevel -Specifies the permission level to set for the security principal. -The valid permission levels are: GpoRead, GpoApply, GpoEdit, GpoEditDeleteModifySecurity or None. - -```yaml -Type: GPPermissionType -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Replace -Specifies that the existing permission level for the group or user is removed before the new permission level is set. -If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the Replace parameter, no change is made. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: dc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -The name of the security principal for which to set the permission level. -You can specify a user, a security group, or a computer. -You can use either the domain-qualified name of the security principal (domain\account) or just its name. - -For example, in the contoso.com domain, to specify: - -- The user "someuser", use "contoso\someuser" or "someuser". - -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". - -- The computer "computer-01", use "contoso\computer-01" or "computer-01". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetType -The type of security principal for which to set the permission level. -You must specify User, Group, or Computer. - -The following values are permitted for this object type. - -- Computer - -- User - -- Group - -```yaml -Type: PermissionTrusteeType -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo -An object that represents a GPO. -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Set-GPPermission returns an object that represents the GPO for which the permission level was set. - -## NOTES -* You can use the DomainName parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPPermission](./Get-GPPermission.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Set-GPPrefRegistryValue.md b/docset/winserver2012-ps/grouppolicy/Set-GPPrefRegistryValue.md deleted file mode 100644 index 3116717307..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Set-GPPrefRegistryValue.md +++ /dev/null @@ -1,515 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/set-gpprefregistryvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-GPPrefRegistryValue - -## SYNOPSIS -Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-GPPrefRegistryValue [-Disable] [-Domain ] [-Order ] [-Server ] - [-Type ] [-Value ] [-ValueName ] -Action - -Context -Guid -Key [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-GPPrefRegistryValue [-Name] [-Disable] [-Domain ] [-Order ] [-Server ] - [-Type ] [-Value ] [-ValueName ] -Action - -Context -Key [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. - -You can configure the Registry preference item for either a registry key or a registry value: - -- For a registry key, specify the Key parameter, but do not specify the ValueName, Type, or Value parameters. - -- For a registry value, specify the Key parameter together with the ValueName, Type, and Value parameters. -(All these parameters must be specified.) - -You must specify the Context parameter (User or Computer) to indicate whether to configure the Registry preference item in Computer Configuration or User Configuration. -You must also specify the Action parameter to set the action that should be applied on the client. -You can specify the GPO by its display name or its GUID. -You can specify the Disable parameter to create a Registry preference item that is disabled. - -Note: This cmdlet configures new Registry preference items. -It does not modify existing Registry preference items. - -This cmdlet can take input from the pipeline: - -- You can pipe GPO objects to this cmdlet to set a specified Registry preference item on one or more GPOs. - -- You can pipe PreferenceRegistrySetting objects to this cmdlet to set one or more Registry preference items on a specified GPO. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-GPPrefRegistryValue -Name TestGPO -Context User -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel" -ValueName ScreenSaveIsSecure -Value "1" -Type String -Action Update - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 35c12ab3-956c-45d5-973b-46b17d225f47 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/24/2009 4:41:03 PM -ModificationTime : 2/25/2009 12:16:28 PM -UserVersion : AD Version: 1, SysVol Version: 1 -ComputerVersion : AD Version: 34, SysVol Version: 34 -WmiFilter : -``` - -Description - ------------ - -This command configures a Registry preference item for the registry value "HKCU\Software\Policies\Microsoft\Windows\Control Panel\ ScreenSaveIsSecure" in User Configuration for the "TestGPO" GPO. -When the GPO is applied on a client, the registry value is updated with a data type of String (REG_SZ) and value data "1". - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-GPPrefRegistryValue -Name TestGPO -Context User -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -Value NewData -Type String -``` - -Description - ------------ - -This command configures a Registry preference item for the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" in User Configuration for the "TestGPO" GPO. -When the GPO is applied on a client, the registry value is created with a data type of String (REG_SZ) and value data "NewData". - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-GPPrefRegistryValue -Guid 35c12ab3-956c-45d5-973b-46b17d225f47 -Context computer -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" -``` - -Description - ------------ - -This command configures a Registry preference item for the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" in Computer Configuration in the GPO that has ID 35c12ab3-956c-45d5-973b-46b17d225f47. -When the GPO is applied on a client, the registry key is created. - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Remove-GPPrefRegistryValue -Name TestGPO -Context User -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne | Set-GPPrefRegistryValue -Context User -Action Create -Disable -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -Value SomeData -Type String -``` - -Description - ------------ - -This command creates a disabled Registry preference item for the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" in User Configuration in the "TestGPO" GPO. -First the Remove-GPPrefRegistryValue command removes any Registry preference items that configure the value from User Configuration. -Then, the GPO ("TestGPO") returned by the Remove-GPPrefRegistryValue is piped into Set-GPPrefRegistryValue to configure the disabled Registry preference item. -After this command completes, the disabled Registry preference item is the only Registry preference item associated with the registry value in User Configuration. - -If the "TestGPO" GPO does not initially have a Registry preference item configured for the specified registry value, a non-terminating error occurs. -You can suppress the error message by supplying the ErrorAction parameter to Remove-GPPrefRegistryValue and setting its value to SilentlyContinue (-ErrorAction SilentlyContinue). -For more information about the ErrorAction parameter, see about_commonparameters. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -ErrorAction SilentlyContinue | Set-GPPrefRegistryValue -Context User -Action Update -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -Value SomeData -Type String -``` - -Description - ------------ - -This command configures a Registry preference item to update the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" for every GPO in the domain that previously had a Registry preference item configured for that value in User Configuration. - -First the Get-GPO cmdlet is invoked with the All parameter to get all the GPOs in the domain. -These GPOs are piped into the Remove-GPPrefRegistryValue cmdlet. -If the GPO contains any Registry preference items configured for the specified key, they are removed. -Remove-GPPrefRegistryValue only outputs a GPO to the pipeline if it removes a Registry preference item from a GPO. -Finally, these GPOs are piped to the Set-GPPrefRegistryValue to configure the Registry preference item to update the registry value. - -If a GPO passed to Remove-GPPrefRegistryValue does not have a Registry preference item configured for the specified value, an non-terminating error occurs. -The ErrorAction parameter is set to SilentlyContinue (-ErrorAction SilentlyContinue) to suppress the error message. -For more information about the ErrorAction parameter, see about_commonparameters. - -### -------------------------- EXAMPLE 6 -------------------------- -``` -C:\PS>get-gpprefregistryvalue -name testgpo -context user -key hklm\software\microsoft\examplekey | set-gpprefregistryvalue -name testgpo-1 -context computer -order 1 -erroraction silentlycontinue - -DisplayName : TestGPO-1 -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : ef4d0f7e-1a1a-4fd1-b735-0bc6620e7f51 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/1/2009 11:14:06 AM -ModificationTime : 3/1/2009 11:15:16 AM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : - - -DisplayName : TestGPO-1 -DomainName : contoso.microsoft.com -Owner : CONTOSO\Domain Admins -Id : ef4d0f7e-1a1a-4fd1-b735-0bc6620e7f51 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 3/1/2009 11:14:06 AM -ModificationTime : 3/1/2009 11:15:16 AM -UserVersion : AD Version: 0, SysVol Version: 0 -ComputerVersion : AD Version: 2, SysVol Version: 2 -WmiFilter : -``` - -Description - ------------ - -This command copies all Registry preference items that configure (first-level) values under the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" from User Configuration in a source GPO (TestGPO) to Computer Configuration in destination GPO (TestGPO-1). -A copy of the destination GPO (TestGPO-1) is returned for each Registration preference item set (in this example, 2). - -The Get-GPPrefRegistryValue command gets all the Registry preference items that configure values under User Configuration in the source GPO. -This command also returns all first level subkeys that have values configured (though not the Registry preference items for the values themselves). -These Registry preference items (and the subkeys) are then piped into the Set-GPPrefRegistryValue command. - -The Set-GPPrefRegistryValue command configures the Registry preference items for the registry values in the destination GPO. - -- The subkeys returned by Get-GPPrefRegistryValue do not have an Action property, and so a non-terminating error occurs for each subkey. -The ErrorAction parameter is specified (-ErrorAction SilentlyContinue) to suppress these error messages. -For more information about the ErrorAction parameter, see about_commonparameters. - -- It is a good practice to specify an order of one (-Order 1) in Set-GPPrefRegistryValue when it accepts input from the pipeline. -This is because Registry preference items passed on the pipeline have an Order property. -If the Order property of a Registry preference item passed on the pipeline is greater than the number of Registry preference items currently configured in the destination GPO, an out of range error occurs and the Registry preference item is not configured in the destination GPO. -By specifying the order as one in the Set-GPPrefRegistryValue command, you override the Order property of the source Registry preference item, and prevent such errors from occurring. - -## PARAMETERS - -### -Action -Specifies the action for the Registry preference item. -You must specify one of the following actions: Create, Update, Replace, or Delete. - -The action specifies how the Registry preference item is applied to the registry key or registry value on the client when Group Policy is processed. - -The following values are permitted for this object type. - -```yaml -Type: PreferenceAction -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Context -Specifies whether the Registry preference item is configured under User Configuration or Computer Configuration in the GPO. -You must specify either User or Computer. - -The following values are permitted for this object type. - -```yaml -Type: GpoConfiguration -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -If specified, the Registry preference item is configured as disabled. -A disabled Registry preference item is not applied when Group Policy is processed on the client, and, therefore, does not modify any existing registry keys or values on the client. - -This parameter does not disable an existing Registry preference item in the GPO, rather, it creates a new Registry preference item that is disabled. -(Any existing Registry preference items that configure the same key or value will still be applied when the GPO is processed on a client.) This behavior is different than disabling an existing Registry preference item using the GPMC. - -You can use the Remove-GPPrefRegistryValue cmdlet to remove any existing Registry preference items associated with the specified key or value from the appropriate configuration (User or Computer) in the GPO before you create the new disabled Registry preference item. -This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item associated with the key or value in the specified configuration in the GPO. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Set-GPPrefRegistryValue cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Current Domain -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO in which to configure the Registry preference item by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies the registry key for the Registry preference item; for example: HKEY_CURRENT_USER\Control Panel\Colors. - -You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). -Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. - -You can configure a preference registry setting for a registry key or a registry value. - -- To configure a setting for a registry key, specify the Key parameter without the ValueName, Value, or Type parameters. - -- To configure a setting for a registry value, specify the Key parameter together with the ValueName, Value, and Type parameters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO in which to configure the Registry preference item by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Order -Specifies the order in which the Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. -If two Registry preference items in the GPO change the same registry value, the one that has the highest order is the last to modify the value on the client. - -By default, if the Order parameter is not specified, the order is set to one plus the current number of Registry preference items in the GPO. -You can specify any value greater than zero. -If you specify a value larger than the default value, the order is set to the default. - -The order of a setting can change as Registry preference items are added or removed from the GPO. -For example, if the GPO has five Registry preference items, and you add another one and specify an order of 4, the Registry preference items that previously were at order 4 and 5, are at order 5 and 6 after the change. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the data type of the registry value for the Registry preference item. -You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, ExpandString, and Qword. -For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. - -When you configure a Registry preference item for a registry key, do not specify this parameter. -When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Value parameters. - -The following values are permitted for this object type. - -```yaml -Type: RegistryValueKind -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value data of the registry value for the Registry preference item. -For example, the registry value "HKEY_CURRENT_USER\Control Panel\Colors ActiveTitle" can have the following (value) data: 10 36 106. - -When you configure a Registry preference item for a registry key, do not specify this parameter. -When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Type parameters. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValueName -Specifies the value name of the registry value for the Registry preference item. -For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. -For the default value of a registry key, specify either "(default)" or an empty string (""). - -When you configure a Registry preference item for a registry key, do not specify this parameter. -When you configure a Registry preference item for a registry value, specify this parameter together with the Key, Value, and Type parameters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PreferenceRegistrySetting -A GPO (in which to configure a specified preference registry setting), or a PreferenceRegistrySetting object (to configure in a specified GPO). -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Set-GPPrefRegistryValue returns the GPO in which the Registry preference item was configured. - -## NOTES -* You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPPrefRegistryValue](./Get-GPPrefRegistryValue.md) - -[Remove-GPPrefRegistryValue](./Remove-GPPrefRegistryValue.md) - diff --git a/docset/winserver2012-ps/grouppolicy/Set-GPRegistryValue.md b/docset/winserver2012-ps/grouppolicy/Set-GPRegistryValue.md deleted file mode 100644 index dedf20fb5a..0000000000 --- a/docset/winserver2012-ps/grouppolicy/Set-GPRegistryValue.md +++ /dev/null @@ -1,439 +0,0 @@ ---- -external help file: GPv2_Cmdlets.xml -Module Name: GroupPolicy -online version: https://learn.microsoft.com/powershell/module/grouppolicy/set-gpregistryvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-GPRegistryValue - -## SYNOPSIS -Configures one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-GPRegistryValue [-Additive] [-Disable] [-Domain ] [-Server ] [-Type ] - [-Value ] [-ValueName ] [-ValuePrefix ] -Guid -Key -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-GPRegistryValue [-Name] [-Additive] [-Disable] [-Domain ] [-Server ] - [-Type ] [-Value ] [-ValueName ] [-ValuePrefix ] -Key -``` - -## DESCRIPTION -The Set-GPRegistryValue cmdlet configures a registry-based policy setting under either Computer Configuration or User Configuration in a GPO. -The policy setting configures keys or values in the registry on the client computer when the GPO is applied. - -You can specify the GPO by name or by its GUID, or you can pipe a GPO object to the cmdlet. -You can also pipe a PolicyRegistrySetting object (for example, one returned by Get-GPRegistryValue) to the cmdlet. - -You can configure registry-based policy settings for: - -- One or more registry values by passing the Key, ValueName, Value, and Type parameters. -For multiple registry values, pass a comma-separated list for both the ValueName and Value parameters. -When you specify multiple registry values, only the String and ExpandString data types are supported. - -- A list of one or more registry values that share the same name prefix by passing the Key and Type parameters, and a single value or a comma-separated list for the Value parameter. -You can optionally specify the value name prefix by using the ValuePrefix parameter. -Only the String and ExpandString data types are supported for lists. - -You can use the Additive parameter to ensure that existing registry values for the key are not overwritten by the new policy setting when the GPO is applied. - -You can also delete registry values on a client when the GPO is applied by disabling a policy setting with the Disable parameter. -You can disable: - -- All the registry values under a specified registry key by passing the Key parameter. -No subkeys (or their values) will be deleted on the client. - -- A single registry value by passing the Key parameter and the ValueName parameter. - -- Multiple registry values by passing the Key parameter and a comma-separated list for the ValueName parameter. - -## EXAMPLES - -### -------------------------- EXAMPLE 1 -------------------------- -``` -C:\PS>Set-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName ScreenSaveTimeOut -Type DWORD -value 900 - -DisplayName : TestGPO -DomainName : contoso.com -Owner : CONTOSO\Domain Admins -Id : 35c12ab3-956c-45d5-973b-46b17d225f47 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/24/2009 4:41:03 PM -ModificationTime : 2/25/2009 12:42:00 PM -UserVersion : AD Version: 3, SysVol Version: 3 -ComputerVersion : AD Version: 34, SysVol Version: 34 -WmiFilter : -``` - -Description - ------------ - -This command configures a registry-based policy setting for the registry value "HKCU\Software\Policies\Microsoft\Windows\Control ScreenSaverTimeOut" with a value of 900 and a data type of DWord. -This policy setting sets the Screen Saver timeout to 900 seconds (15 minutes) when Group Policy is applied on the client. - -### -------------------------- EXAMPLE 2 -------------------------- -``` -C:\PS>Set-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" -Type String -Value "String 1", "String 2", "String 3" -``` - -Description - ------------ - -This command configures registry-based policy settings to set three registry values. -The policy settings are configured in the User Configuration section of the GPO. -When the GPO is applied on the client, the following registry values are set: - -"HKCU\Software\Policies\Microsoft\ExampleKey ValueOne" "String 1" - -"HKCU\Software\Policies\Microsoft\ExampleKey ValueTwo" "String 2" - -"HKCU\Software\Policies\Microsoft\ExampleKey ValueThree" "String 3" - -### -------------------------- EXAMPLE 3 -------------------------- -``` -C:\PS>Set-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValuePrefix "MyValue" -Type String -Value "String 1", "String 2", "String 3" -``` - -Description - ------------ - -This command configures a registry-based policy setting to set a list of three registry values. -The policy settings are configured in the Computer Configuration section of the GPO. -Because the Additive parameter is not specified, when the GPO is applied on the client any list values under the key are deleted -- then, the following registry values are set: - -"HKCU\Software\Policies\Microsoft\ExampleKey MyValue1" "String 1" - -"HKCU\Software\Policies\Microsoft\ExampleKey MyValue2" "String 2" - -"HKCU\Software\Policies\Microsoft\ExampleKey MyValue3" "String 3" - -If you specify the Additive parameter, the list values are added to the existing list values on the client when the GPO is applied. -(Note: the actual value names assigned to the list values will depend on the number of existing list values on the client.) - -### -------------------------- EXAMPLE 4 -------------------------- -``` -C:\PS>Set-GPRegistryValue -Disable -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" -``` - -Description - ------------ - -This command disables the registry-based policy settings (in the User Configuration section) for the specified registry values. -When the GPO is applied on the client, the registry values are deleted from the registry on the client. - -### -------------------------- EXAMPLE 5 -------------------------- -``` -C:\PS>Set-GPRegistryValue -Disable -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -``` - -Description - ------------ - -This command disables the registry-based policy setting (in the User Configuration section) for the specified registry key. -When the GPO is applied on the client, all first level values will be deleted from the registry key. -Subkeys and their values will not be modified. - -## PARAMETERS - -### -Additive -Specifies that registry values should be appended to existing values under the key when the GPO is applied on a client. - -By default, when Group Policy is processed on a client, existing values under a registry key are deleted before any new values are written to the registry. -By using the Additive parameter for a registry-based policy setting, you can specify that the new value should be added to the registry key without deleting the existing values. - -You cannot specify the Disable parameter with this parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disable -Specifies that the registry-based policy setting should be disabled. - -You can disable a policy setting for a registry key or value: - -- For a registry key, specify the Key parameter without the ValueName parameter. -When the GPO is applied on the client, all of the values directly under the key are removed from the registry. -The key itself is not removed from the registry, nor are any of its subkeys (or their values) removed. - -- For a registry value, specify the Key parameter together with the ValueName parameter. -When the GPO is applied on the client, only the specified value is removed from the registry. - -To remove a policy setting from a GPO without affecting existing registry keys or values on a client when Group Policy is processed, use the Remove-GPRegistryValue cmdlet. - -You cannot specify the Additive, Type, Value, or ValuePrefix parameters with the Disable parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the domain for this cmdlet. -You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). - -For the Set-GPRegistryValue cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. - -If you do not specify the Domain parameter, the domain of the user that is running the current session is used. -(If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help. - -If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer). - -You can also refer to the Domain parameter by its built-in alias, "domainname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Current Domain -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Guid -Specifies the GPO in which to configure the registry-based policy setting by its globally unique identifier (GUID). -The GUID uniquely identifies the GPO. - -You can also refer to the Guid parameter by its built-in alias, "id". -For more information, see about_Aliases. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Key -Specifies the registry key for the registry-based policy setting; for example, "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". - -The key must be in one of the two following registry hives: - -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. - -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. - -You can also refer to the Key parameter by its built-in alias, "FullKeyPath". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the GPO in which to configure the registry-based policy setting by its display name. - -The display name is not guaranteed to be unique in the domain. -If another GPO with the same display name exists in the domain, an error occurs. -You can use the Guid parameter to uniquely identify a GPO. - -You can also refer to the Name parameter by its built-in alias, "displayname". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Server -Specifies the name of the domain controller that this cmdlet contacts to complete the operation. -You can specify either the fully qualified domain name (FQDN) or the host name. -For example: - -FQDN: DomainController1.sales.contoso.com - -Host Name: DomainController1 - -If you do not specify the name by using the Server parameter, the PDC emulator is contacted. - -You can also refer to the Server parameter by its built-in alias, "dc". -For more information, see about_Aliases. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the data type for the registry-based policy setting. -You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, or Qword. -For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. - -Only the following data types are supported for list values: String and ExpandString. - -You must specify this parameter when you configure a policy setting to set a registry value. -You cannot specify this parameter with the Disable parameter. - -The following values are permitted for this object type. - -```yaml -Type: RegistryValueKind -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Value -Specifies the value data for the registry-based policy setting. -You can specify a single value or an array of values. -Use a comma-separated list to specify more than one value. -Only the String and ExpandString data types are supported for an array of values. - -At a minimum, you must specify this parameter together with the Type and Key parameters to configure a policy setting to set a registry value. -You cannot specify this parameter with the Disable parameter. - -```yaml -Type: PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValueName -Specifies a value name or an array of value names for the registry-based policy setting. -For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a registry value with the following value name: UseDomainNameDevolution. -Use a comma-separated list to specify more than one value name. -Only the String and ExpandString data types are supported for an array of values. - -You cannot specify this parameter with the ValuePrefix parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ValuePrefix -Specifies a value name prefix for a registry-based policy setting for a list of registry values. -For example, the following command: - -Set-GPRegistryValue -Key "HKLM\SOFTWARE\Policies\ExampleKey" -ValuePrefix "ExValue" -Type String - Value 100,200,300 - -Configures a policy setting that creates the following registry values when Group Policy is applied on the client: - -"HKLM\SOFTWARE\Policies\ExampleKey ExValue1" 100 - -"HKLM\SOFTWARE\Policies\ExampleKey ExValue2" 200 - -"HKLM\SOFTWARE\Policies\ExampleKey ExValue3" 300 - -Only the String and ExpandString data types are supported with the ValuePrefix parameter. - -You cannot specify this parameter with the ValueName parameter or the Disable parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.GroupPolicy.Gpo or Microsoft.GroupPolicy.PolicyRegistrySetting -A GPO (in which to configure a registry-based policy setting), or a PolicyRegistrySetting object that represents a registry-based policy setting (to configure in a specified GPO). -Collections that contain GPOs from different domains are not supported. - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo -Set-GPRegistryValue returns the GPO in which the registry-based policy setting has been configured. - -## NOTES -* The hive of the registry key that you specify, HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU), determines whether the registry-based policy setting is in Computer Configuration or User Configuration. - - You can use the Domain parameter to explicitly specify the domain for this cmdlet. - - If you do not explicitly specify the domain, the cmdlet uses a default domain. -The default domain is the domain that is used to access network resources by the security context under which the current session is running. -This domain is typically the domain of the user that is running the session. -For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. -However, computer startup and shutdown scripts run under the context of the LocalSystem account. -The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. -Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined. - -## RELATED LINKS - -[Get-GPRegistryValue](./Get-GPRegistryValue.md) - -[Remove-GPRegistryValue](./Remove-GPRegistryValue.md) - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMDvdDrive.md b/docset/winserver2012-ps/hyper-v/Add-VMDvdDrive.md deleted file mode 100644 index 1e324ca3f3..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMDvdDrive.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmdvddrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMDvdDrive - -## SYNOPSIS -Adds a DVD drive to a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMDvdDrive [-VMName] [[-ControllerNumber] ] [[-ControllerLocation] ] - [[-Path] ] [-AllowUnverifiedPaths] [-ComputerName ] [-Passthru] [-ResourcePoolName ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMDvdDrive [-VM] [[-ControllerNumber] ] [[-ControllerLocation] ] - [[-Path] ] [-AllowUnverifiedPaths] [-Passthru] [-ResourcePoolName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-VMDvdDrive [-VMDriveController] [[-ControllerLocation] ] [[-Path] ] - [-AllowUnverifiedPaths] [-Passthru] [-ResourcePoolName ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMDvdDrive** cmdlet adds a DVD drive to a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMDvdDrive -VMName Test -Path D:\ISOs\disc1.iso -``` - -This example adds a virtual DVD drive using file D:\ISOs\disc1.iso to virtual machine Test. - -### Example 2 -``` -PS C:\>Get-VM Test | Add-VMDvdDrive -ControllerNumber 1 -``` - -This example adds a virtual DVD drive using controller number 1 to virtual machine Test. - -### Example 3 -``` -PS C:\>Get-VMIdeController -VMName Test | Add-VMDvdDrive -Path E:\ -``` - -This example adds virtual DVD drives using the IDE controllers from virtual machine Test. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-v hosts on which the DVD drive is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller at which the DVD drive is to be added. -If not specified, the number of the first available location on the controller is used. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller to which the DVD drive is to be added. -If not specified, the first IDE controller on which the specified **ControllerLocation** is available is used. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Passes the added **Microsoft.Virtualization.Powershell.DvdDrive** through to the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the full path to the virtual hard disk file or physical hard disk volume for the added DVD drive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the friendly name of the ISO resource pool to which this DVD drive is to be associated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to which the DVD drive is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMDriveController -Specifies the drive controller to which the DVD drive is to be added. - -```yaml -Type: VMDriveController[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to which the DVD drive is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowUnverifiedPaths -Specifies that no error is to be thrown if the specified path is not verified as accessible by the cluster. -This parameter is applicable to clustered virtual machines. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VMDriveController[] - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.DvdDrive - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMFibreChannelHba.md b/docset/winserver2012-ps/hyper-v/Add-VMFibreChannelHba.md deleted file mode 100644 index 75372dcba3..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMFibreChannelHba.md +++ /dev/null @@ -1,257 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmfibrechannelhba?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMFibreChannelHba - -## SYNOPSIS -Adds a virtual Fibre Channel host bus adapter to a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMFibreChannelHba [-VMName] [-SanName] [-ComputerName ] [-GenerateWwn] - [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMFibreChannelHba [-VMName] [-SanName] [-ComputerName ] [-Passthru] - -WorldWideNodeNameSetA -WorldWideNodeNameSetB -WorldWidePortNameSetA - -WorldWidePortNameSetB [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-VMFibreChannelHba [-VM] [-SanName] [-GenerateWwn] [-Passthru] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-VMFibreChannelHba [-VM] [-SanName] [-Passthru] -WorldWideNodeNameSetA - -WorldWideNodeNameSetB -WorldWidePortNameSetA -WorldWidePortNameSetB [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMFibreChannelHba** cmdlet adds a virtual Fibre Channel host bus adapter to a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMFibreChannelHba -VMName MyVM -SanName Production -``` - -This example adds the virtual Fibre Channel host bus adapter associated with virtual storage area network Production to a virtual machine named MyVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual Fibre Channel host bus adapter is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object representing the virtual machine to which the virtual Fibre Channel host bus adapter being added is to be passed through to the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SanName -Specifies the virtual storage area network (SAN) name to associate with this virtual Fibre Channel host bus adapter. -Use the Get-VMSan cmdlet to get a list of all virtual SANs on the host. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to which the virtual Fibre Channel host bus adapter is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to which the virtual Fibre Channel host bus adapter is to be added. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorldWideNodeNameSetA -Specifies the world wide node name of address A associated with the Fibre Channel host bus adapter to be added. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: Wwnn1 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeNameSetB -Specifies the world wide node name of address B associated with the Fibre Channel host bus adapter to be added. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: Wwnn2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortNameSetA -Specifies the world wide port name of address A associated with the Fibre Channel host bus adapter to be added. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: Wwpn1 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortNameSetB -Specifies the world wide port name of address B associated with the Fibre Channel host bus adapter to be added. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: Wwpn2 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateWwn -Specifies that the world wide names for the Fibre Channel host bus adapter are to be generated automatically. -When specified, the **WorldWideNodeNameSetA**, **WorldWideNodeNameSetB**, **WorldWidePortNameSetA**, and **WorldWidePortNameSetB** parameters cannot be used. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMHardDiskDrive.md b/docset/winserver2012-ps/hyper-v/Add-VMHardDiskDrive.md deleted file mode 100644 index 4865a0213e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMHardDiskDrive.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmharddiskdrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMHardDiskDrive - -## SYNOPSIS -Adds a hard disk drive to a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMHardDiskDrive [-VMName] [[-ControllerType] ] [[-ControllerNumber] ] - [[-ControllerLocation] ] [[-Path] ] [-AllowUnverifiedPaths] [-ComputerName ] - [-DiskNumber ] [-Passthru] [-ResourcePoolName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMHardDiskDrive [-VM] [[-ControllerType] ] [[-ControllerNumber] ] - [[-ControllerLocation] ] [[-Path] ] [-AllowUnverifiedPaths] [-ComputerName ] - [-DiskNumber ] [-Passthru] [-ResourcePoolName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-VMHardDiskDrive [-VMDriveController] [[-ControllerLocation] ] [[-Path] ] - [-AllowUnverifiedPaths] [-ComputerName ] [-DiskNumber ] [-Passthru] - [-ResourcePoolName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-VMHardDiskDrive [[-ControllerLocation] ] [[-Path] ] [-AllowUnverifiedPaths] - [-ComputerName ] [-DiskNumber ] [-Passthru] [-ResourcePoolName ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMHardDiskDrive** cmdlet adds a hard disk drive to a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMHardDiskDrive -VMName Test -Path D:\VHDs\disk1.vhdx -``` - -Creates a virtual hard disk using file D:\VHDs\disk1.vhdx on virtual machine Test. - -### Example 2 -``` -PS C:\>Get-VM Test | Add-VMHardDiskDrive -ControllerType SCSI -ControllerNumber 0 -``` - -Adds a virtual hard disk to SCSI controller number 0 on virtual machine Test. - -### Example 3 -``` -PS C:\>Get-VMScsiController -VMName Test -ControllerNumber 0 | Add-VMHardDiskDrive -DiskNumber 2 -``` - -This example gets a SCSI controller on a virtual machine named Test and then adds physical disk 2 to that controller. - -### Example 4 -``` -PS C:\>Get-Disk 2 | Add-VMHardDiskDrive -VMName Test -``` - -This example gets physical disk 2 and then adds it to a virtual machine named Test. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts on which the hard disk drive is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: PSComputerName - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller at which the hard disk drive is to be added. -If not specified, the first available location in the controller specified with the **ControllerNumber** parameter is used. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller to which the hard disk drive is to be added. -If not specified, this parameter assumes the value of the first available controller at the location specified in the **ControllerLocation** parameter. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerType -Specifies the type of the controller to which the hard disk drive is to be added. -If not specified, **IDE** is attempted first. -If the IDE controller port at the specified number and location is already connected to a drive, then it will try to create one on the SCSI controller specified by **ControllerNumber**. -Allowed values are **IDE** and **SCSI**. - -```yaml -Type: ControllerType -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Passes the added **Microsoft.Virtualization.Powershell.HardDiskDrive** object through to the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the full path of the hard disk drive file to be added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the friendly name of the ISO resource pool to which this virtual hard disk is to be associated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to which the hard disk drive is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMDriveController -Specifies the controller to which the hard disk drive is to be added. - -```yaml -Type: VMDriveController -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to which the hard disk drive is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowUnverifiedPaths -Specifies that no error is to be thrown if the specified path is not verified as accessible by the cluster. -This parameter is applicable to clustered virtual machines. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskNumber -Specifies the disk number of the offline physical hard drive to be connected as a passthrough disk. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: Number - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.Powershell.DriveController[] - -### Microsoft.HyperV.Powershell.VirtualMachine[] - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.HardDiskDrive -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/hyper-v/Add-VMMigrationNetwork.md b/docset/winserver2012-ps/hyper-v/Add-VMMigrationNetwork.md deleted file mode 100644 index be625cb2b4..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMMigrationNetwork.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmmigrationnetwork?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMMigrationNetwork - -## SYNOPSIS -Adds a network for virtual machine migration on one or more virtual machine hosts. - -## SYNTAX - -``` -Add-VMMigrationNetwork [-Subnet] [[-Priority] ] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMMigrationNetwork** cmdlet adds a network for virtual machine migration on one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMMigrationNetwork 192.168.0.1 -``` - -This example adds an IPv4 address as a live migration network on the local Hyper-V host. - -### Example 2 -``` -PS C:\>Add-VMMigrationNetwork 192.168.10.0/24 -``` - -This example adds an IPv4 address range as possible live migration networks on the local Hyper-V host by using a subnet mask. - -### Example 3 -``` -PS C:\>Add-VMMigrationNetwork 2001:836c:6456:1c99::/32 -``` - -This example adds an IPv6 address range as possible live migration networks on the local Hyper-V host by adding a subnet mask. - -### Example 4 -``` -PS C:\>Add-VMMigrationNetwork 2001:836c:6456:1c99::/64 -Priority 8 -``` - -This example adds an IPv6 address range as possible live migration networks on the local Hyper-V host by using a subnet mask and specifying the network as lower priority. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the network is to be added for virtual machine migration. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an **Microsoft.Virtualization.Powershell.MigrationNetwork** object is to be passed through to the pipeline representing the network added for virtual machine migration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of the network to be added for virtual machine migration. -Multiple networks can have the same priority. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a string representing an IPv4 or IPv6 subnet mask which identifies the network to be added for virtual machine migration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.MigrationNetwork -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Add-VMNetworkAdapter.md deleted file mode 100644 index 13d5db71be..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMNetworkAdapter.md +++ /dev/null @@ -1,285 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMNetworkAdapter - -## SYNOPSIS -Adds a virtual network adapter to a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMNetworkAdapter [-VMName] [-ComputerName ] [-DynamicMacAddress] [-IsLegacy ] - [-Name ] [-Passthru] [-ResourcePoolName ] [-StaticMacAddress ] [-SwitchName ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMNetworkAdapter [-ComputerName ] [-DynamicMacAddress] [-ManagementOS] [-Name ] - [-Passthru] [-StaticMacAddress ] [-SwitchName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-VMNetworkAdapter [-VM] [-DynamicMacAddress] [-IsLegacy ] [-Name ] - [-Passthru] [-ResourcePoolName ] [-StaticMacAddress ] [-SwitchName ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMNetworkAdapter** cmdlet adds a virtual network adapter to a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMNetworkAdapter -VMName Redmond -Name "Redmond NIC1" -``` - -This example adds a virtual network adapter named Redmond NIC1 to a virtual machine named Redmond. - -### Example 2 -``` -PS C:\>Add-VMNetworkAdapter -VMName Test -SwitchName Network -``` - -This example adds a virtual network adapter to a virtual machine named Test and connects it to a virtual switch named Network. - -### Example 3 -``` -PS C:\>Get-VM Test | Add-VMNetworkAdapter -IsLegacy $true -Name Bootable -``` - -This example uses two cmdlets and the pipeline in one command to perform the operation. - -### Example 4 -``` -PS C:\>Add-VMNetworkAdapter -ManagementOS -Name Secondary -``` - -This example adds a second virtual network adapter in the management operating system. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual network adapter is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicMacAddress -Assigns a dynamically generated MAC address to the new virtual network adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsLegacy -Specifies whether the virtual network adapter is the legacy type. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies the management operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies a name for the new virtual network adapter. -The default value is "Network Adapter." - -```yaml -Type: String -Parameter Sets: (All) -Aliases: VMNetworkAdapterName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to be pipeline representing the network adapter to be added. -If you specify **-ManagementOS**, the object passed is a **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter**; otherwise the object passed is a **Microsoft.Virtualization.Powershell.VMNetworkAdapter**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the friendly name of a resource pool. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticMacAddress -Assigns a specific MAC address to the new virtual network adapter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch to connect to the new network adapter. -If the switch name is not unique, then the operation fails. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the network adapter is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the network adapter is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### -None by default; if **PassThru** is specified, then either a **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** if **ManagementOS** is specified, or a **Microsoft.Virtualization.Powershell.VMNetworkAdapter** if it is not. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMNetworkAdapterAcl.md b/docset/winserver2012-ps/hyper-v/Add-VMNetworkAdapterAcl.md deleted file mode 100644 index 23bd7ea45e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMNetworkAdapterAcl.md +++ /dev/null @@ -1,347 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmnetworkadapteracl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMNetworkAdapterAcl - -## SYNOPSIS -Creates an ACL to apply to the traffic through a virtual machine network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMNetworkAdapterAcl [-VMName] [-ComputerName ] [-LocalIPAddress ] - [-LocalMacAddress ] [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] - [-VMNetworkAdapterName ] -Action -Direction - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMNetworkAdapterAcl [-ComputerName ] [-LocalIPAddress ] [-LocalMacAddress ] - [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] [-VMNetworkAdapterName ] - -Action -Direction [-ManagementOS] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-VMNetworkAdapterAcl [-VM] [-LocalIPAddress ] [-LocalMacAddress ] - [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] [-VMNetworkAdapterName ] - -Action -Direction [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-VMNetworkAdapterAcl [-VMNetworkAdapter] [-LocalIPAddress ] - [-LocalMacAddress ] [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] - -Action -Direction [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMNetworkAdapterAcl** cmdlet creates an ACL to apply to the traffic through a virtual machine network adapter. -When a virtual network adapter is created there is no ACL on it. -Given a list of IP-based ACL entries to be applied to traffic in the same direction, the longest match rule decides which one of the entries is most appropriate to apply to a specific packet. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMNetworkAdapterAcl -VMName Redmond -RemoteIPAddress 10.0.0.0/8 -Direction Both -Action Allow -``` - -This example adds an ACL to allow virtual machine Redmond to send to and receive from traffic on IP subnet 10.0.0.8/8. - -### Example 2 -``` -PS C:\>Add-VMNetworkAdapterAcl -VMName Redmond -RemoteIPAddress ANY -Direction Both -Action Deny -``` - -This example adds an ACL to deny virtual machine Redmond to send either IPv4 or IPv6 traffic to anywhere and receive such traffic from anywhere. - -### Example 3 -``` -PS C:\>Get-VM Redmond | Add-VMNetworkAdapterAcl -RemoteMacAddress 03-0f-01-0e-aa-b2 -Direction Both -Action Deny -``` - -This example gets virtual machine Redmond and adds an ACL to deny it to send any traffic to a device with MAC address 03-0f-01-0e-aa-b2 or to receive any traffic from that device. - -### Example 4 -``` -PS C:\>Get-VMNetworkAdapter -VMName Redmond | Add-VMNetworkAdapterAcl -RemoteIPAddress 192.168.0.0/16 -Direction Outbound -Action Meter -``` - -This example gets virtual network adapters from virtual machine Redmond and adds an ACL to meter outgoing traffic sent to IP subnet 192.168.0.0/16. - -## PARAMETERS - -### -Action -Specifies the action for the ACL. -Allowed values are **Allow**, **Deny**, and **Meter**. -A metering ACL must be IP-based, i.e. -either -RemoteIPAddress or -LocalIPAddress must be specified. - -```yaml -Type: VMNetworkAdapterAclAction -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the ACL is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -Specifies the direction of the network traffic to which the ACL is to apply. -Allowed values are **Inbound**, **Outbound**, or **Both**. -. If **Both** is specified, the new ACL entry is added to both the inbound direction and the outbound direction. -In the output of Get-VMNetworkAdapterAcl, the ACL entry appears in both the inbound ACL list and the outbound ACL list. - -```yaml -Type: VMNetworkAdapterAclDirection -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalIPAddress -Specifies the local IP address to which the ACL is to apply. -For an inbound packet, this is the destination IP address in the packet header; for an outbound packet, this is the source IP address in the packet header. -It can be either IPv4 or IPv6 address. -It can be either a host address or a subnet address, e.g. -1.2.3.4, 2001::2008, 192.168.1.0/24, or f001:f002:f003:f004::1/64. -The IP address can also be a wildcard, 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all IPv4 and IPv6 addresses. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalMacAddress -Specifies the local MAC address to which the ACL is to apply. -For an inbound packet, this is the destination MAC address in the packet header; for an outbound packet, this is the source MAC address in the packet header. -It can be a host MAC address, e.g. -00-ab-00-11-22-33, or a wildcard, ANY, for all MAC addresses. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the ACL is to be applied in the management (i.e. -the parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the ACL to be added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteIPAddress -Specifies the remote IP address to which this ACL is to apply. -For an inbound packet, this is the source IP address in the packet header; for an outbound packet, this is the destination IP address in the packet header. -It can be either IPv4 or IPv6 address. -It can be either a host address or a subnet address, e.g. -1.2.3.4, 2001::2008, 192.168.1.0/24, or f001:f002:f003:f004::1/64.the IP address can also be a wildcard, 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all IPv4 and IPv6 addresses. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteMacAddress -Specifies the remote MAC address to which this ACL is to apply. -For an inbound packet, this is the source MAC address in the packet header; for an outbound packet, this is the destination MAC address in the packet header. -It can be a host MAC address, e.g. -00-ab-00-11-22-33, or a wildcard, ANY, for all MAC addresses. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the ACL is to apply. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the ACL is to apply. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter to which the ACL is to apply. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual machine network adapter to which the ACL is to apply. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMNetworkAdapterAclSetting -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMRemoteFx3dVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Add-VMRemoteFx3dVideoAdapter.md deleted file mode 100644 index 7ad45a2ab7..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMRemoteFx3dVideoAdapter.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmremotefx3dvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMRemoteFx3dVideoAdapter - -## SYNOPSIS -Adds a RemoteFX video adapter in a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMRemoteFx3dVideoAdapter [-VMName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMRemoteFx3dVideoAdapter [-VM] [-Passthru] -``` - -## DESCRIPTION -The **Add-VMRemoteFx3dVideoAdapter** cmdlet adds a RemoteFX video adapter in a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMRemoteFx3dVideoAdapter -VMName Test -``` - -Adds a RemoteFX video adapter to virtual machine Test. - -### Example 2 -``` -PS C:\>Get-VM Test | Add-VMRemoteFx3dVideoAdapter -``` - -Adds a RemoteFX video adapter to virtual machine Test. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the RemoteFX video adapter is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a VMRemoteFxVideoAdapter object is to be passed through to the pipeline representing the RemoteFX video adapter to be added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the RemoteFX video adapter is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of virtual machine on which the RemoteFX video adapter is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.RemoteFxVideoAdapter -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMScsiController.md b/docset/winserver2012-ps/hyper-v/Add-VMScsiController.md deleted file mode 100644 index 94d4d2ac21..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMScsiController.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmscsicontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMScsiController - -## SYNOPSIS -Adds a SCSI controller in a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMScsiController [-VMName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMScsiController [-VM] [-Passthru] -``` - -## DESCRIPTION -The Add-VMScsiController cmdlet adds a SCSI controller in a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMScsiController -VMName TestVM -``` - -Adds a SCSI controller in virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a SCSI controller is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMScsiController** object is to be passed through to the pipeline representing the SCSI controller to be added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine in which the SCSI controller is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine in which the SCSI controller is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.ScsiController -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMStoragePath.md b/docset/winserver2012-ps/hyper-v/Add-VMStoragePath.md deleted file mode 100644 index eb33bf7db5..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMStoragePath.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmstoragepath?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMStoragePath - -## SYNOPSIS -Adds a path to a storage resource pool. - -## SYNTAX - -``` -Add-VMStoragePath [-Path] [-ResourcePoolName] [-ResourcePoolType] - [-ComputerName ] [-PassThru] -``` - -## DESCRIPTION -The **Add-VMStoragePath** cmdlet adds a path to a storage resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMStoragePath -Path D:\VHD -ResourcePoolName "Engineering Department" -ResourcePoolType VHD -``` - -Adds path D:\VHD to resource storage pool Engineering Department of type VHD. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the path to the storage resource pool is to be added. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **String** object is to be passed through to the pipeline representing the path to be added to the storage resource pool. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to be added to the storage resource pool. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the resource pool to which the path is to be added. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the type of the resource pool for which storage paths are to be added. -Allowed values are **VFD**, **VHD**, and **ISO**. - -```yaml -Type: VMResourcePoolType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### System.String -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMSwitch.md b/docset/winserver2012-ps/hyper-v/Add-VMSwitch.md deleted file mode 100644 index cf0e450c3c..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMSwitch.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmswitch?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMSwitch - -## SYNOPSIS -Adds a virtual switch to an Ethernet resource pool. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMSwitch [-Name] [-ResourcePoolName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMSwitch [-VMSwitch] [-ResourcePoolName] -``` - -## DESCRIPTION -The **Add-VMSwitch** cmdlet adds a virtual switch to an Ethernet resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Add-VMSwitch -Name Test -ResourcePoolName "Engineering Department" -``` - -Adds virtual switch Test to Ethernet resource pool Engineering Department. - -### Example 2 -``` -PS C:\>Get-VMSwitch -Name Test | Add-VMSwitch -ResourcePoolName "Engineering Department" -``` - -Adds virtual switch Test to Ethernet resource pool Engineering Department. - -## PARAMETERS - -### -ComputerName - - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual switch to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -ResourcePoolName -Specifies the name of the resource pool to which the virtual switch is to be added. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMSwitch -Specifies the virtual switch to be added to the Ethernet resource pool. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default; **Microsoft.Virtualization.Powershell.VMNetwork** if **-PassThru** is present. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMSwitchExtensionPortFeature.md b/docset/winserver2012-ps/hyper-v/Add-VMSwitchExtensionPortFeature.md deleted file mode 100644 index c993157eb5..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMSwitchExtensionPortFeature.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmswitchextensionportfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMSwitchExtensionPortFeature - -## SYNOPSIS -Adds a feature to a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMSwitchExtensionPortFeature [-VMName] [-ComputerName ] [-Passthru] - [-VMNetworkAdapterName ] -VMSwitchExtensionFeature [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMSwitchExtensionPortFeature [-SwitchName] [-ComputerName ] [-Passthru] [-ExternalPort] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-VMSwitchExtensionPortFeature [-ComputerName ] [-Passthru] [-VMNetworkAdapterName ] - [-ManagementOS] -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Add-VMSwitchExtensionPortFeature [-VM] [-Passthru] [-VMNetworkAdapterName ] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Add-VMSwitchExtensionPortFeature [-VMNetworkAdapter] [-Passthru] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-VMSwitchExtensionPortFeature** cmdlet adds a feature supported by a virtual switch extension to a virtual machine network adapter. -This cmdlet also configures built-in virtual switch features. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$feature = Get-VMSystemSwitchExtensionPortFeature -FeatureName "Ethernet Switch Port Security Settings" -PS C:\>$feature.SettingData.EnableDhcpGuard = $true -PS C:\>$feature.SettingData.EnableRouterGuard = $true -PS C:\>Add-VMSwitchExtensionPortFeature -VMName VM2 -VMSwitchExtensionFeature $feature -``` - -Adds a feature to virtual machine VM2. -The feature here is a port security feature supported by the extension Microsoft Virtual Ethernet Switch Native Extension. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a feature is to be added to a virtual network adapter. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalPort -Specifies the virtual switch port connected to the external network interface card. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the feature is to be added in the management (i.e. -the parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the feature to be added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine in which the feature is to be added. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine in which the feature is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter for which the feature is to be added. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual machine network adapter for which the feature is to be added. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be added to the virtual switch. -You can get such a feature object from Get-VMSystemSwitchExtensionPortFeature to add a new configuration to a virtual network adapter, or from the Get-VMSwitchExtensionPortFeature cmdlet to update an existing configuration. - -```yaml -Type: VMSwitchExtensionPortFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMSwitchExtensionPortFeature -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Add-VMSwitchExtensionSwitchFeature.md b/docset/winserver2012-ps/hyper-v/Add-VMSwitchExtensionSwitchFeature.md deleted file mode 100644 index 9e7d83ecd8..0000000000 --- a/docset/winserver2012-ps/hyper-v/Add-VMSwitchExtensionSwitchFeature.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/add-vmswitchextensionswitchfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-VMSwitchExtensionSwitchFeature - -## SYNOPSIS -Adds a feature to a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-VMSwitchExtensionSwitchFeature [-SwitchName] [-ComputerName ] [-Passthru] - -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-VMSwitchExtensionSwitchFeature [-VMSwitch] [-Passthru] - -VMSwitchExtensionFeature -``` - -## DESCRIPTION -The **Add-VMSwitchExtensionSwitchFeature** cmdlet adds a feature supported by a virtual switch extension to a virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$feature = Get-VMSwitchExtensionSwitchFeature -FeatureName "Ethernet Switch BandwidthSettings" -PS C:\>$feature.SettingData.DefaultFlowReservation = 300000000 -PS C:\>Add-VMSwitchExtensionSwitchFeature "External" -VMSwitchExtensionSwitchFeature $feature -``` - -Adds a feature to virtual switch External. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a feature is to be added to a virtual switch. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the feature to be added. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch to which the feature is to be added. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch to which the feature is to be added. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be added to the virtual switch. - -```yaml -Type: VMSwitchExtensionSwitchFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMSwitchExtensionSwitchFeature -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Checkpoint-VM.md b/docset/winserver2012-ps/hyper-v/Checkpoint-VM.md deleted file mode 100644 index e517cc22d7..0000000000 --- a/docset/winserver2012-ps/hyper-v/Checkpoint-VM.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/checkpoint-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Checkpoint-VM - -## SYNOPSIS -Creates a snapshot of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Checkpoint-VM [-Name] [[-SnapshotName] ] [-AsJob] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Checkpoint-VM [-VM] [[-SnapshotName] ] [-AsJob] [-Passthru] -``` - -## DESCRIPTION -The **Checkpoint-VM** cmdlet creates a snapshot of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Checkpoint-VM -Name Test -SnapshotName BeforeInstallingUpdates -``` - -Checkpoints virtual machine Test, creating a snapshot of it named BeforeInstallingUpdates. - -### Example 2 -``` -PS C:\>Get-VM Test -ComputerName Server1 | Checkpoint-VM -``` - -Checkpoints virtual machine Test on Hyper-V host Server1. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more virtual machine hosts on which the virtual machine snapshot is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine of which a snapshot is to be taken. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual machine of which a snapshot is to be taken. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotName -Specifies the name of the snapshot to be taken. -If not provided, a combination of the virtual machine's name and a current timestamp is used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine of which a snapshot is to be taken. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -Nothing by default; **Microsoft.Virtualization.Powershell.Snapshot** if **-Passthru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Compare-VM.md b/docset/winserver2012-ps/hyper-v/Compare-VM.md deleted file mode 100644 index 4c633485fe..0000000000 --- a/docset/winserver2012-ps/hyper-v/Compare-VM.md +++ /dev/null @@ -1,460 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/compare-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Compare-VM - -## SYNOPSIS -Compares a virtual machine and a virtual machine host for compatibility, returning a compatibility report. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Compare-VM [-Name] [-DestinationHost] [-AsJob] [-ComputerName ] - [-DestinationStoragePath ] [-IncludeStorage] [-ResourcePoolName ] [-RetainVhdCopiesOnSource] - [-SmartPagingFilePath ] [-SnapshotFilePath ] [-Vhds ] - [-VirtualMachinePath ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Compare-VM [-CompatibilityReport] [-AsJob] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Compare-VM [-Path] [-AsJob] [-ComputerName ] [-Register] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Compare-VM [-Path] [[-VhdDestinationPath] ] [-AsJob] [-ComputerName ] - [-GenerateNewId] [-SmartPagingFilePath ] [-SnapshotFilePath ] [-VhdSourcePath ] - [-VirtualMachinePath ] [-Copy] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Compare-VM [-VM] [-DestinationHost] [-AsJob] [-DestinationStoragePath ] - [-IncludeStorage] [-ResourcePoolName ] [-RetainVhdCopiesOnSource] [-SmartPagingFilePath ] - [-SnapshotFilePath ] [-Vhds ] [-VirtualMachinePath ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Compare-VM** cmdlet compares a virtual machine and a virtual machine host for compatibility, returning a compatibility report. -This is useful when trying to import or migrate a virtual machine that is incompatible with the target Hyper-V server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Compare-VM -Name TestVM -DestinationHost TestDestinationHost -``` - -Compares virtual machine TestVM and Hyper-V host TestDestinationHost for compatibility. - -### Example 2 -``` -Attempts import of a virtual machine; the attempt fails due to incompatibilities with the Hyper-V host. -PS C:\>Import-VM -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML' -Import-VM : Unable to import virtual machine due to configuration errors. Please use Compare-VM to repair the virtual machine. -At line:1 char:1 -+ import-vm -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XM ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : NotSpecified: (:) [Import-VM], VirtualizationOperationFailedException - + FullyQualifiedErrorId : Microsoft.HyperV.PowerShell.Commands.ImportVMCommand - -Gets a compatibility report that describes the attempted import and lists the virtual machine's incompatibilities with the Hyper-V host. -PS C:\>$report = Compare-VM -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML' - - -Displays the compatibility report, revealing that the virtual network adapter was connected to switch Production. The Hyper-V host has no switch by that name. -PS C:\>$report.Incompatibilities | Format-Table -AutoSize -Message MessageId Source -------- --------- ------ -Could not find Ethernet switch 'Production'. 33012 Microsoft.HyperV.PowerShell.VMNetworkAdapter - -Disconnects the virtual network adapter. -PS C:\>$report.Incompatibilities[0].Source | Disconnect-VMNetworkAdapter - - -Generates a new compatibility report to determine if the virtual machine is compatible with the Hyper-V host. -PS C:\>Compare-VM -CompatibilityReport $report - - -Displays the compatibility report. -PS C:\>$report -VM : Microsoft.HyperV.PowerShell.VirtualMachine -OperationType : ImportVirtualMachine -Destination : HYPER-V-1 -Path : D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML -SnapshotPath : D:\vm1\Snapshots -VhdDestinationPath : -VhdSourcePath : -Incompatibilities : - -Imports the virtual machine. -PS C:\>import-vm -CompatibilityReport $report -Name State CPUUsage(%) MemoryAssigned(M) MemoryDemand(M) MemoryStatus Uptime Status ReplicationState ----- ----- ----------- ----------------- --------------- ------------ ------ ------ ---------------- -VM1 Off 0 0 0 00:00:00 Operating normally Disabled -``` - -Imports a virtual machine whose configuration is not compatible with the Hyper-V host. -Note the use of **Compare-VM** to troubleshoot the import failure in the first step. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityReport -Specifies a compatibility report which resolves any incompatibilities between the virtual machine and the virtual machine host. - -```yaml -Type: VMCompatibilityReport -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the . -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationHost -Specifies the Hyper-V host to which the virtual machine is to be compared for compatibility. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationStoragePath -Specifies a destination storage path to which all virtual machine storage is to be moved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateNewId -Specifies that the virtual machine should be copied and given a new unique identifier. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeStorage -Specifies that the compatibility comparison should include both the virtual machine and its storage. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be compared. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the configuration file of the virtual machine to be compared. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine object to be compared. - -```yaml -Type: VirtualMachine -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Friendly name of the resource pool - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainVhdCopiesOnSource -Specify this parameter to retain parent virtual hard disks on the source computer. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartPagingFilePath -Specifies the new path to use for a smart paging file, if one is needed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotFilePath -Specifies the path for any snapshot files associated with the virtual machine. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vhds -An array of hashtables that specifies a location for each individual virtual hard disk that needs to be moved. -Each hashtable has two entries. -The first entry specifies the current location of the virtual hard disk to move, and has a key of SourceFilePath. -The second entry specifies the new location for the virtual hard disk, and has a key of DestinationFilePath. -The virtual hard disk names must be identical in both entries. - -```yaml -Type: Hashtable[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachinePath -Specifies the path where the virtual machine configuration files are to be stored. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Copy -Specifies that the comparison should be made for a copy import operation. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Register -Specifies that the comparison should be made for an in-place import operation. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdDestinationPath -Specifies the folder to which the virtual machine's VHD files are to be copied. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdSourcePath -Specifies the folder from which the virtual machine's VHD files are to be copied. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.CompatibilityReport - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Complete-VMFailover.md b/docset/winserver2012-ps/hyper-v/Complete-VMFailover.md deleted file mode 100644 index f516a77dd5..0000000000 --- a/docset/winserver2012-ps/hyper-v/Complete-VMFailover.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/complete-vmfailover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Complete-VMFailover - -## SYNOPSIS -Completes a virtual machine's failover process on the Replica server. -Removes all recovery points on a failed over virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Complete-VMFailover [-VMName] [-ComputerName ] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Complete-VMFailover [-VM] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Complete-VMFailover** cmdlet completes a virtual machine's failover process on the Replica server. -The recovery point, on which the virtual machine is failed over, is committed and all other recovery points are removed. -Failover cannot be canceled after the recovery points are removed. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Complete-VMFailover VM01 -``` - -This command completes the failover process of a virtual machine named VM01, thereby deleting all other recovery points on the server. - -### Example 2 -``` -PS C:\>Complete-VMFailover * -``` - -This command completes the failover process of all virtual machines on the local host for which the failover process has been started. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the failover process is to be completed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that an object is to be passed through to the pipeline representing the virtual machine whose failover process is to be completed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose failover process is to be completed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose failover process is to be completed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Connect-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Connect-VMNetworkAdapter.md deleted file mode 100644 index 951c9e3fee..0000000000 --- a/docset/winserver2012-ps/hyper-v/Connect-VMNetworkAdapter.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/connect-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Connect-VMNetworkAdapter - -## SYNOPSIS -Connects a virtual network adapter to a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Connect-VMNetworkAdapter [-VMName] [[-Name] ] [-SwitchName] - [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Connect-VMNetworkAdapter [-VMName] [[-Name] ] [-ComputerName ] [-Passthru] - [-UseAutomaticConnection] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Connect-VMNetworkAdapter [-VMName] [[-Name] ] [-VMSwitch] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Connect-VMNetworkAdapter [-VMNetworkAdapter] [-SwitchName] [-Passthru] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Connect-VMNetworkAdapter [-VMNetworkAdapter] [-Passthru] [-UseAutomaticConnection] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Connect-VMNetworkAdapter [-VMNetworkAdapter] [-VMSwitch] [-Passthru] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Connect-VMNetworkAdapter** cmdlet connects a virtual network adapter to a virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Connect-VMNetworkAdapter -VMName Test1,Test2 -Name Internet -SwitchName InternetAccess -``` - -Connects a virtual network adapter named Internet in virtual machines Test1 and Test2 to a virtual switch InternetAccess. - -### Example 2 -``` -PS C:\>Get-VMNetworkAdapter -VMName Test1 | Connect-VMNetworkAdapter -SwitchName InternetAccess -``` - -Connects a virtual network adapter in virtual machine Test1 to virtual switch InternetAccess. - -### Example 3 -``` -PS C:\>Get-VMSwitch InternetAccess | Connect-VMNetworkAdapter -VMName Test1 -``` - -Connects a virtual network adapter in virtual machine Test1 to switch InternetAccess. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts on which the virtual network adapter is to be connected. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network adapter to be connected. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: VMNetworkAdapterName - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VMNetworkAdapter** object is to be passed through to the pipeline representing the virtual network adapter to be connected. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch to which the virtual network adapter is to be connected. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseAutomaticConnection -Specifies that the network adapter is to be connected to any virtual switch in the resource pool, rather than to a specific virtual switch. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine in which the network adapter is to be connected. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter to be connected. - -```yaml -Type: VMNetworkAdapter[] -Parameter Sets: UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch to which the virtual network adapter is to be connected. - -```yaml -Type: VMSwitch -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMNetworkAdapter -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Connect-VMSan.md b/docset/winserver2012-ps/hyper-v/Connect-VMSan.md deleted file mode 100644 index db6bbd7ddc..0000000000 --- a/docset/winserver2012-ps/hyper-v/Connect-VMSan.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/connect-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Connect-VMSan - -## SYNOPSIS -Associates a host bus adapter with a virtual storage area network (SAN). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Connect-VMSan [-Name] [-ComputerName ] [-Passthru] -WorldWideNodeName - -WorldWidePortName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Connect-VMSan [-Name] [-Passthru] -HostBusAdapter [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Connect-VMSan** cmdlet associates a host bus adapter with a virtual storage area network (SAN). - -## EXAMPLES - -### Example 1 -``` -PS C:\>Connect-VMSan -Name Production -WorldWideNodeName C003FF0000FFFF00 -WorldWidePortName C003FF5778E50002 -``` - -Associates the virtual storage area network (SAN) named Production with the host bus adapter having the specified world wide node name and world wide port name. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts where the host bus adapter is to be associated with the virtual storage area network (SAN). -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostBusAdapter -Specifies the host bus adapter to be associated with the virtual storage area network (SAN). - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual storage area network (SAN) with which the host bus adapter is to be associated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.SAN** object is to be passed through to the pipeline representing the virtual storage area network (SAN) to be associated with the host bus adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeName -Specifies the world wide node name of the host bus adapter to be associated with the virtual storage area network (SAN). - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortName -The port world wide name of the host bus adapter to be associated with the virtual storage area network (SAN). - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.SAN -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Convert-VHD.md b/docset/winserver2012-ps/hyper-v/Convert-VHD.md deleted file mode 100644 index a7bef0791a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Convert-VHD.md +++ /dev/null @@ -1,225 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/convert-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Convert-VHD - -## SYNOPSIS -Converts the format, version type, and block size of a virtual hard disk file. - -## SYNTAX - -``` -Convert-VHD [-Path] [-DestinationPath] [-AsJob] [-BlockSizeBytes ] - [-ComputerName ] [-DeleteSource] [-ParentPath ] [-Passthru] [-VHDType ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Convert-VHD** cmdlet converts a virtual hard disk file by copying the data from a source virtual hard disk file to a new virtual hard disk file of a specified format and version type. -The format is determined by the file extension of the specified files, either .vhdx or .vhd. -Conversion is an offline operation; the virtual hard disk must not be attached when the operation is started. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Convert-VHD -Path c:\test\testvhd.vhd -DestinationPath c:\test\testvhdx.vhdx -``` - -This example converts a source VHD to a destination VHDX. -Because the format is determined by the file extension and the default type is determined by the source virtual hard disk when no type is specified, the destination virtual hard disk will be a VHDX-format disk of the same type as the source virtual hard disk. - -### Example 2 -``` -PS C:\>Convert-VHD -Path c:\test\child1vhdx.vhdx -DestinationPath c:\test\child1vhd.vhd -VHDType Differencing -ParentPath c:\test\parentvhd.vhd -``` - -This example converts a source differencing disk of VHDX format to a destination differencing disk of VHD format that is connected to an existing parent disk. - -## PARAMETERS - -### -AsJob -Runs the operation as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockSizeBytes -Specifies the block size, in bytes, of the virtual hard disk after conversion. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual hard disk is to be converted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteSource -Specifies that the source virtual hard disk is to be deleted after the conversion. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPath -Specifies the path to the converted virtual hard disk file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentPath -Specifies the parent path for the destination-differencing virtual hard disk file. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the converted virtual hard disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual hard disk file to be converted. -If a file name or relative path is specified, the path of the converted hard disk path is calculated relative to the current working directory - -```yaml -Type: String -Parameter Sets: (All) -Aliases: FullName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -VHDType -Specifies the type of the converted virtual hard disk. -Allowed values are **Fixed**, **Dynamic**, and **Differencing**. -The default is determined by the type of source virtual hard disk. - -```yaml -Type: VhdType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disable-VMEventing.md b/docset/winserver2012-ps/hyper-v/Disable-VMEventing.md deleted file mode 100644 index 084c546137..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disable-VMEventing.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disable-vmeventing?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-VMEventing - -## SYNOPSIS -Disables virtual machine eventing. - -## SYNTAX - -``` -Disable-VMEventing [-ComputerName ] [-Force] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-VMEventing** cmdlet disables virtual machine eventing on a Hyper-V host or hosts. -Virtual machine eventing keeps Hyper-V PowerShell objects updated without polling the virtual machine host. -Virtual machine eventing is enabled by default. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-VMEventing -Force -``` - -Disables virtual machine eventing, suppressing the confirmation prompt. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which virtual machine eventing is to be disabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that the confirmation prompt is to be suppressed. -(This is useful in scripting the cmdlet.) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disable-VMIntegrationService.md b/docset/winserver2012-ps/hyper-v/Disable-VMIntegrationService.md deleted file mode 100644 index eecf50daeb..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disable-VMIntegrationService.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disable-vmintegrationservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-VMIntegrationService - -## SYNOPSIS -Disables an integration service on a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-VMIntegrationService [-Name] [-VMName] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-VMIntegrationService [-Name] [-VM] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-VMIntegrationService [-VMIntegrationService] [-Passthru] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Disable-VMIntegrationService** cmdlet disables an integration service on a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-VMIntegrationService -Name Shutdown,VSS -VMName Test1 -``` - -This example disables the Shutdown and VSS integration services on virtual machine Test1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the integration service on a virtual machine is to be disabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration service to be disabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.PowerShell.IntegrationService** object is to be passed through to the pipeline representing the integration service to be disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the integration service is to be disabled. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMIntegrationService -Specifies the integration service to be disabled. - -```yaml -Type: VMIntegrationComponent[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the integration service is to be disabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.PowerShell.IntegrationService -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disable-VMMigration.md b/docset/winserver2012-ps/hyper-v/Disable-VMMigration.md deleted file mode 100644 index 3e58e27f56..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disable-VMMigration.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disable-vmmigration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-VMMigration - -## SYNOPSIS -Disables migration on one or more virtual machine hosts. - -## SYNTAX - -``` -Disable-VMMigration [[-ComputerName] ] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-VMMigration** cmdlet disables migration on one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-VMMigration -``` - -Disables live migration on the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which migration is to be disabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.Host** object is to be passed through to the pipeline representing each virtual machine host on which migration is disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default; **Microsoft.Virtualization.Powershell.Host** if **-PassThru** is present. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disable-VMRemoteFXPhysicalVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Disable-VMRemoteFXPhysicalVideoAdapter.md deleted file mode 100644 index ce6d60ef4a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disable-VMRemoteFXPhysicalVideoAdapter.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disable-vmremotefxphysicalvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-VMRemoteFXPhysicalVideoAdapter - -## SYNOPSIS -Disables one or more RemoteFX physical video adapters from use with RemoteFX-enabled virtual machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-VMRemoteFXPhysicalVideoAdapter [-Name] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-VMRemoteFXPhysicalVideoAdapter [-GPU] [-Passthru] -``` - -## DESCRIPTION -The **Disable-VMRemoteFXPhysicalVideoAdapter** disables one or more RemoteFX physical video adapter from use with RemoteFX-enabled virtual machines. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* -``` - -This example disables all RemoteFX physical video adapters that include the string "Nvidia" in their names. - -### Example 2 -``` -PS C:\>Get-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* | Disable-VMRemotePhysicalVideoAdapter -``` - -This example disables all RemoteFX physical video adapters that include the string "Nvidia" in their names. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the RemoteFX physical video adapters are to be disabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPU -Specifies one or more RemoteFX physical video adapters to disable. - -```yaml -Type: VMRemoteFXPhysicalVideoAdapter[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that **Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter** objects are to be passed to the pipeline representing the RemoteFX physical video adapters to be disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter[] - -### System.String[] - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disable-VMResourceMetering.md b/docset/winserver2012-ps/hyper-v/Disable-VMResourceMetering.md deleted file mode 100644 index 50130096af..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disable-VMResourceMetering.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disable-vmresourcemetering?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-VMResourceMetering - -## SYNOPSIS -Disables collection of resource utilization data for a virtual machine or resource pool. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-VMResourceMetering [-ResourcePoolName] [[-ResourcePoolType] ] - [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-VMResourceMetering [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-VMResourceMetering [-VM] -``` - -## DESCRIPTION -The **Disable-VMResourceMetering** cmdlet disables collection of resource utilization data for a virtual machine or resource pool. - -Calling this cmdlet stops collection of data and deletes data collected up to the point of the call. - -After the call, Measure-VM and Measure-VMResourcePool are not usable. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-VMResourceMetering -VMName TestVM -``` - -Disables collection of resource utilization data on a virtual machine named TestVM. - -### Example 2 -``` -PS C:\>Get-VM Test* | Disable-VMResourceMetering -``` - -Disables collection of resource utilization data on a set of virtual machines whose names begin with the string Test. - -### Example 3 -``` -PS C:\>Disable-VMResourceMetering -ResourcePoolName TestResourcePool -ResourcePoolType Memory -``` - -Disables collection of resource utilization data collection on a resource pool named TestResourcePool of type Memory. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which resource utilization data collection is to be disabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the friendly name of the resource pool on which resource utilization data collection is to be disabled. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the resource type of the resource pool on which resource utilization data collection is to be disabled. - -```yaml -Type: VMResourcePoolType -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which resource utilization data collection is to be disabled. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the friendly name of the virtual machine on which resource utilization data collection is to be disabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -### Microsoft.HyperV.PowerShell.VMResourcePoolType - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Measure-VM](./Measure-VM.md) - -[Measure-VMResourcePool](./Measure-VMResourcePool.md) - -[Enable-VMResourceMetering](./Enable-VMResourceMetering.md) - diff --git a/docset/winserver2012-ps/hyper-v/Disable-VMSwitchExtension.md b/docset/winserver2012-ps/hyper-v/Disable-VMSwitchExtension.md deleted file mode 100644 index 5192fe24bb..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disable-VMSwitchExtension.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disable-vmswitchextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-VMSwitchExtension - -## SYNOPSIS -Disables one or more extensions on one or more virtual switches. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-VMSwitchExtension [-Name] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-VMSwitchExtension [-Name] [-VMSwitchName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-VMSwitchExtension [-Name] [-VMSwitch] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Disable-VMSwitchExtension [-VMSwitchExtension] [-ComputerName ] -``` - -## DESCRIPTION -The **Disable-VMSwitchExtension** cmdlet disables one or more extensions on one or more virtual switches. -You can run Get-VMSystemSwitchExtension to enumerate the virtual switch extensions installed on the system. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disable-VMSwitchExtension -VMSwitchName "Internal Switch" -Name "Microsoft Windows Filtering Platform" -``` - -Disables WFP ("Microsoft Windows Filtering Platform") on virtual switch Internal Switch. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the extension is to be disabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch on which the extension is to be disabled. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtension -Specifies the extension to be disabled. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchName -Specifies the name of the switch on which the extension is to be disabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension to be disabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.PowerShell.NetworkExtension - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disconnect-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Disconnect-VMNetworkAdapter.md deleted file mode 100644 index b2d75d3f6c..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disconnect-VMNetworkAdapter.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disconnect-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disconnect-VMNetworkAdapter - -## SYNOPSIS -Disconnects a virtual network adapter from a virtual switch or Ethernet resource pool. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disconnect-VMNetworkAdapter [-VMName] [[-Name] ] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disconnect-VMNetworkAdapter [-VMNetworkAdapter] [-Passthru] -``` - -## DESCRIPTION -The **Disconnect-VMNetworkAdapter** cmdlet disconnects a virtual network adapter from a virtual switch or Ethernet resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disconnect-VMNetworkAdapter -VMNetworkAdapter Test1 -``` - -Disconnects virtual network adapter Test1. - -### Example 2 -``` -PS C:\>Get-VMNetworkAdapter -VMName * | Where-Object {$_.SwitchName -eq 'InternetAccess'} | Disconnect-VMNetworkAdapter -``` - -Disconnects all virtual network adapters whose SwitchName is InternetAccess in all virtual machines on the local Hyper-V server. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual network adapter is to be disconnected. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network adapter to be disconnected. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VMNetworkAdapter** object is to be passed through to the pipeline representing the virtual network adapter to be disconnected. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine in which the virtual network adapter is to be disconnected. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter to be disconnected. - -```yaml -Type: VMNetworkAdapter[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMNetworkAdapter -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Disconnect-VMSan.md b/docset/winserver2012-ps/hyper-v/Disconnect-VMSan.md deleted file mode 100644 index 1a7d190c6d..0000000000 --- a/docset/winserver2012-ps/hyper-v/Disconnect-VMSan.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/disconnect-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disconnect-VMSan - -## SYNOPSIS -Removes a host bus adapter from a virtual storage area network (SAN). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disconnect-VMSan [-Name] [-ComputerName ] [-Passthru] -WorldWideNodeName - -WorldWidePortName -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disconnect-VMSan [-Name] [-Passthru] -HostBusAdapter -``` - -## DESCRIPTION -The **Disconnect-VMSan** cmdlet removes a host bus adapter from a virtual storage area network (SAN). - -## EXAMPLES - -### Example 1 -``` -PS C:\>Disconnect-VMSan -Name Production -WorldWideNodeName C003FF0000FFFF00 -WorldWidePortName C003FF5778E50002 -``` - -Removes the host bus adapter having the specified world wide node name and world wide port name from the virtual machine named Production on the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a host bus adapter is to be removed from a virtual storage area network (SAN). -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostBusAdapter -Specifies the host bus adapter to be removed from the virtual storage area network (SAN). - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual storage area network (SAN) from which the host bus adapter is to be removed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual storage area network (SAN) from which the host bus adapter is to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeName -The world wide node name of the host bus adapter to be removed from the virtual storage area network (SAN). - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortName -The world wide port name of the host bus adapter to be removed from the virtual storage area network (SAN). - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMSan -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Dismount-VHD.md b/docset/winserver2012-ps/hyper-v/Dismount-VHD.md deleted file mode 100644 index 6b4917c238..0000000000 --- a/docset/winserver2012-ps/hyper-v/Dismount-VHD.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/dismount-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Dismount-VHD - -## SYNOPSIS -Dismounts a virtual hard disk. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Dismount-VHD [-Path] [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Dismount-VHD [-DiskNumber] [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Dismount-VHD** cmdlet dismounts a virtual hard disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Dismount-VHD -Path c:\test\testvhdx.vhdx -``` - -Dismounts an attached virtual hard disk where the path to the virtual hard disk file path is c:\test\testvhdx.vhdx. - -### Example 2 -``` -PS C:\>Dismount-VHD -DiskNumber 6 -``` - -Dismounts the attached virtual hard disk image with disk number 6. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual hard disk is to be dismounted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskNumber -Specifies the disk number of the virtual hard disk to be dismounted. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual hard disk to be dismounted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies one or more virtual hard disk files for which the corresponding virtual hard disks are to be dismounted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMEventing.md b/docset/winserver2012-ps/hyper-v/Enable-VMEventing.md deleted file mode 100644 index 8c991fab49..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMEventing.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmeventing?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMEventing - -## SYNOPSIS -Enables virtual machine eventing. - -## SYNTAX - -``` -Enable-VMEventing [-ComputerName ] [-Force] -``` - -## DESCRIPTION -The **Enable-VMEventing** cmdlet enables virtual machine eventing. -Virtual machine eventing keeps Hyper-V PowerShell objects updated without polling the virtual machine host. -Virtual machine eventing is enabled by default. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-VMEventing -Force -``` - -Enables virtual machine eventing, suppressing the confirmation prompt. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which virtual machine eventing is to be enabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that the confirmation prompt is to be suppressed. -(This is useful in scripting the cmdlet.) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMIntegrationService.md b/docset/winserver2012-ps/hyper-v/Enable-VMIntegrationService.md deleted file mode 100644 index b167f29614..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMIntegrationService.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmintegrationservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMIntegrationService - -## SYNOPSIS -Enables an integration service on a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-VMIntegrationService [-Name] [-VMName] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-VMIntegrationService [-Name] [-VM] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-VMIntegrationService [-VMIntegrationService] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-VMIntegrationService** cmdlet enables an integration service on a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-VMIntegrationService -Name Shutdown,VSS -VMName Test1 -``` - -Enables integration services Shutdown and VSS on virtual machine Test1. - -### Example 2 -``` -PS C:\>Get-VMIntegrationService Shutdown,Vss -VMName Test1 | Enable-VMIntegrationService -``` - -Enables integration services Shutdown and VSS on virtual machine Test1. - -### Example 3 -``` -PS C:\>Get-VM Test1 | Enable-VMIntegrationService Shutdown,VSS -``` - -Enables integration services Shutdown and VSS on virtual machine Test1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which an integration service is to be enabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration service to be enabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.PowerShell.IntegrationService** object is to be passed through to the pipeline representing the integration service to be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the integration service is to be enabled. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMIntegrationService -Specifies the integration service to be enabled. - -```yaml -Type: VMIntegrationComponent[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the integration service is to be enabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.PowerShell.IntegrationService -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMMigration.md b/docset/winserver2012-ps/hyper-v/Enable-VMMigration.md deleted file mode 100644 index 6626a3ec94..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMMigration.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmmigration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMMigration - -## SYNOPSIS -Enables migration on one or more virtual machine hosts. - -## SYNTAX - -``` -Enable-VMMigration [[-ComputerName] ] [-Passthru] -``` - -## DESCRIPTION -The **Enable-VMMigration** cmdlet enables migration on one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-VMMigration -``` - -Enables live migration on the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which migration is to be enabled. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.Host** object is to be passed through to the pipeline representing each virtual machine host on which migration is to be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.Host -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md deleted file mode 100644 index 2ddd2b9a2b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMRemoteFXPhysicalVideoAdapter.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmremotefxphysicalvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMRemoteFXPhysicalVideoAdapter - -## SYNOPSIS -Enables one or more RemoteFX physical video adapters for use with RemoteFX-enabled virtual machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-VMRemoteFXPhysicalVideoAdapter [-Name] [-ComputerName ] [-Passthru] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-VMRemoteFXPhysicalVideoAdapter [-GPU] [-Passthru] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Enable-VMRemoteFXPhysicalVideoAdapter** cmdlet enables one or more RemoteFX physical video adapters to be used with RemoteFX-enabled virtual machines. - -## EXAMPLES - -### Code Example Title -``` -PS C:\>Get-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* | Enable-VMRemoteFXPhysicalVideoAdapter -``` - -Enables all RemoteFX physical video adapters which include the sequence "Nvidia" in their name. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the RemoteFX physical video adapters are to be enabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPU -Specifies the RemoteFX physical video adapters to be enabled. - -```yaml -Type: VMRemoteFXPhysicalVideoAdapter[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that one or more **Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter** objects are to be passed through to the pipeline representing the RemoteFX physical video adapters to be enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name - - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter[] - -### -System.String\[\] - -## OUTPUTS - -### -None by default; **Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter\[\]** if **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMReplication.md b/docset/winserver2012-ps/hyper-v/Enable-VMReplication.md deleted file mode 100644 index bd9165bd3b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMReplication.md +++ /dev/null @@ -1,494 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMReplication - -## SYNOPSIS -Enables replication of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-VMReplication [-VMName] [-ReplicaServerName] [-ReplicaServerPort] - [-AuthenticationType] [-AsJob] [-AutoResynchronizeEnabled ] - [-AutoResynchronizeIntervalEnd ] [-AutoResynchronizeIntervalStart ] - [-BypassProxyServer ] [-CertificateThumbprint ] [-CompressionEnabled ] - [-ComputerName ] [-EnableWriteOrderPreservationAcrossDisks ] - [-ExcludedVhd ] [-ExcludedVhdPath ] [-PassThru] [-RecoveryHistory ] - [-ReplicateHostKvpItems ] [-VSSSnapshotFrequency ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-VMReplication [-VM] [-AllowedPrimaryServer ] [-AsJob] [-AsReplica] - [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-VMReplication [-VMName] [-AllowedPrimaryServer ] [-AsJob] [-AsReplica] - [-ComputerName ] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Enable-VMReplication [-VM] [-ReplicaServerName] [-ReplicaServerPort] - [-AuthenticationType] [-AsJob] [-AutoResynchronizeEnabled ] - [-AutoResynchronizeIntervalEnd ] [-AutoResynchronizeIntervalStart ] - [-BypassProxyServer ] [-CertificateThumbprint ] [-CompressionEnabled ] - [-EnableWriteOrderPreservationAcrossDisks ] [-ExcludedVhd ] - [-ExcludedVhdPath ] [-PassThru] [-RecoveryHistory ] [-ReplicateHostKvpItems ] - [-VSSSnapshotFrequency ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-VMReplication** cmdlet enables replication of a virtual machine to a specified Replica server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Enable-VMReplication VM01 server01.domain01.contoso.com 80 Kerberos -``` - -This example configures replication for a virtual machine named VM01 on the local Hyper-V host and directs replication traffic to port 80 on a Replica server named server01.domain01.contoso.com, using Kerberos as the type of authentication. - -### Example 2 -``` -PS C:\> Enable-VMReplication * server01.domain01.contoso.com 80 Kerberos -``` - -This example configures replication for all virtual machines on the local Hyper-V host to replica server and directs replication traffic to port 80 on a Replica server named server01.domain01.contoso.com, using Kerberos as the type of authentication. - -### Example 3 -``` -PS C:\> Enable-VMReplication VM01 -AsReplica -AllowedPrimaryServer *.domain01.contoso.com -``` - -This example configures a virtual machine VM02 as a replica virtual machine and allows replication of the primary virtual machine from all primary servers that belong to a domain named domain01.contoso.com. - -## PARAMETERS - -### -AllowedPrimaryServer -When you use the AsReplica parameter to specify a virtual machine as a replica virtual machine, this parameter determines which primary servers can send replication to the replica virtual machine. -Replication is accepted only from the server specified in the chosen authentication entry, or any other authentication entry that has the same trust group. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: AllowedPS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsReplica -Specifies that the virtual machine is a replica virtual machine, enabling it to be used as the source for the initial replication of the primary virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the authentication type to use for virtual machine replication, either "Kerberos" or "Certificate". -The specified Replica server must support the chosen authentication type. -Run the Get-VMReplicationServer cmdlet to verify the authentication configured for the specified Replica server, or contact the administrator of the specified Replica server. - -```yaml -Type: ReplicationAuthenticationType -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: AuthType - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoResynchronizeEnabled -Enables replicating virtual machines that require resynchronization to be resynchronized automatically. -(For example, a virtual machine requires resynchronization if the primary server shuts down abruptly). -Resynchronization requires significant storage and processing resources. -We recommended scheduling resynchronization during off-peak hours to reduce the impact to the host and other virtual machines running on the host. -Use the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd parameters to specify an off-peak time to start the automatic resynchronization. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: AutoResync - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoResynchronizeIntervalEnd -Specifies the end of the time period in which you want resynchronization to start automatically. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: AutoResyncEnd - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoResynchronizeIntervalStart -Specifies the start of the time period in which you want resynchronization to start automatically. - -```yaml -Type: TimeSpan -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: AutoResyncStart - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassProxyServer -Specifies whether to bypass a proxy server while replicating data to the Replica server. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Specifies the certificate to use for mutual authentication of the replication data. -This parameter is required only when "Certificate" is specified as the type of authentication. -Specify the thumbprint of a valid computer certificate from the Personal store. - -The certificate must have all of the following properties to be valid: - -It must not be expired. - -It must include both client and server authentication extensions for extended key usage (EKU), and an associated private key. - -It must terminate at a valid root certificate. - -The requirement for the subject common name (CN) differs depending on whether the virtual machine belongs to a cluster. -For virtual machines that do not belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) should contain, the FQDN of the host. -For virtual machines that belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) must contain, the and fully-qualified domain name (FQDN) of the Hyper-V Replica Broker. - -To display a list of certificates in the computer's My store and the thumbprint of each certificate, type the following: - -`PS C:\\\> cd cert:\LocalMachine\My` - -`PS C:\\\> dir | format-list` - -For more information about certificate stores, see http://technet.microsoft.com//library/cc757138.aspxhttp://technet.microsoft.com//library/cc757138.aspx. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: Thumbprint,Cert - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompressionEnabled -Specifies whether to compress replication data for this virtual machine when it is sent over the network. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts that have the virtual machines for which you want to enable replication. -NetBIOS names, IP addresses, and fully-qualified domain names (FQDN) are allowed. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableWriteOrderPreservationAcrossDisks -Determines whether all virtual hard disks selected for replication are replicated to the same point in time. -This is useful if the virtual machine runs an application that saves data across virtual hard disks (for example, one virtual hard disk dedicated for application data, and another virtual hard disk dedicated for application log files). - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedVhd -Specifies one or more virtual hard disks to exclude from replication (for example, a virtual hard disk dedicated for the paging file). -Be careful not to exclude virtual hard disks that are critical to the virtual machine's ability to start up, such as the virtual hard disk that stores the guest operating system. -Excluding a critical disk could prevent the replica virtual machine from starting up properly. - -```yaml -Type: HardDiskDrive[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludedVhdPath -Specifies the fully qualified path names to the virtual hard disks to exclude from replication. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplication** object is to be passed through to the pipeline representing the replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryHistory -Specifies whether to store additional recovery points on the replica virtual machine. -Storing more than the most recent recovery point of the primary virtual machine allows you to recover to an earlier point in time. -However, storing additional recovery points requires more storage and processing resources. -You can configure as many as 15 recovery points to be stored. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: RecHist - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaServerName -Specifies the name of the Replica server to which this virtual machine will be replicated. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: ReplicaServer - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaServerPort -Specifies the port on the Replica server to use for replication traffic. -Make sure you specify a port that is configured on the Replica server to support the same authentication type you specify using the AuthenticationType parameter in this cmdlet. -Run the Get-VMReplicationServer cmdlet on the Replica server to check the configuration of the port, or contact the administrator of the specified Replica server. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: ReplicaPort - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicateHostKvpItems -Specifies whether to replicate host-only key value pairs (KVP) for this virtual machine. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine you want to configure for replication. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine you want to configure for replication. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VSSSnapshotFrequency -Specifies how often to replicate volume shadow copy service (VSS) copies of the virtual machine, which are called application-consistent recovery points. -Valid values are in increments of one hour. -You can specify from 1 through 12 hours. -Use of this parameter requires that you also use the "Recovery History" parameter to specify at least one additional recovery point. -Using application-consistent recovery points impacts the performance of applications running in the primary virtual machine when these snapshots are taken. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: VSSFreq - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -None. - -## OUTPUTS - -### -None. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMResourceMetering.md b/docset/winserver2012-ps/hyper-v/Enable-VMResourceMetering.md deleted file mode 100644 index 0d14e24d4a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMResourceMetering.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmresourcemetering?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMResourceMetering - -## SYNOPSIS -Collects resource utilization data for a virtual machine or resource pool. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-VMResourceMetering [-ResourcePoolName] [[-ResourcePoolType] ] - [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-VMResourceMetering [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-VMResourceMetering [-VM] -``` - -## DESCRIPTION -The **Enable-VMResourceMetering** cmdlet starts collecting resource utilization data for a virtual machine or resource pool. - -You can use the Measure-VM or Measure-VMResourcePool cmdlet to obtain this data. - -If resource metering is enabled but no **NetworkAdapterAcls** are configured, Hyper-V configures them to measure total network traffic. -To measure network traffic through an IP range, configure the **NetworkAdapterAcls** for the IP range before calling this cmdlet. -(See Add-VMNetworkAdapterAcl for more information.) - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-VMResourceMetering -VMName TestVM -``` - -This example starts collecting resource utilization data on a virtual machine named TestVM. - -### Example 2 -``` -PS C:\>Get-VM TestVM | Enable-VMResourceMetering -PS C:\>Get-VM TestVM | Format-List Name,ResourceMeteringEnabled -``` - -This example starts collecting resource utilization data on a resource pool named TestResourcePool. -(You can determine whether resource metering is enabled for a resource pool by querying its ResourceMeteringEnabled property.) - -### Example 3 -``` -PS C:\>Enable-VMResourceMetering -ResourcePoolName TestResourcePool -ResourcePoolType Memory PS C:\>Get-VMResourcePool -Name TestResourcePool -ResourcePoolType Memory | Format-List Name,ResourceMeteringEnabled -``` - -This example uses two commands that show resource metering being enabled and then obtain the data. -The first command starts collecting resource utilization data for a memory resource pool named TestResourcePool. -(You can determine whether resource metering is enabled for a resource pool by querying its ResourceMeteringEnabled property.) The second command retrieves the data in and formats it as a list. - -### Example 4 -``` -PS C:\>Enable-VMResourceMetering -Name TestResourcePool -ResourcePoolType @("Processor","VHD","Ethernet","Memory") -``` - -This example begins collecting resource utilization data on multiple resource pools with the name TestResourcePool. - -## PARAMETERS - -### -ComputerName -Specifies the virtual machine host or hosts on which resource utilization data collection is to be enabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the friendly name of the resource pool for which you want to collect resource utilization data. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the resource type of the resource pool for which you want to collect resource utilization data. - -```yaml -Type: VMResourcePoolType -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which you want to collect resource utilization data. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the friendly name of the virtual machine for which you want to collect resource utilization data. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -### Microsoft.HyperV.PowerShell.VMResourcePoolType - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Measure-VM](Measure-VM.md) - -[Measure-VMResourcePool](Measure-VMResourcePool.md) - -[Disable-VMResourceMetering](Disable-VMResourceMetering.md) - diff --git a/docset/winserver2012-ps/hyper-v/Enable-VMSwitchExtension.md b/docset/winserver2012-ps/hyper-v/Enable-VMSwitchExtension.md deleted file mode 100644 index 95a68ab9c0..0000000000 --- a/docset/winserver2012-ps/hyper-v/Enable-VMSwitchExtension.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/enable-vmswitchextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-VMSwitchExtension - -## SYNOPSIS -Enables one or more extensions on one or more switches. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-VMSwitchExtension [-Name] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-VMSwitchExtension [-Name] [-VMSwitchName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-VMSwitchExtension [-Name] [-VMSwitch] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Enable-VMSwitchExtension [-VMSwitchExtension] [-ComputerName ] -``` - -## DESCRIPTION -The **Enable-VMSwitchExtension** cmdlet enables one or more extensions on one or more switches. -You can use the Get-VMSystemSwitchExtension cmdlet to enumerate the virtual switch extensions installed on the system. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Enable-VMSwitchExtension -VMSwitchName External -Name "Microsoft Windows Filtering Platform" -``` - -Enables WFP ("Microsoft Windows Filtering Platform") on a virtual switch named External. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which an extension is to be enabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch on which the extension is to be enabled. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtension -Specifies the extension to be disabled. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchName -Specifies the name of the switch on which the extension is to be enabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network extension to be enabled. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.PowerShell.NetworkExtension - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Export-VM.md b/docset/winserver2012-ps/hyper-v/Export-VM.md deleted file mode 100644 index 3954f6bf71..0000000000 --- a/docset/winserver2012-ps/hyper-v/Export-VM.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/export-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-VM - -## SYNOPSIS -Exports a virtual machine to disk. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Export-VM [-Name] [-Path] [-AsJob] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Export-VM [-VM] [-Path] [-AsJob] [-Passthru] -``` - -## DESCRIPTION -The **Export-VM** cmdlet exports a virtual machine to disk. -This cmdlet creates a folder at a specified location having three subfolders: Snapshots, Virtual Hard Disks, and Virtual Machines. -Each of these folders contains the associated files. The Snapshots folder contains the associated Snapshots, and the Virtual Hard Disk folder contains the specified virtual machine's virtual disks. -The Virtual Machines folder contains the configuration XML of the specified virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Export-VM -Name Test -Path D:\ -``` - -Exports virtual machine Test to the root of the D drive. - -### Example 2 -``` -PS C:\>Get-VM | Export-VM -Path D:\ -``` - -Exports all virtual machines to the root of the D drive. -Each virtual machine will be exported to its own folder. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be exported. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be exported. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VirtualMachine** object is to be passed through to the pipeline representing the virtual machine to be exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the folder into which the virtual machine is to be exported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VM -Specifies the virtual machine to be exported. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Export-VMSnapshot.md b/docset/winserver2012-ps/hyper-v/Export-VMSnapshot.md deleted file mode 100644 index 2643e9241f..0000000000 --- a/docset/winserver2012-ps/hyper-v/Export-VMSnapshot.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/export-vmsnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-VMSnapshot - -## SYNOPSIS -Exports a virtual machine snapshot to disk. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Export-VMSnapshot [-Name] [-Path] [-AsJob] [-ComputerName ] [-Passthru] - -VMName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Export-VMSnapshot [-VM] [-Path] [-AsJob] [-Passthru] [-Name] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Export-VMSnapshot [-VMSnapshot] [-Path] [-AsJob] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Export-VMSnapshot** cmdlet exports a virtual machine snapshot to disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Export-VMSnapshot -Name 'Base Image' -VMName TestVM -Path D:\ -``` - -Exports snapshot Base Image of virtual machine TestVM to D:\. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine snapshot is to be exported. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the snapshot to be exported. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMSnapshot** object is to be passed through to the pipeline representing the snapshot to be exported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the folder into which the snapshot is to be exported. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine of which the snapshot is to be exported. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine of which the snapshot is to be exported. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the snapshot to be exported. - -```yaml -Type: VMSnapshot[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.Snapshot -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VHD.md b/docset/winserver2012-ps/hyper-v/Get-VHD.md deleted file mode 100644 index 29fa31648e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VHD.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VHD - -## SYNOPSIS -Gets the virtual hard disk object associated with a virtual hard disk. - -## SYNTAX - -### Path (default) -``` -Get-VHD [-Path] [-ComputerName ] -``` - -### Disk -``` -Get-VHD [-DiskNumber] [-ComputerName ] -``` - -### VMId -``` -Get-VHD [-VMId] [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VHD** cmdlet gets the virtual hard disk object associated with a virtual hard disk. - -> [!Note] -> When the VHD is in use (for example by a VM or mounted in the OS) and it is on shared storage, the **Get-VHD** cmdlet can only access it from the host that is using it. Any other server trying to run the **Get-VHD** cmdlet will get an error that it is in use. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Get-VHD -Path C:\test\testvhdx.vhdx -``` - -Gets the virtual hard disk where the path to the virtual hard disk file is `C:\test\testvhdx.vhdx`. - -### Example 2 -```powershell -PS C:\> Get-VHD -DiskNumber 6 -``` - -Gets the virtual hard disk attached to the system with disk number 6. - -### Example 3 -```powershell -PS C:\> Get-VM -VMName TestVM | Select-Object -Property VMId | Get-VHD -``` - -Gets the virtual hard disk objects associated with virtual machine TestVM, using the pipeline feature for the VMId parameter. - -### Example 4 -```powershell -PS C:\> Get-VM -VMName TestVM | Select-Object -Property VMId | Get-VHD -``` - -Gets the virtual hard disk objects associated with virtual machine TestVM using the pipeline feature for the path parameter. - -### Example 5 -```powershell -PS C:\> Get-ChildItem -Path C:\test -Recurse -Include *.vhd, *.vhdx, *.vhds, *.avhd, *.avhdx | Get-VHD -``` - -Gets the virtual hard disk object for all the virtual hard disk files that are contained in the specified directory and its subdirectories. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual hard disk is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskNumber -Specifies the disk number associated with the virtual hard disk to be retrieved. - -```yaml -Type: UInt32 -Parameter Sets: Disk -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual hard disk file of the virtual hard disk to be retrieved. -If a filename or relative path is specified, the path is calculated relative to the current working directory. - -```yaml -Type: String[] -Parameter Sets: Path -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -VMId -Specifies the virtual machine identifier of the virtual machine whose virtual hard disks are to be retrieved. - -```yaml -Type: Guid[] -Parameter Sets: VMId -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VHDObject[] - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VM.md b/docset/winserver2012-ps/hyper-v/Get-VM.md deleted file mode 100644 index ca64724f73..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VM.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VM - -## SYNOPSIS -Gets the virtual machines from one or more Hyper-V hosts. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VM [[-Name] ] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VM [-ClusterObject] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VM [[-Id] ] [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VM** cmdlet gets the virtual machines from one or more Hyper-V hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VM -``` - -This example gets all virtual machines on the local virtual machine host. - -### Example 2 -``` -PS C:\>Get-VM -ComputerName Server1 | Where-Object {$_.State -eq 'Running'} -``` - -This example gets all virtual machines on Hyper-V host Server1 that are running. - -### Example 3 -``` -PS C:\>Get-ClusterGroup | ? {$_.GroupType -eq 'VirtualMachine' } | Get-VM -``` - -This example gets all virtual machines in the cluster to which the local Hyper-V host is joined. - -## PARAMETERS - -### -ClusterObject -Specifies the cluster resource or cluster group of the virtual machine to be retrieved. - -```yaml -Type: PSObject -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the identifier of the virtual machine to be retrieved. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.VirtualMachine - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMBios.md b/docset/winserver2012-ps/hyper-v/Get-VMBios.md deleted file mode 100644 index 4a9b71c56e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMBios.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmbios?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMBios - -## SYNOPSIS -Gets the BIOS of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMBios [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMBios [-VM] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMBios [-VMSnapshot] -``` - -## DESCRIPTION -The **Get-VMBios** cmdlet gets the BIOS of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMBios TestVM -``` - -Gets the BIOS object for virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the BIOS of a virtual machine or snapshot is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose BIOS is to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose BIOS is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the virtual machine snapshot whose BIOS is to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.Bios - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMComPort.md b/docset/winserver2012-ps/hyper-v/Get-VMComPort.md deleted file mode 100644 index 93e114e881..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMComPort.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmcomport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMComPort - -## SYNOPSIS -Gets the COM ports of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMComPort [-VMName] [[-Number] ] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMComPort [-VM] [[-Number] ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMComPort [-VMSnapshot] [[-Number] ] -``` - -## DESCRIPTION -The **Get-VMComPort** cmdlet gets the COM ports of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMComPort TestVM -``` - -Gets all COM ports associated with virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VMComPort TestVM -Number 2 -``` - -Gets the second COM port associated with virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the COM ports of a virtual machine or snapshot are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Number -Specifies the Id (1 or 2) of the COM ports to be retrieved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose COM ports are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose COM ports are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose COM ports are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.ComPort - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMConnectAccess.md b/docset/winserver2012-ps/hyper-v/Get-VMConnectAccess.md deleted file mode 100644 index 6ad7343deb..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMConnectAccess.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmconnectaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMConnectAccess - -## SYNOPSIS -Gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMConnectAccess [[-VMName] ] [-ComputerName ] [-UserName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMConnectAccess [-VMId] [-ComputerName ] [-UserName ] -``` - -## DESCRIPTION -The **Get-VMConnectAccess** cmdlet gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts. -This cmdlet is intended for use in providing other applications with the appropriate permissions required to initiate a session with Virtual Machine Connection. -Examples of such applications are Virtual Machine Manager. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMConnectAccess -``` - -This command gets a list of all the users who have access to connect to any virtual machine on the local computer. -The example assumes that the Grant-VMConnectAccess has been run previously for at least one user account. - -### Example 2 -``` -PS C:\>Get-VMConnectAccess -VMName VM1 -``` - -This command gets a list of all the users who have access to connect to virtual machine VM1. -The example assumes that the Grant-VMConnectAccess has been run previously for at least one user account for virtual machine VM1. - -### Example 3 -``` -PS C:\>Get-VMConnectAccess -UserName CONTOSO\John -``` - -This command gets a list of all the virtual machines on the local computer that user Contoso\John has access to connect to. -The example assumes that the Grant-VMConnectAccess has been run previously to grant access to Contoso\John. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts on which connect access entries are being sought. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the user or users for whom connect access entries are being sought, in one of the following forms: - -Local User Account: - john - ComputerName\john - - -Domain User Account: - CONTOSO\john - Contoso.com\john - - -User Principal Name (UPN): - john@contoso.com - - -Security Identifier: - S-1-5-21-3165297888-301567370-576410423-1103 - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMId -Specifies the unique identifier of a virtual machine for which connect access entries are being sought. - -```yaml -Type: Guid[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which connect access entries are being sought. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.VMConnectAce - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMDvdDrive.md b/docset/winserver2012-ps/hyper-v/Get-VMDvdDrive.md deleted file mode 100644 index a1393ef758..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMDvdDrive.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmdvddrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMDvdDrive - -## SYNOPSIS -Gets the DVD drives attached to a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMDvdDrive [-VMName] [-ComputerName ] [-ControllerLocation ] - [-ControllerNumber ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMDvdDrive [-VM] [-ControllerLocation ] [-ControllerNumber ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMDvdDrive [-VMSnapshot] [-ControllerLocation ] [-ControllerNumber ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMDvdDrive [-VMDriveController] [-ControllerLocation ] -``` - -## DESCRIPTION -The **Get-VMDvdDrive** cmdlet gets the DVD drives attached to a virtual machine or snapshot. -This cmdlet has no ControllerType parameter, as the Get-VMHardDiskDrive cmdlet does, because virtual DVD drives can be attached only to the IDE controller. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMDvdDrive -VMName Test -``` - -Gets the virtual DVD drives from virtual machine Test. - -### Example 2 -``` -PS C:\>Get-VM -Name Test | Get-VMDvdDrive -ControllerNumber 1 -``` - -Gets the virtual DVD drives from IDE controller 1 of virtual machine Test. - -### Example 3 -``` -PS C:\>Get-VMIdeController -VMName TestVM -ControllerNumber 1 -ComputerName Development | Get-VMDvdDrive -``` - -Gets the virtual DVD drives from IDE controller 1 of virtual machine TestVM located on Hyper-V server Development. - -### Example 4 -``` -PS C:\>Get-VMSnapshot -VMName TestVM -Name 'Before applying updates' | Get-VMDvdDrive -``` - -Gets the virtual DVD drives from snapshot Before applying updates of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the DVD drives are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller from which the DVD drives are to be retrieved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller from which the DVD drives are to be retrieved. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which the DVD drives are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMDriveController -Specifies the controller from which the DVD drives are to be retrieved. - -```yaml -Type: VMDriveController[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the DVD drives are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the virtual machine snapshot from which the DVD drives are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VMDriveController[] - -### Microsoft.HyperV.PowerShell.VMSnapshot - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.DvdDrive - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMFibreChannelHba.md b/docset/winserver2012-ps/hyper-v/Get-VMFibreChannelHba.md deleted file mode 100644 index 9a91b31088..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMFibreChannelHba.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmfibrechannelhba?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMFibreChannelHba - -## SYNOPSIS -Gets the Fibre Channel host bus adapters associated with one or more virtual machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMFibreChannelHba [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMFibreChannelHba [-VM] -``` - -## DESCRIPTION - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMFibreChannelHba -VMName MyVM -``` - -Gets the Fibre Channel host bus adapters associated with the virtual machine MyVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the Fibre Channel host bus adapters are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies a virtual machine or machines for which the Fibre Channel host bus adapters are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the friendly name or names of the virtual machines for which the Fibre Channel host bus adapters are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMFloppyDiskDrive.md b/docset/winserver2012-ps/hyper-v/Get-VMFloppyDiskDrive.md deleted file mode 100644 index 8d6cf91146..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMFloppyDiskDrive.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmfloppydiskdrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMFloppyDiskDrive - -## SYNOPSIS -Gets the floppy disk drives of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMFloppyDiskDrive [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMFloppyDiskDrive [-VM] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMFloppyDiskDrive [-VMSnapshot] -``` - -## DESCRIPTION -The **Get-VMFloppyDiskDrive** cmdlet gets the floppy disk drives of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMFloppyDiskDrive TestVM -``` - -Gets the floppy disk drive for virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which floppy disk drives are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose floppy disk drives are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose floppy disk drives are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose floppy disk drives are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.FloppyDiskDrive - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMHardDiskDrive.md b/docset/winserver2012-ps/hyper-v/Get-VMHardDiskDrive.md deleted file mode 100644 index bbc42ddda1..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMHardDiskDrive.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmharddiskdrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMHardDiskDrive - -## SYNOPSIS -Gets the virtual hard disk drives attached to one or more virtual machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMHardDiskDrive [-VMName] [-ComputerName ] [-ControllerLocation ] - [-ControllerNumber ] [-ControllerType ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMHardDiskDrive [-VM] [-ControllerLocation ] [-ControllerNumber ] - [-ControllerType ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMHardDiskDrive [-VMSnapshot] [-ControllerLocation ] [-ControllerNumber ] - [-ControllerType ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMHardDiskDrive [-VMDriveController] [-ControllerLocation ] -``` - -## DESCRIPTION -The **Get-VMHardDiskDrive** cmdlet gets the virtual hard disk drives attached to one or more virtual machines. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMHardDiskDrive -VMName TestVM -``` - -Gets the virtual hard drives from virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM -Name TestVM | Get-VMHardDiskDrive -ControllerType IDE -ControllerNumber 1 -``` - -Gets the virtual hard drives from IDE controller 1 of virtual machine TestVM. - -### Example 3 -``` -PS C:\>Get-VMIdeController -VMName TestVM -ControllerNumber 1 -ComputerName Development | Get-VMHardDiskDrive -``` - -Gets the virtual hard drives from IDE controller 1 of virtual machine TestVM located on Hyper-V host Development. - -### Example 4 -``` -PS C:\>Get-VMSnapshot -VMName Test -Name 'Before applying updates' | Get-VMHardDrive -``` - -Gets the virtual hard drives from snapshot Before applying updates of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the virtual hard disk drives are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller at which the virtual hard disk drives are to be retrieved. -If not specified, the number of the first available location on the controller is used. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller at which the virtual hard disk drives are to be retrieved. -If not specified, the first controller on which the specified **ControllerLocation** is available is used. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerType -Specifies the type of the controller from which the virtual hard disk drives are to be retrieved. -Allowed values are **IDE** and **SCSI**. - -```yaml -Type: ControllerType -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which the virtual hard disk drives are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMDriveController -Specifies the drive controller from which the virtual hard disk drives are to be retrieved. - -```yaml -Type: VMDriveController[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the virtual hard disks drives are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the snapshot from which the virtual hard disk drives are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.ControllerType - -### Microsoft.HyperV.PowerShell.VMSnapshot - -### Microsoft.HyperV.PowerShell.VMDriveController[] - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.HardDiskDrive - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMHost.md b/docset/winserver2012-ps/hyper-v/Get-VMHost.md deleted file mode 100644 index 56e2099745..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMHost.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhost?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMHost - -## SYNOPSIS -Gets a Hyper-V host. - -## SYNTAX - -``` -Get-VMHost [[-ComputerName] ] -``` - -## DESCRIPTION -The **Get-VMHost** cmdlet gets a Hyper-V host. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMHost -``` - -Gets the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.Host - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMHostNumaNode.md b/docset/winserver2012-ps/hyper-v/Get-VMHostNumaNode.md deleted file mode 100644 index d637fa7143..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMHostNumaNode.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostnumanode?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMHostNumaNode - -## SYNOPSIS -Gets the NUMA topology of a virtual machine host. - -## SYNTAX - -``` -Get-VMHostNumaNode [[-ComputerName] ] [-Id ] -``` - -## DESCRIPTION -The **Get-MVHostNumaNode** cmdlet gets the NUMA topology of a Hyper-V host, returning a **VMHostNumaNode** object for each of the host's NUMA nodes. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMHostNumaNode -``` - -Gets the NUMA topology of the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts for which the NUMA topology is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Identifies a NUMA node for which a **VMHostNumaNode** is to be retrieved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMHostNumaNodeStatus.md b/docset/winserver2012-ps/hyper-v/Get-VMHostNumaNodeStatus.md deleted file mode 100644 index eb7d86cbd6..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMHostNumaNodeStatus.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmhostnumanodestatus?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMHostNumaNodeStatus - -## SYNOPSIS -Gets the status of the virtual machines on the non-uniform memory access (NUMA) nodes of a virtual machine host or hosts. - -## SYNTAX - -``` -Get-VMHostNumaNodeStatus [[-ComputerName] ] [-Id ] -``` - -## DESCRIPTION -Gets the status of the virtual machines on the non-uniform memory access (NUMA) nodes of a virtual machine host or hosts. -If the virtual machine host enables NUMA spanning, this cmdlet returns an error. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMHostNumaNodeStatus -``` - -Gets the status of the virtual machines on the non-uniform memory access (NUMA) nodes of the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which NUMA node status is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Id -Identifies a NUMA node for which virtual machine status is to be retrieved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMNumaNodeStatus[] - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMIdeController.md b/docset/winserver2012-ps/hyper-v/Get-VMIdeController.md deleted file mode 100644 index 5a9363b75f..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMIdeController.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmidecontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMIdeController - -## SYNOPSIS -Gets the IDE controllers of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMIdeController [-VMName] [[-ControllerNumber] ] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMIdeController [-VM] [[-ControllerNumber] ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMIdeController [-VMSnapshot] [[-ControllerNumber] ] -``` - -## DESCRIPTION -The **Get-VMIdeController** cmdlet gets the IDE controllers of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMIdeController TestVM -``` - -Gets all IDE controllers belonging to virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VMIdeController TestVM -ControllerNumber 0 -``` - -Gets the first IDE controller belonging to virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the IDE controllers of a virtual machine or snapshot are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the IDE controller to be retrieved. -Allowed values are 0 and 1. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose IDE controllers are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose IDE controllers are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose IDE controllers are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.IDEController - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMIntegrationService.md b/docset/winserver2012-ps/hyper-v/Get-VMIntegrationService.md deleted file mode 100644 index 2ccb5267a7..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMIntegrationService.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmintegrationservice?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMIntegrationService - -## SYNOPSIS -Gets the integration services of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMIntegrationService [-VMName] [[-Name] ] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMIntegrationService [-VM] [[-Name] ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMIntegrationService [-VMSnapshot] [[-Name] ] -``` - -## DESCRIPTION -The **Get-VMIntegrationService** cmdlet gets the integration services of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMIntegrationService -VMName TestVM | Where-Object {$_.SecondaryOperationalStatus -eq 'ProtocolMismatch'} -``` - -Gets the out-of-date integration services from virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM -Name TestVM | Get-VMIntegrationService -Name Shutdown,VSS -``` - -Gets the Shutdown and VSS integration services from virtual machine TestVM. - -### Example 3 -``` -PS C:\>Get-VMSnapshot -VMName TestVM -Name 'Before applying updates' | Get-VMIntegrationService Shutdown,VSS -``` - -Gets the Shutdown and VSS integration services from the snapshot Before applying updates of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the integration services are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the integration service to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VM -Specifies the virtual machine from which the integration services are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the integration services are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot from which the integration services are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.PowerShell.IntegrationService - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMMemory.md b/docset/winserver2012-ps/hyper-v/Get-VMMemory.md deleted file mode 100644 index 3c371227ed..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMMemory.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmmemory?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMMemory - -## SYNOPSIS -Gets the memory of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMMemory [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMMemory [-VM] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMMemory [-VMSnapshot] -``` - -## DESCRIPTION -The **Get-VMMemory** cmdlet gets the memory of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMMemory TestVM -``` - -Gets the memory object for virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the memory of a virtual machine or snapshot is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose memory is to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose memory is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose memory is to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.Memory - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMMigrationNetwork.md b/docset/winserver2012-ps/hyper-v/Get-VMMigrationNetwork.md deleted file mode 100644 index 28aaa58635..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMMigrationNetwork.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmmigrationnetwork?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMMigrationNetwork - -## SYNOPSIS -Gets the networks added for migration to one or more virtual machine hosts. - -## SYNTAX - -``` -Get-VMMigrationNetwork [[-Subnet] ] [-ComputerName ] [-Priority ] -``` - -## DESCRIPTION -The **Get-VMMigrationNetwork** cmdlet gets the networks added for migration to one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMMigrationNetwork -``` - -Gets all networks added for migration to the local virtual machine host. - -### Example 2 -``` -PS C:\>Get-VMMigrationNetwork -Priority 8 -``` - -Gets all networks added for migration to the local virtual machine host having a priority of 8. - -### Example 3 -``` -PS C:\>Get-VMMigrationNetwork 192.168.* -``` - -Gets all networks added for migration having a subnet starting with 192.168. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the networks added for migration are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Priority -Specifies the priority of the networks to be retrieved. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a string representing an IPv4 or IPv6 subnet mask which identifies the networks to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.MigrationNetwork - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapter.md deleted file mode 100644 index 4e144f39b5..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapter.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMNetworkAdapter - -## SYNOPSIS -Gets the virtual network adapters of a virtual machine, snapshot, management OS, or of a virtual machine and management OS. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMNetworkAdapter [-VMName] [[-Name] ] [-ComputerName ] [-IsLegacy ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMNetworkAdapter [[-Name] ] [-All] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMNetworkAdapter [[-Name] ] [-ComputerName ] [-SwitchName ] [-ManagementOS] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMNetworkAdapter [-VM] [[-Name] ] [-IsLegacy ] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-VMNetworkAdapter [-VMSnapshot] [[-Name] ] -``` - -## DESCRIPTION -The **Get-VMNetworkAdapter** cmdlet gets the virtual network adapters of the specified virtual machine, snapshot, or management OS. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMNetworkAdapter -VMName * -``` - -Gets virtual network adapters from all virtual machines on the local Hyper-V host. - -### Example 2 -``` -PS C:\>Get-VMNetworkAdapter -ManagementOS -``` - -Gets the virtual network adapters in the ManagementOS (i.e. -the local Hyper-V host). - -### Example 3 -``` -PS C:\>Get-VMNetworkAdapter -All -``` - -Gets virtual network adapters from all virtual machines as well as the management OS. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on the virtual network adapters are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsLegacy -Specify as **$TRUE** to retrieve only legacy network adapters, or as **$FALSE** to retrieve only synthetic network adapters. -If not specified, virtual network adapters of both types are retrieved. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies the management OS, i.e. -the virtual machine host OS. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter to be retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose virtual network adapters are to be retrieved. -The asterisk, "*", is the wildcard. -If it is specified the cmdlet returns virtual network adapters from every virtual machine in the system. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose network adapters are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose network adapters are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch whose network adapters are to be retrieved. -(This parameter is available only for virtual network adapters in the management OS.) - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -All -Specifies all virtual network adapters in the system, regardless of whether the virtual network adapter is in the management OS or in a virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -**Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** if **ManagementOS** is specified; **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** and **Microsoft.Virtualization.Powershell.VMNetworkAdapter** if **All** is specified;**Microsoft.Virtualization.Powershell.VMNetworkAdapter** in all other cases. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterAcl.md b/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterAcl.md deleted file mode 100644 index a7f6b563f3..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterAcl.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapteracl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMNetworkAdapterAcl - -## SYNOPSIS -Gets the ACLs configured for a virtual machine network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMNetworkAdapterAcl [[-VMName] ] [-ComputerName ] [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMNetworkAdapterAcl [-ComputerName ] [-VMNetworkAdapterName ] [-ManagementOS] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMNetworkAdapterAcl [-VM] [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMNetworkAdapterAcl [-VMNetworkAdapter] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-VMNetworkAdapterAcl [-VMSnapshot] -``` - -## DESCRIPTION -The **Get-VMNetworkAdapterAcl** cmdlet gets the ACLs configured for a virtual machine network adapter. -If an ACL entry is created to be applied to both directions, it will appear under the list of entries for the inbound direction and under the list of entries for the outbound direction in the output from Get-VMNetworkAdapterAcl. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMNetworkAdapterAcl -VMName Redmond -``` - -Gets all the port ACLs configured on virtual machine Redmond. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the ACLs configured for a virtual machine network adapter are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the ACLs are to be configured in the management (i.e. -the parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine in which the ACLs configured for a virtual machine network adapter are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine in which the ACLs configured for a virtual machine network adapter are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter for which the configured ACLs are to be retrieved. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the virtual network adapter name for which the configured ACLs are to be retrieved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the snapshot in which the ACLs configured for a virtual machine network adapter are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterFailoverConfiguration.md b/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterFailoverConfiguration.md deleted file mode 100644 index f9417ecb21..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterFailoverConfiguration.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapterfailoverconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMNetworkAdapterFailoverConfiguration - -## SYNOPSIS -Gets the IP address of a virtual network adapter configured to be used when a virtual machine fails over. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMNetworkAdapterFailoverConfiguration [-VMName] [-ComputerName ] - [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMNetworkAdapterFailoverConfiguration [-VM] [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMNetworkAdapterFailoverConfiguration [-VMNetworkAdapter] -``` - -## DESCRIPTION -The **Get-VMNetworkAdapterFailoverConfiguration** cmdlet gets the IP address configuration of a virtual network adapter configured to be used when a virtual machine fails over. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMNetworkAdapterFailoverConfiguration VM01 -``` - -This example gets the failover IP address configuration of all virtual network adapters attached to a virtual machine named VM01. - -### Example 2 -``` -PS C:\>Get-VMNetworkAdapterFailoverConfiguration VM01 -VMNetworkAdapterName NetworkAdapter -``` - -This example gets the failover IP address configuration of a virtual network adapter named NetworkAdapter on a virtual machine named VM01. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the IP address configuration of a virtual network adapter is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which you want to get the IP address configuration of a virtual network adapter. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which you want to get the IP address configuration of a virtual network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter whose IP address configuration you want to get. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter whose IP address configuration you want to get. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMNetworkAdapterFailoverConfiguration - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterVlan.md b/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterVlan.md deleted file mode 100644 index 475c94611b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMNetworkAdapterVlan.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmnetworkadaptervlan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMNetworkAdapterVlan - -## SYNOPSIS -Gets the virtual LAN settings configured on a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMNetworkAdapterVlan [[-VMName] ] [-ComputerName ] [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMNetworkAdapterVlan [-ComputerName ] [-VMNetworkAdapterName ] [-ManagementOS] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMNetworkAdapterVlan [-VM] [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMNetworkAdapterVlan [-VMNetworkAdapter] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-VMNetworkAdapterVlan [-VMSnapshot] -``` - -## DESCRIPTION -The** Get-VMNetworkAdapterVlan** cmdlet gets the virtual LAN settings configured on a virtual network adapter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMNetworkAdapterVlan -``` - -Gets the virtual LAN settings for each virtual network adapter in all virtual machines on the system. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual LAN settings configured on a virtual network adapter are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the virtual LAN settings are to be retrieved from the management (i.e. -parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine in which the virtual LAN settings configured on a virtual network adapter are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine in which the virtual LAN settings configured on a virtual network adapter are to be retrieved. - -Friendly name of the virtual machine - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter for which the virtual LAN settings are to be retrieved. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter for which the virtual LAN settings are to be retrieved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the snapshot in which the virtual LAN settings are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMProcessor.md b/docset/winserver2012-ps/hyper-v/Get-VMProcessor.md deleted file mode 100644 index 1a34b78d94..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMProcessor.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmprocessor?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMProcessor - -## SYNOPSIS -Gets the processor of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMProcessor [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMProcessor [-VM] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMProcessor [-VMSnapshot] -``` - -## DESCRIPTION -The **Get-VMProcessor** cmdlet gets the processor of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMProcessor TestVM -``` - -Gets the processor object for virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the processor of a virtual machine or snapshot is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose processor is to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose processor is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSnapshot -Specifies the snapshot whose processor is to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.Processor - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMRemoteFXPhysicalVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Get-VMRemoteFXPhysicalVideoAdapter.md deleted file mode 100644 index 7cc230174c..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMRemoteFXPhysicalVideoAdapter.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmremotefxphysicalvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMRemoteFXPhysicalVideoAdapter - -## SYNOPSIS -Gets the RemoteFX physical graphics adapters on one or more Hyper-V hosts. - -## SYNTAX - -``` -Get-VMRemoteFXPhysicalVideoAdapter [[-Name] ] [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VMRemoteFXPhysicalVideoAdapter** cmdlet gets the RemoteFX physical graphics adapters on one or more Hyper-V hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMRemoteFXPhysicalVideoAdapter -``` - -Gets all RemoteFX physical video adapters on the Hyper-V host. - -### Example 2 -``` -PS C:\>Get-VMRemoteFXPhysicalVideoAdapter -Name *Nvidia* -``` - -Gets all RemoteFX physical video adapters on the Hyper-V host which include the sequence Nvidia in their name. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the RemoteFX physical graphics adapters are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the names of one or more RemoteFX physical graphics adapters to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.HyperV.PowerShell.VMRemoteFXPhysicalVideoAdapter[] - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMRemoteFx3dVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Get-VMRemoteFx3dVideoAdapter.md deleted file mode 100644 index f3a35b466b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMRemoteFx3dVideoAdapter.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmremotefx3dvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMRemoteFx3dVideoAdapter - -## SYNOPSIS -Gets the RemoteFX video adapter of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMRemoteFx3dVideoAdapter [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMRemoteFx3dVideoAdapter [-VM] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMRemoteFx3dVideoAdapter [-VMSnapshot] -``` - -## DESCRIPTION -The **Get-VMRemoteFx3dVideoAdapter** cmdlet gets the RemoteFX video adapter of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMRemoteFx3dVideoAdapter -VMName TestVM -``` - -Gets the RemoteFX adapter from virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM -Name TestVM | Get-VMRemoteFx3dVideoAdapter -``` - -Gets the RemoteFx adapter from virtual machine TestVM. - -### Example 3 -``` -PS C:\>Get-VMSnapshot -VMName TestVM -Name 'Before applying updates' | Get-VMRemoteFx3dVideoAdapter -``` - -Gets the RemoteFx adapter from snapshot Before applying updates of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the RemoteFX video adapter is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose RemoteFX video adapter is to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose RemoteFX video adapter is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose RemoteFX video adapter is to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.RemoteFxVideoAdapter - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMReplication.md b/docset/winserver2012-ps/hyper-v/Get-VMReplication.md deleted file mode 100644 index a6ebf813ef..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMReplication.md +++ /dev/null @@ -1,251 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMReplication - -## SYNOPSIS -Gets the replication settings for a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMReplication [[-VMName] ] [-ComputerName ] [-PrimaryServerName ] - [-ReplicaServerName ] [-ReplicationHealth ] - [-ReplicationMode ] [-ReplicationState ] [-TrustGroup ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMReplication [-VM] -``` - -## DESCRIPTION -The **Get-VMReplication** cmdlet gets the replication settings for a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMReplication -``` - -This example gets the replication settings of all replication-enabled virtual machines on the local Hyper-V host. - -### Example 2 -``` -PS C:\>Get-VMReplication VM01 -``` - -This example gets the replication settings of a virtual machine named VM01. - -### Example 3 -``` -PS C:\>Get-VMReplication -ReplicaServerName server01.domain01.contoso.com -``` - -This example gets the replication settings of all virtual machines replicating to server server01.domain01.contoso.com. - -### Example 4 -``` -PS C:\>Get-VMReplication -ReplicationState Replicating -``` - -This example gets the replication settings of all virtual machines in the Replicating state. - -### Example 5 -``` -PS C:\>Get-VMReplication -TrustGroup DEFAULT -``` - -This example gets the replication settings of all virtual machines in a trust group named DEFAULT. - -### Example 6 -``` -PS C:\>Get-VMReplication -ReplicationMode Primary -``` - -This example gets the replication settings of all primary virtual machines on the local host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which virtual machine replication settings are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryServerName -Specifies the primary server of the virtual machines whose replication settings are to be retrieved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: PrimaryServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose replication settings are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose replication settings are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReplicaServerName -Specifies the replica server name of the virtual machines whose replication settings are to be retrieved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ReplicaServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationHealth -Gets replication settings for virtual machines with the specified replication health state. -Valid values are Normal, Warning, and Critical. - -```yaml -Type: VMReplicationHealthState -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Health - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationMode -Gets the replication settings for virtual machines with the specified replication mode. -Valid values are None, Primary, Replica, and TestReplica. - -```yaml -Type: VMReplicationMode -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Mode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationState -Gets replication settings for virtual machines with the specified replication state. -Valid values are: - -Error - -FailOverWaitingCompletion - -FailedOver - -NotApplicable - -ReadyForInitialReplication - -Replicating - -Resynchronizing - -ResynchronizeSuspended - -Suspended - -SyncedReplicationComplete - -WaitingForInitialReplication - -WaitingForStartResynchronize - -```yaml -Type: VMReplicationState -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: State - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustGroup -Specifies the trust group of the virtual machines whose replication settings you want to retrieve. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMReplication - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMReplicationAuthorizationEntry.md b/docset/winserver2012-ps/hyper-v/Get-VMReplicationAuthorizationEntry.md deleted file mode 100644 index d42bda8284..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMReplicationAuthorizationEntry.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmreplicationauthorizationentry?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMReplicationAuthorizationEntry - -## SYNOPSIS -Gets the authorization entries of a Replica server. - -## SYNTAX - -``` -Get-VMReplicationAuthorizationEntry [[-AllowedPrimaryServer] ] [-ComputerName ] - [-ReplicaStorageLocation ] [-TrustGroup ] -``` - -## DESCRIPTION -The **Get-VMReplicationAuthorizationEntry** cmdlet gets the replication authorization entries specified for a Replica server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMReplicationAuthorizationEntry -``` - -This example gets the replication authorization entries for the local Replica server. - -### Example 2 -``` -PS C:\>Get-VMReplicationAuthorizationEntry server01.domain01.contoso.com -``` - -This example gets the replication authorization entry for an allowed primary server named server01.domain01.contoso.com. - -## PARAMETERS - -### -AllowedPrimaryServer -Specifies the allowed primary server for which replication authorization entries are to be retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -ComputerName -Specifies one or more Hyper-V hosts from which replication authorization entries are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaStorageLocation -Specifies the location where virtual hard disk files are stored when an authorized primary server sends replication data to the specified Replica server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -TrustGroup -Gets the replication authorization entries that have the specified value for TrustGroup. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMReplicationAuthorizationEntry - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMReplicationServer.md b/docset/winserver2012-ps/hyper-v/Get-VMReplicationServer.md deleted file mode 100644 index 7bb9877603..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMReplicationServer.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmreplicationserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMReplicationServer - -## SYNOPSIS -Gets the replication and authentication settings of a Replica server. - -## SYNTAX - -``` -Get-VMReplicationServer [[-ComputerName] ] -``` - -## DESCRIPTION -The **Get-VMReplicationServer** cmdlet gets the replication and authentication settings of a Replica server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Get-VMReplicationServer -``` - -This example gets the replication configuration of the local Replica server. - -### Example 2 -``` -PS C:\> Get-VMReplicationServer server01.domain01.contoso.com -``` - -This example gets the replication configuration of a server named server01.domain01.contoso.com. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts for which to retrieve replication and authentication settings. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMReplicationServer - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMResourcePool.md b/docset/winserver2012-ps/hyper-v/Get-VMResourcePool.md deleted file mode 100644 index 0786b85ec1..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMResourcePool.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmresourcepool?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMResourcePool - -## SYNOPSIS -Gets the resource pools on one or more virtual machine hosts. - -## SYNTAX - -``` -Get-VMResourcePool [[-Name] ] [[-ResourcePoolType] ] [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VMResourcePool** cmdlet gets the resource pools on one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMResourcePool * VHD -``` - -Get all VHD resource pools on the local virtual machine host. - -### Example 2 -``` -PS C:\>Get-VMResourcePool Test* -``` - -Get all resource pools on the local virtual machine host having a name that starts with Test. - -### Example 3 -``` -PS C:\>Get-VMResourcePoolTest "test resource pool" VHD -``` - -Get all VHD resource pools on the local virtual machine host named test resource pool. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the resource pools are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource pool or pools to be retrieved. -Wildcards are allowed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -ResourcePoolType -Specifies the type of the resource pool or pools to be retrieved. - -```yaml -Type: VMResourcePoolType[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.ResourcePool - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSan.md b/docset/winserver2012-ps/hyper-v/Get-VMSan.md deleted file mode 100644 index d111178ffc..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSan.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSan - -## SYNOPSIS -Gets the available virtual machine storage area networks on a Hyper-V host or hosts. - -## SYNTAX - -``` -Get-VMSan [[-Name] ] [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VMSan** cmdlet gets the available virtual storage area networks (SANs) on one or more Hyper-V hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSan -Name ProductionSAN -``` - -Gets a virtual storage area network (SAN) named ProductionSAN. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the available virtual machine storage area networks (SANs) are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of a virtual storage area network (SAN) to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMScsiController.md b/docset/winserver2012-ps/hyper-v/Get-VMScsiController.md deleted file mode 100644 index f989178a2d..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMScsiController.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmscsicontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMScsiController - -## SYNOPSIS -Gets the SCSI controllers of a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMScsiController [-VMName] [[-ControllerNumber] ] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMScsiController [-VM] [[-ControllerNumber] ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMScsiController [-VMSnapshot] [[-ControllerNumber] ] -``` - -## DESCRIPTION -The **Get-VMScsiController** cmdlet gets the SCSI controllers of a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMScsiController -VMName TestVM -ControllerNumber 0 -``` - -Gets SCSI controller 0 from virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM -Name TestVM -ComputerName Development | Get-VMScsiController -``` - -Gets the SCSI controllers from virtual machine TestVM on Hyper-V host Development. - -### Example 3 -``` -PS C:\>Get-VMSnapshot -VMName TestVM -Name 'Before applying updates' | Get-VMScsiController -``` - -Gets the SCSI controllers from snapshot Before applying updates of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the SCSI controllers are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the SCSI controller to be retrieved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose SCSI controllers are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose SCSI controllers are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose SCSI controllers are to be retrieved. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.IDEController - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSnapshot.md b/docset/winserver2012-ps/hyper-v/Get-VMSnapshot.md deleted file mode 100644 index aa181b53fc..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSnapshot.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmsnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSnapshot - -## SYNOPSIS -Gets the snapshots associated with a virtual machine or snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSnapshot [[-Name] ] [-SnapshotType ] -ChildOf -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSnapshot [-Id] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMSnapshot [-VMName] [[-Name] ] [-ComputerName ] - [-SnapshotType ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMSnapshot [[-Name] ] [-SnapshotType ] -ParentOf -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-VMSnapshot [-VM] [[-Name] ] [-SnapshotType ] -``` - -## DESCRIPTION -The **Get-VMSnapshot** cmdlet gets the snapshots associated with a virtual machine or snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSnapshot -VMName TestVM -``` - -Gets all snapshots of virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM -Name TestVM | Get-VMSnapshot -SnapshotType Standard -``` - -Gets all standard snapshots of virtual machine TestVM. - -### Example 3 -``` -PS C:\>$snapshot = Get-VMSnapshot -Name 'Before applying updates' -VMName TestVM - - -PS C:\>Get-VMSnapshot -ParentOf $snapshot -``` - -Gets the immediate parent of snapshot Before applying updates of virtual machine TestVM. - -### Example 4 -``` -PS C:\>$snapshot = Get-VMSnapshot -Name 'Before applying updates' -VMName TestVM - - -PS C:\>Get-VMSnapshot -ChildOf $snapshot -``` - -Gets the immediate child snapshots of snapshot Before applying updates of virtual machine TestVM. - -## PARAMETERS - -### -ChildOf -Specifies the snapshot whose child snapshots are to be retrieved. -This retrieves immediate children only. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which snapshots are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique identifier of the virtual machine whose snapshots are to be retrieved. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the snapshot to be retrieved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentOf -Specifies the snapshot whose immediate parent snapshot is to be retrieved. - -```yaml -Type: VirtualMachineBase -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotType -Specifies the type of the snapshots to be retrieved. -Allowed values are **Standard**, **Recovery**, **Planned**, **Missing**, **Replica**, **AppConsistentReplica**, and **SyncedReplica**. - -```yaml -Type: SnapshotType -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose snapshots are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose snapshots are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.Snapshot - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMStoragePath.md b/docset/winserver2012-ps/hyper-v/Get-VMStoragePath.md deleted file mode 100644 index 39dbe93ca7..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMStoragePath.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmstoragepath?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMStoragePath - -## SYNOPSIS -Gets the storage paths in a storage resource pool. - -## SYNTAX - -``` -Get-VMStoragePath [[-Path] ] [-ResourcePoolName] [-ResourcePoolType] - [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VMStoragePath** cmdlet gets the storage paths in a storage resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMStoragePath -ResourcePoolName VHD1 -ResourcePoolType VHD -``` - -Gets the storage paths from virtual hard drive resource pool VHD1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which storage paths are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path for which matching storage paths are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the resource pool for which storage paths are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the type of the resource pool for which storage paths are to be retrieved. -Allowed values are **VFD**, **ISO**, and **VHD**. - -```yaml -Type: VMResourcePoolType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSwitch.md b/docset/winserver2012-ps/hyper-v/Get-VMSwitch.md deleted file mode 100644 index b15be79ca8..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSwitch.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmswitch?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSwitch - -## SYNOPSIS -Gets virtual switches from one or more virtual Hyper-V hosts. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSwitch [[-Name] ] [[-ResourcePoolName] ] [-ComputerName ] - [-SwitchType ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSwitch [[-Id] ] [[-ResourcePoolName] ] [-ComputerName ] - [-SwitchType ] -``` - -## DESCRIPTION -The **Get-VMSwitch** gets the virtual switches from a Hyper-V host. -If you specify no parameters, this cmdlet returns all virtual switches from the local Hyper-V host. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSwitch -``` - -Gets all virtual switches from the local Hyper-V host. - -### Example 2 -``` -PS C:\>Get-VMSwitch -SwitchType External -``` - -Gets all virtual switches that connect to the external network. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which virtual switches are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the unique identifier of the virtual switch to be retrieved. - -```yaml -Type: Guid[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual switch to be retrieved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -ResourcePoolName -Specifies the resource pool from which the virtual switches are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -SwitchType -Specifies the type of the virtual switches to be retrieved. -Allowed values are **External**, **Internal**, and **Private**. - -```yaml -Type: VMSwitchType[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.EthernetSwitch - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtension.md b/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtension.md deleted file mode 100644 index 1a4053c231..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtension.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmswitchextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSwitchExtension - -## SYNOPSIS -Gets the extensions on one or more virtual switches. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSwitchExtension [-VMSwitchName] [[-Name] ] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSwitchExtension [-VMSwitch] [-ComputerName ] -``` - -## DESCRIPTION -The **Get-VMSwitchExtension** cmdlet gets the extensions on one or more virtual switches. -These extensions may be of different types, and may be either enabled or disabled. -Output can be filtered by extension. -The retrieved extension object does not contain embedded objects for features, or an array of feature IDs. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSwitch InternalSwitch | Get-VMSwitchExtension -``` - -Gets all virtual switch extension available to the virtual switch InternalSwitch. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the extensions are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the extension to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSwitch -Specifies the virtual switch from which the extensions are to be retrieved. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchName -Specifies the name of the virtual switch from which the extensions are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.SwitchExtension - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionPortData.md b/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionPortData.md deleted file mode 100644 index c64383240a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionPortData.md +++ /dev/null @@ -1,269 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmswitchextensionportdata?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSwitchExtensionPortData - -## SYNOPSIS -Retrieves the status of a virtual switch extension feature applied to a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSwitchExtensionPortData [-VMName] [-ComputerName ] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSwitchExtensionPortData [-SwitchName] [-ComputerName ] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] [-ExternalPort] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMSwitchExtensionPortData [-ComputerName ] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] - [-VMNetworkAdapterName ] [-ManagementOS] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMSwitchExtensionPortData [-VM] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] - [-VMNetworkAdapterName ] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-VMSwitchExtensionPortData [-VMNetworkAdapter] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] -``` - -## DESCRIPTION -The **Get-VMSwitchExtensionPortData** cmdlet retrieves the status of a virtual switch extension feature applied to a virtual network adapter. -This port feature data surfaces runtime information and statistics on a per-port basis. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSwitchExtensionPortData VM1 -FeatureId eb29f0f2-f5dc-45c6-81bb-3cd9f219bbbb -``` - -Gets the port feature data with ID eb29f0f2-f5dc-45c6-81bb-3cd9f219bbbb from the sample forwarding extension on the virtual network adapter in virtual machine VM1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the status of a virtual switch extension applied to a virtual network adapter is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the virtual switch extension for which status is to be retrieved. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -Specifies the name of the virtual switch extension for which status is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalPort -Specifies the virtual switch port connected to the external network interface card. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureId -Specifies the unique identifier of the feature supported by the virtual switch extension. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature supported by the virtual switch extension. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the status is to be retrieved from the management (i.e. -parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the status to be retrieved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual machine network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionPortFeature.md b/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionPortFeature.md deleted file mode 100644 index 72ab98219f..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionPortFeature.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmswitchextensionportfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSwitchExtensionPortFeature - -## SYNOPSIS -Gets the features configured on a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSwitchExtensionPortFeature [-VMName] [-ComputerName ] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] [-VMNetworkAdapterName ] -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSwitchExtensionPortFeature [-SwitchName] [-ComputerName ] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] [-ExternalPort] -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-VMSwitchExtensionPortFeature [-ComputerName ] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] - [-VMNetworkAdapterName ] [-ManagementOS] -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-VMSwitchExtensionPortFeature [-VM] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] - [-VMNetworkAdapterName ] -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-VMSwitchExtensionPortFeature [-VMNetworkAdapter] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] -VMSwitchExtensionFeature -``` - -## DESCRIPTION -The **Get-VMSwitchExtensionPortFeature** cmdlet gets the features configured on a virtual network adapter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSwitchExtensionPortFeature -VMName VM2 -FeatureName "Ethernet Switch Port Security Settings" -``` - -Gets the feature configured on virtual machine VM2 by name Ethernet Switch Port Security Settings. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts on which the features configured on a virtual network adapter are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the virtual switch extension. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -Specifies the name of the virtual switch extension. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalPort -Specifies the virtual switch port connected to the external network interface card. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureId -Specifies the unique identifier of the feature supported by the virtual switch extension. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature supported by the virtual switch extension. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the features are to be retrieved from the management (i.e. -parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the features configured on a virtual switch. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the features configured on a virtual switch are to be retrieved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the features configured on a virtual switch are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the network adapter. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature - - -```yaml -Type: VMSwitchExtensionPortFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionSwitchData.md b/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionSwitchData.md deleted file mode 100644 index 9933ae598a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionSwitchData.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmswitchextensionswitchdata?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSwitchExtensionSwitchData - -## SYNOPSIS -Gets the status of a virtual switch extension feature applied on a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSwitchExtensionSwitchData [-SwitchName] [-ComputerName ] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSwitchExtensionSwitchData [-VMSwitch] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] - -VMSwitchExtensionFeature -``` - -## DESCRIPTION -The **Get-VMSwitchExtensionSwitchData** cmdlet gets the status of a virtual switch extension applied on a virtual switch. -This switch feature data surfaces runtime information and statistics on a per-switch basis. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSwitchExtensionSwitchData External -FeatureId 1c37e01c-0cd6-496f-9076-90c131033dc2 -``` - -Gets the switch data from a virtual switch extension that is configured on virtual switch External. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the status of a virtual switch extension is to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the virtual switch extension for which status is to be retrieved. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -Specifies the name of the virtual switch extension for which status is to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureId -Specifies the unique identifier of a feature supported by the virtual switch extension. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of a feature supported by the virtual switch extension. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an **Microsoft.Virtualization.PowerShell.VMSwitchExtensionSwitchData** object is to be passed through to the pipeline representing the virtual switch extension status. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the virtual switch extension feature. - -```yaml -Type: VMSwitchExtensionSwitchFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionSwitchFeature.md b/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionSwitchFeature.md deleted file mode 100644 index 249ed81a75..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSwitchExtensionSwitchFeature.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmswitchextensionswitchfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSwitchExtensionSwitchFeature - -## SYNOPSIS -Gets the features configured on a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-VMSwitchExtensionSwitchFeature [-SwitchName] [-ComputerName ] - [-Extension ] [-ExtensionName ] [-FeatureId ] [-FeatureName ] - [-Passthru] -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-VMSwitchExtensionSwitchFeature [-VMSwitch] [-Extension ] - [-ExtensionName ] [-FeatureId ] [-FeatureName ] [-Passthru] - -VMSwitchExtensionFeature -``` - -## DESCRIPTION -The **Get-VMSwitchExtensionSwitchFeature** cmdlet gets the features configured on a virtual switch. -The object can be used to update the configuration of the switch using the Set-VmSwitchExtensionFeature command. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSwitchExtensionSwitchFeature -``` - -ps_miss_tech_content - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the features configured on a virtual switch are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extension -Specifies the virtual switch extension. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -Specifies the name of the virtual switch extension. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureId -Specifies the unique identifier of the feature. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.HyperV.PowerShell.VMSwitchExtensionSwitchFeature** object is to be passed through to the pipeline representing the features to be retrieved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be retrieved. - -```yaml -Type: VMSwitchExtensionSwitchFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtension.md b/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtension.md deleted file mode 100644 index 5a7d09d622..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtension.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmsystemswitchextension?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSystemSwitchExtension - -## SYNOPSIS -Gets the switch extensions installed on a virtual machine host. - -## SYNTAX - -``` -Get-VMSystemSwitchExtension [-ComputerName ] [-Name ] -``` - -## DESCRIPTION -The **Get-VMSystemSwitchExtension** cmdlet gets the switch extensions installed on a virtual machine host. -The returned switch extension does not contain embedded objects for features or an array of feature IDs. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSystemSwitchExtension -``` - -Gets all virtual switch extensions installed on the system. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the switch extensions are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the switch extension to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.SystemSwitchExtension - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtensionPortFeature.md b/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtensionPortFeature.md deleted file mode 100644 index d178c3a501..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtensionPortFeature.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmsystemswitchextensionportfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSystemSwitchExtensionPortFeature - -## SYNOPSIS -Gets the port-level features supported by virtual switch extensions on one or more Hyper-V hosts. - -## SYNTAX - -``` -Get-VMSystemSwitchExtensionPortFeature [-ComputerName ] [-ExtensionName ] - [-FeatureId ] [-FeatureName ] [-SystemSwitchExtension ] -``` - -## DESCRIPTION -The **Get-VMSystemSwitchExtensionPortFeature** cmdlet gets the port-level features supported by virtual switch extensions on one or more Hyper-V hosts. -The returned feature object will contain default values for the feature. -The object can be used to apply the configuration on specific ports using the Add-VmSwitchExtensionPortFeature command. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSystemSwitchExtensionPortFeature -``` - -Gets all port-level features, supported by various virtual switch extensions installed on the system, that can be configured on a virtual network adapter on Hyper-V. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the available port-level features are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -Specifies one or more extension names for which the features are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureId -Specifies the unique identifier of the feature to be retrieved. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the feature to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemSwitchExtension -Specifies one or more system extensions for which the features are to be retrieved. - -```yaml -Type: VMSystemSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtensionSwitchFeature.md b/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtensionSwitchFeature.md deleted file mode 100644 index 729e583f6a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Get-VMSystemSwitchExtensionSwitchFeature.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/get-vmsystemswitchextensionswitchfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-VMSystemSwitchExtensionSwitchFeature - -## SYNOPSIS -Gets the switch-level features on one or more Hyper-V hosts. - -## SYNTAX - -``` -Get-VMSystemSwitchExtensionSwitchFeature [-ComputerName ] [-ExtensionName ] - [-FeatureId ] [-FeatureName ] [-SystemSwitchExtension ] -``` - -## DESCRIPTION -The **Get-VMSystemSwitchExtensionSwitchFeature** cmdlet gets the switch-level features supported by virtual switch extensions in an extension on one or more Hyper-V hosts. -The returned feature object will contain default values for the feature. -The object can be used to apply the configuration on specific ports using the Add-VMSwitchExtensionFeature cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSystemSwitchExtensionSwitchFeature -``` - -Gets all virtual switch extensions that support switch level features that can be configured on a virtual switch. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the switch-level features in an extension are to be retrieved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExtensionName -Specifies the name of the extension from which the switch-level features are to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureId -Specifies the unique identifier of the features are to be retrieved. - -```yaml -Type: Guid[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FeatureName -Specifies the name of the switch-level features to be retrieved. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SystemSwitchExtension -Specifies the extension from which the switch-level features are to be retrieved. - -```yaml -Type: VMSystemSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Grant-VMConnectAccess.md b/docset/winserver2012-ps/hyper-v/Grant-VMConnectAccess.md deleted file mode 100644 index b00cfdd7b3..0000000000 --- a/docset/winserver2012-ps/hyper-v/Grant-VMConnectAccess.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/grant-vmconnectaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Grant-VMConnectAccess - -## SYNOPSIS -Grants a user or users access to connect to a virtual machine or machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Grant-VMConnectAccess [-VMName] [-UserName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Grant-VMConnectAccess [-VMId] [-UserName] [-ComputerName ] [-Passthru] -``` - -## DESCRIPTION -The **Grant-VMConnectAccess** cmdlet grants access to a user or users to connect to a virtual machine or machines. -The cmdlet is intended for use in providing other applications with the appropriate permissions required to initiate a session with Virtual Machine Connection. -Examples of such applications are Virtual Machine Manager. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Grant-VMConnectAccess -VMName VM1 -UserName Contoso\John -``` - -This command grants user Contoso\John access to connect to a virtual machine named VM1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which access to connect to a virtual machine is to be granted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMConnectAce** object is to be passed through to the pipeline representing each grant of access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies a user or users to whom access to connect to a virtual machine or machines is to be granted, in one of the following forms: - -Local User Account: - john - ComputerName\john - - -Domain User Account: - CONTOSO\john - Contoso.com\john - - -User Principal Name (UPN): - john@contoso.com - - -Security Identifier: - S-1-5-21-3165297888-301567370-576410423-1103 - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMId -Specifies the unique identifier of a virtual machine to which connect access is to be granted. - -```yaml -Type: Guid[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of a virtual machine to which connect access is to be granted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMConnectAce -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Hyper-V.md b/docset/winserver2012-ps/hyper-v/Hyper-V.md deleted file mode 100644 index de1be81d08..0000000000 --- a/docset/winserver2012-ps/hyper-v/Hyper-V.md +++ /dev/null @@ -1,510 +0,0 @@ ---- -description: Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.5.0.0 -Locale: en-US -Module Guid: af4bddd0-8583-4ff2-84b2-a33f5c8de8a7 -Module Name: Hyper-V -ms.date: 10/30/2017 -title: Hyper-V ---- -# Hyper-V Module - -## Description - -This reference provides cmdlet descriptions and syntax for all Hyper-V-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## Hyper-V Cmdlets - -### [Add-VMDvdDrive](./Add-VMDvdDrive.md) -Adds a DVD drive to a virtual machine. - -### [Add-VMFibreChannelHba](./Add-VMFibreChannelHba.md) -Adds a virtual Fibre Channel host bus adapter to a virtual machine. - -### [Add-VMHardDiskDrive](./Add-VMHardDiskDrive.md) -Adds a hard disk drive to a virtual machine. - -### [Add-VMMigrationNetwork](./Add-VMMigrationNetwork.md) -Adds a network for virtual machine migration on one or more virtual machine hosts. - -### [Add-VMNetworkAdapterAcl](./Add-VMNetworkAdapterAcl.md) -Creates an ACL to apply to the traffic through a virtual machine network adapter. - -### [Add-VMNetworkAdapter](./Add-VMNetworkAdapter.md) -Adds a virtual network adapter to a virtual machine. - -### [Add-VMRemoteFx3dVideoAdapter](./Add-VMRemoteFx3dVideoAdapter.md) -Adds a RemoteFX video adapter in a virtual machine. - -### [Add-VMScsiController](./Add-VMScsiController.md) -Adds a SCSI controller in a virtual machine. - -### [Add-VMStoragePath](./Add-VMStoragePath.md) -Adds a path to a storage resource pool. - -### [Add-VMSwitchExtensionPortFeature](./Add-VMSwitchExtensionPortFeature.md) -Adds a feature to a virtual network adapter. - -### [Add-VMSwitchExtensionSwitchFeature](./Add-VMSwitchExtensionSwitchFeature.md) -Adds a feature to a virtual switch. - -### [Add-VMSwitch](./Add-VMSwitch.md) -Adds a virtual switch to an Ethernet resource pool. - -### [Checkpoint-VM](./Checkpoint-VM.md) -Creates a checkpoint of a virtual machine. - -### [Compare-VM](./Compare-VM.md) -Compares a virtual machine and a virtual machine host for compatibility, returning a compatibility report. - -### [Complete-VMFailover](./Complete-VMFailover.md) -Completes a virtual machine's failover process on the Replica server. - -### [Connect-VMNetworkAdapter](./Connect-VMNetworkAdapter.md) -Connects a virtual network adapter to a virtual switch. - -### [Connect-VMSan](./Connect-VMSan.md) -Associates a host bus adapter with a virtual storage area network (SAN). - -### [Convert-VHD](./Convert-VHD.md) -Converts the format, version type, and block size of a virtual hard disk file. - -### [Disable-VMEventing](./Disable-VMEventing.md) -Disables virtual machine eventing. - -### [Disable-VMIntegrationService](./Disable-VMIntegrationService.md) -Disables an integration service on a virtual machine. - -### [Disable-VMMigration](./Disable-VMMigration.md) -Disables migration on one or more virtual machine hosts. - -### [Disable-VMRemoteFXPhysicalVideoAdapter](./Disable-VMRemoteFXPhysicalVideoAdapter.md) -Disables one or more RemoteFX physical video adapters from use with RemoteFX-enabled virtual machines. - -### [Disable-VMResourceMetering](./Disable-VMResourceMetering.md) -Disables collection of resource utilization data for a virtual machine or resource pool. - -### [Disable-VMSwitchExtension](./Disable-VMSwitchExtension.md) -Disables one or more extensions on one or more virtual switches. - -### [Disconnect-VMNetworkAdapter](./Disconnect-VMNetworkAdapter.md) -Disconnects a virtual network adapter from a virtual switch or Ethernet resource pool. - -### [Disconnect-VMSan](./Disconnect-VMSan.md) -Removes a host bus adapter from a virtual storage area network (SAN). - -### [Dismount-VHD](./Dismount-VHD.md) -Dismounts a virtual hard disk. - -### [Enable-VMEventing](./Enable-VMEventing.md) -Enables virtual machine eventing. - -### [Enable-VMIntegrationService](./Enable-VMIntegrationService.md) -Enables an integration service on a virtual machine. - -### [Enable-VMMigration](./Enable-VMMigration.md) -Enables migration on one or more virtual machine hosts. - -### [Enable-VMRemoteFXPhysicalVideoAdapter](./Enable-VMRemoteFXPhysicalVideoAdapter.md) -Enables one or more RemoteFX physical video adapters for use with RemoteFX-enabled virtual machines. - -### [Enable-VMReplication](./Enable-VMReplication.md) -Enables replication of a virtual machine. - -### [Enable-VMResourceMetering](./Enable-VMResourceMetering.md) -Collects resource utilization data for a virtual machine or resource pool. - -### [Enable-VMSwitchExtension](./Enable-VMSwitchExtension.md) -Enables one or more extensions on one or more switches. - -### [Export-VMSnapshot](./Export-VMSnapshot.md) -Exports a virtual machine checkpoint to disk. - -### [Export-VM](./Export-VM.md) -Exports a virtual machine to disk. - -### [Get-VHD](./Get-VHD.md) -Gets the virtual hard disk object associated with a virtual hard disk. - -### [Get-VMBios](./Get-VMBios.md) -Gets the BIOS of a virtual machine or snapshot. - -### [Get-VMComPort](./Get-VMComPort.md) -Gets the COM ports of a virtual machine or snapshot. - -### [Get-VMConnectAccess](./Get-VMConnectAccess.md) -Gets entries showing users and the virtual machines to which they can connect on one or more Hyper-V hosts. - -### [Get-VMDvdDrive](./Get-VMDvdDrive.md) -Gets the DVD drives attached to a virtual machine or snapshot. - -### [Get-VMFibreChannelHba](./Get-VMFibreChannelHba.md) -Gets the Fibre Channel host bus adapters associated with one or more virtual machines. - -### [Get-VMFloppyDiskDrive](./Get-VMFloppyDiskDrive.md) -Gets the floppy disk drives of a virtual machine or snapshot. - -### [Get-VMHardDiskDrive](./Get-VMHardDiskDrive.md) -Gets the virtual hard disk drives attached to one or more virtual machines. - -### [Get-VMHostNumaNodeStatus](./Get-VMHostNumaNodeStatus.md) -Gets the status of the virtual machines on the non-uniform memory access (NUMA) nodes of a virtual machine host or hosts. - -### [Get-VMHostNumaNode](./Get-VMHostNumaNode.md) -Gets the NUMA topology of a virtual machine host. - -### [Get-VMHost](./Get-VMHost.md) -Gets a Hyper-V host. - -### [Get-VMIdeController](./Get-VMIdeController.md) -Gets the IDE controllers of a virtual machine or snapshot. - -### [Get-VMIntegrationService](./Get-VMIntegrationService.md) -Gets the integration services of a virtual machine or snapshot. - -### [Get-VMMemory](./Get-VMMemory.md) -Gets the memory of a virtual machine or snapshot. - -### [Get-VMMigrationNetwork](./Get-VMMigrationNetwork.md) -Gets the networks added for migration to one or more virtual machine hosts. - -### [Get-VMNetworkAdapterAcl](./Get-VMNetworkAdapterAcl.md) -Gets the ACLs configured for a virtual machine network adapter. - -### [Get-VMNetworkAdapterFailoverConfiguration](./Get-VMNetworkAdapterFailoverConfiguration.md) -Gets the IP address of a virtual network adapter configured to be used when a virtual machine fails over. - -### [Get-VMNetworkAdapterVlan](./Get-VMNetworkAdapterVlan.md) -Gets the virtual LAN settings configured on a virtual network adapter. - -### [Get-VMNetworkAdapter](./Get-VMNetworkAdapter.md) -Gets the virtual network adapters of a virtual machine, snapshot, management OS, or of a virtual machine and management OS. - -### [Get-VMProcessor](./Get-VMProcessor.md) -Gets the processor of a virtual machine or snapshot. - -### [Get-VMRemoteFx3dVideoAdapter](./Get-VMRemoteFx3dVideoAdapter.md) -Gets the RemoteFX video adapter of a virtual machine or snapshot. - -### [Get-VMRemoteFXPhysicalVideoAdapter](./Get-VMRemoteFXPhysicalVideoAdapter.md) -Gets the RemoteFX physical graphics adapters on one or more Hyper-V hosts. - -### [Get-VMReplicationAuthorizationEntry](./Get-VMReplicationAuthorizationEntry.md) -Gets the authorization entries of a Replica server. - -### [Get-VMReplicationServer](./Get-VMReplicationServer.md) -Gets the replication and authentication settings of a Replica server. - -### [Get-VMReplication](./Get-VMReplication.md) -Gets the replication settings for a virtual machine. - -### [Get-VMResourcePool](./Get-VMResourcePool.md) -Gets the resource pools on one or more virtual machine hosts. - -### [Get-VMSan](./Get-VMSan.md) -Gets the available virtual machine storage area networks on a Hyper-V host or hosts. - -### [Get-VMScsiController](./Get-VMScsiController.md) -Gets the SCSI controllers of a virtual machine or snapshot. - -### [Get-VMSnapshot](./Get-VMSnapshot.md) -Gets the checkpoints associated with a virtual machine or checkpoint. - -### [Get-VMStoragePath](./Get-VMStoragePath.md) -Gets the storage paths in a storage resource pool. - -### [Get-VMSwitchExtensionPortData](./Get-VMSwitchExtensionPortData.md) -Retrieves the status of a virtual switch extension feature applied to a virtual network adapter. - -### [Get-VMSwitchExtensionPortFeature](./Get-VMSwitchExtensionPortFeature.md) -Gets the features configured on a virtual network adapter. - -### [Get-VMSwitchExtensionSwitchData](./Get-VMSwitchExtensionSwitchData.md) -Gets the status of a virtual switch extension feature applied on a virtual switch. - -### [Get-VMSwitchExtensionSwitchFeature](./Get-VMSwitchExtensionSwitchFeature.md) -Gets the features configured on a virtual switch. - -### [Get-VMSwitchExtension](./Get-VMSwitchExtension.md) -Gets the extensions on one or more virtual switches. - -### [Get-VMSwitch](./Get-VMSwitch.md) -Gets virtual switches from one or more virtual Hyper-V hosts. - -### [Get-VMSystemSwitchExtensionPortFeature](./Get-VMSystemSwitchExtensionPortFeature.md) -Gets the port-level features supported by virtual switch extensions on one or more Hyper-V hosts. - -### [Get-VMSystemSwitchExtensionSwitchFeature](./Get-VMSystemSwitchExtensionSwitchFeature.md) -Gets the switch-level features on one or more Hyper-V hosts. - -### [Get-VMSystemSwitchExtension](./Get-VMSystemSwitchExtension.md) -Gets the switch extensions installed on a virtual machine host. - -### [Get-VM](./Get-VM.md) -Gets the virtual machines from one or more Hyper-V hosts. - -### [Grant-VMConnectAccess](./Grant-VMConnectAccess.md) -Grants a user or users access to connect to a virtual machine or machines. - -### [Import-VMInitialReplication](./Import-VMInitialReplication.md) -Imports initial replication files for a Replica virtual machine to complete the initial replication when using external media as the source. - -### [Import-VM](./Import-VM.md) -Imports a virtual machine from a file. - -### [Measure-VMReplication](./Measure-VMReplication.md) -Gets replication statistics and information associated with a virtual machine. - -### [Measure-VMResourcePool](./Measure-VMResourcePool.md) -Reports resource utilization data for one or more resource pools. - -### [Measure-VM](./Measure-VM.md) -Reports resource utilization data for one or more virtual machines. - -### [Merge-VHD](./Merge-VHD.md) -Merges virtual hard disks. - -### [Mount-VHD](./Mount-VHD.md) -Mounts one or more virtual hard disks. - -### [Move-VMStorage](./Move-VMStorage.md) -Moves the storage of a virtual machine. - -### [Move-VM](./Move-VM.md) -Moves a virtual machine to a new Hyper-V host. - -### [New-VFD](./New-VFD.md) -Creates a virtual floppy disk. - -### [New-VHD](./New-VHD.md) -Creates one or more new virtual hard disks. - -### [New-VMReplicationAuthorizationEntry](./New-VMReplicationAuthorizationEntry.md) -Creates a new authorization entry that allows one or more primary servers to replicate data to a specified Replica server. - -### [New-VMResourcePool](./New-VMResourcePool.md) -Creates a resource pool. - -### [New-VMSan](./New-VMSan.md) -Creates a new virtual storage area network (SAN) on a Hyper-V host. - -### [New-VMSwitch](./New-VMSwitch.md) -Creates a new virtual switch on one or more virtual machine hosts. - -### [New-VM](./New-VM.md) -Creates a new virtual machine. - -### [Optimize-VHD](./Optimize-VHD.md) -Optimizes the allocation of space used by virtual hard disk files, except for fixed virtual hard disks. - -### [Remove-VMDvdDrive](./Remove-VMDvdDrive.md) -Deletes a DVD drive from a virtual machine. - -### [Remove-VMFibreChannelHba](./Remove-VMFibreChannelHba.md) -Removes a Fibre Channel host bus adapter from a virtual machine. - -### [Remove-VMHardDiskDrive](./Remove-VMHardDiskDrive.md) -Deletes a hard disk drive from a virtual machine. - -### [Remove-VMMigrationNetwork](./Remove-VMMigrationNetwork.md) -Removes a network from use with migration. - -### [Remove-VMNetworkAdapterAcl](./Remove-VMNetworkAdapterAcl.md) -Removes an ACL applied to the traffic through a virtual network adapter. - -### [Remove-VMNetworkAdapter](./Remove-VMNetworkAdapter.md) -Removes one or more virtual network adapters from a virtual machine. - -### [Remove-VMRemoteFx3dVideoAdapter](./Remove-VMRemoteFx3dVideoAdapter.md) -Removes a RemoteFX 3D video adapter from a virtual machine. - -### [Remove-VMReplicationAuthorizationEntry](./Remove-VMReplicationAuthorizationEntry.md) -Removes an authorization entry from a Replica server. - -### [Remove-VMReplication](./Remove-VMReplication.md) -Removes the replication relationship of a virtual machine. - -### [Remove-VMResourcePool](./Remove-VMResourcePool.md) -Deletes a resource pool from one or more virtual machine hosts. - -### [Remove-VMSan](./Remove-VMSan.md) -Removes a virtual storage area network (SAN) from a Hyper-V host. - -### [Remove-VMSavedState](./Remove-VMSavedState.md) -Deletes the saved state of a saved virtual machine. - -### [Remove-VMScsiController](./Remove-VMScsiController.md) -Removes a SCSI controller from a virtual machine. - -### [Remove-VMSnapshot](./Remove-VMSnapshot.md) -Deletes a virtual machine checkpoint. - -### [Remove-VMStoragePath](./Remove-VMStoragePath.md) -Removes a path from a storage resource pool. - -### [Remove-VMSwitchExtensionPortFeature](./Remove-VMSwitchExtensionPortFeature.md) -Removes a feature from a virtual network adapter. - -### [Remove-VMSwitchExtensionSwitchFeature](./Remove-VMSwitchExtensionSwitchFeature.md) -Removes a feature from a virtual switch. - -### [Remove-VMSwitch](./Remove-VMSwitch.md) -Deletes a virtual switch. - -### [Remove-VM](./Remove-VM.md) -Deletes a virtual machine. - -### [Rename-VMNetworkAdapter](./Rename-VMNetworkAdapter.md) -Renames a virtual network adapter on a virtual machine or on the management operating system. - -### [Rename-VMResourcePool](./Rename-VMResourcePool.md) -Renames a resource pool on one or more Hyper-V hosts. - -### [Rename-VMSan](./Rename-VMSan.md) -Renames a virtual storage area network (SAN). - -### [Rename-VMSnapshot](./Rename-VMSnapshot.md) -Renames a virtual machine checkpoint. - -### [Rename-VMSwitch](./Rename-VMSwitch.md) -Renames a virtual switch. - -### [Rename-VM](./Rename-VM.md) -Renames a virtual machine. - -### [Repair-VM](./Repair-VM.md) -Repairs one or more virtual machines. - -### [Reset-VMReplicationStatistics](./Reset-VMReplicationStatistics.md) -Resets the replication statistics of a virtual machine. - -### [Reset-VMResourceMetering](./Reset-VMResourceMetering.md) -Resets the resource utilization data collected by Hyper-V resource metering. - -### [Resize-VHD](./Resize-VHD.md) -Resizes a virtual hard disk. - -### [Restart-VM](./Restart-VM.md) -Restarts a virtual machine. - -### [Restore-VMSnapshot](./Restore-VMSnapshot.md) -Restores a virtual machine checkpoint. - -### [Resume-VMReplication](./Resume-VMReplication.md) -Resumes a virtual machine replication that is in a Paused, Error, Resynchronization Required, or Suspended state. - -### [Resume-VM](./Resume-VM.md) -Resumes a suspended (paused) virtual machine. - -### [Revoke-VMConnectAccess](./Revoke-VMConnectAccess.md) -Revokes access for one or more users to connect to one or more virtual machines. - -### [Save-VM](./Save-VM.md) -Saves a virtual machine. - -### [Set-VHD](./Set-VHD.md) -Set properties associated with a virtual hard disk. - -### [Set-VMBios](./Set-VMBios.md) -Configures the BIOS of a Generation 1 virtual machine. - -### [Set-VMComPort](./Set-VMComPort.md) -Configures the COM port of a virtual machine. - -### [Set-VMDvdDrive](./Set-VMDvdDrive.md) -Configures a virtual DVD drive. - -### [Set-VMFibreChannelHba](./Set-VMFibreChannelHba.md) -Configures a Fibre Channel host bus adapter on a virtual machine. - -### [Set-VMFloppyDiskDrive](./Set-VMFloppyDiskDrive.md) -Configures a virtual floppy disk drive. - -### [Set-VMHardDiskDrive](./Set-VMHardDiskDrive.md) -Configures a virtual hard disk. - -### [Set-VMHost](./Set-VMHost.md) -Configures a Hyper-V host. - -### [Set-VMMemory](./Set-VMMemory.md) -Configures the memory of a virtual machine. - -### [Set-VMMigrationNetwork](./Set-VMMigrationNetwork.md) -Sets the subnet, subnet mask, and/or priority of a migration network. - -### [Set-VMNetworkAdapterFailoverConfiguration](./Set-VMNetworkAdapterFailoverConfiguration.md) -Configures the IP address of a virtual network adapter to be used when a virtual machine fails over. - -### [Set-VMNetworkAdapterVlan](./Set-VMNetworkAdapterVlan.md) -Configures the virtual LAN settings for the traffic through a virtual network adapter. - -### [Set-VMNetworkAdapter](./Set-VMNetworkAdapter.md) -Configures features of the virtual network adapter in a virtual machine or the management operating system. - -### [Set-VMProcessor](./Set-VMProcessor.md) -Configures one or more processors of a virtual machine. - -### [Set-VMRemoteFx3dVideoAdapter](./Set-VMRemoteFx3dVideoAdapter.md) -Configures the RemoteFX 3D video adapter of a virtual machine. - -### [Set-VMReplicationAuthorizationEntry](./Set-VMReplicationAuthorizationEntry.md) -Modifies an authorization entry on a Replica server. - -### [Set-VMReplicationServer](./Set-VMReplicationServer.md) -Configures a host as a Replica server. - -### [Set-VMReplication](./Set-VMReplication.md) -Modifies the replication settings of a virtual machine. - -### [Set-VMResourcePool](./Set-VMResourcePool.md) -Sets the parent resource pool for a selected resource pool. - -### [Set-VMSan](./Set-VMSan.md) -Configures a virtual storage area network (SAN) on one or more Hyper-V hosts. - -### [Set-VMSwitchExtensionPortFeature](./Set-VMSwitchExtensionPortFeature.md) -Configures a feature on a virtual network adapter. - -### [Set-VMSwitchExtensionSwitchFeature](./Set-VMSwitchExtensionSwitchFeature.md) -Configures a feature on a virtual switch. - -### [Set-VMSwitch](./Set-VMSwitch.md) -Configures a virtual switch. - -### [Set-VM](./Set-VM.md) -Configures a virtual machine. - -### [Start-VMFailover](./Start-VMFailover.md) -Starts failover on a virtual machine. - -### [Start-VMInitialReplication](./Start-VMInitialReplication.md) -Starts replication of a virtual machine. - -### [Start-VM](./Start-VM.md) -Starts a virtual machine. - -### [Stop-VMFailover](./Stop-VMFailover.md) -Stops failover of a virtual machine. - -### [Stop-VMInitialReplication](./Stop-VMInitialReplication.md) -Stops an ongoing initial replication. - -### [Stop-VMReplication](./Stop-VMReplication.md) -Cancels an ongoing virtual machine resynchronization. - -### [Stop-VM](./Stop-VM.md) -Shuts down, turns off, or saves a virtual machine. - -### [Suspend-VMReplication](./Suspend-VMReplication.md) -Suspends replication of a virtual machine. - -### [Suspend-VM](./Suspend-VM.md) -Suspends or pauses a virtual machine. - -### [Test-VHD](./Test-VHD.md) -Tests a virtual hard disk for any problems that would make it unusable. - -### [Test-VMReplicationConnection](./Test-VMReplicationConnection.md) -Tests the connection between a primary server and a Replica server. - diff --git a/docset/winserver2012-ps/hyper-v/Import-VM.md b/docset/winserver2012-ps/hyper-v/Import-VM.md deleted file mode 100644 index acea1bc6c2..0000000000 --- a/docset/winserver2012-ps/hyper-v/Import-VM.md +++ /dev/null @@ -1,334 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/import-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-VM - -## SYNOPSIS -Imports a virtual machine from a file. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Import-VM [-CompatibilityReport] [-AsJob] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Import-VM [-Path] [[-VhdDestinationPath] ] [-AsJob] [-ComputerName ] - [-GenerateNewId] [-SmartPagingFilePath ] [-SnapshotFilePath ] [-VhdSourcePath ] - [-VirtualMachinePath ] [-Copy] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Import-VM [-Path] [-AsJob] [-ComputerName ] [-Register] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Import-VM** cmdlet imports a virtual machine from a file. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Import-VM -Path 'D:\Test\VirtualMachines\5AE40946-3A98-428E-8C83-081A3C6BD18C.XML' -``` - -Imports the virtual machine from its configuration file. -The virtual machine is registered in-place, so its files are not copied. - -### Example 2 -``` -PS C:\>Import-VM -Path 'D:\Test2\Virtual Machines\8F148B6D-C674-413E-9FCC-4FBED185C52D.XML' -Copy -GenerateNewId -``` - -Imports the virtual machine by copying its files to the default virtual machine and virtual hard drive storage locations of the Hyper-V host. -The imported virtual machine will be given a new unique identifier, not the one in the configuration file. -This is useful when you want to import multiple copies of a virtual machine, since each virtual machine must have a unique identifier. - -### Example 3 -``` -Attempts import of a virtual machine; the attempt fails due to incompatibilities with the Hyper-V host. -PS C:\>Import-VM -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML' -Import-VM : Unable to import virtual machine due to configuration errors. Please use Compare-VM to repair the virtual machine. -At line:1 char:1 -+ import-vm -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XM ... -+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + CategoryInfo : NotSpecified: (:) [Import-VM], VirtualizationOperationFailedException - + FullyQualifiedErrorId : Microsoft.HyperV.PowerShell.Commands.ImportVMCommand - -Gets a compatibility report that describes the attempted import and lists the virtual machine's incompatibilities with the Hyper-V host. -PS C:\>$report = Compare-VM -Path 'D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML' - - -Displays the compatibility report, revealing that the virtual network adapter was connected to switch Production. The Hyper-V host has no switch by that name. -PS C:\>$report.Incompatibilities | Format-Table -AutoSize -Message MessageId Source -------- --------- ------ -Could not find Ethernet switch 'Production'. 33012 Microsoft.HyperV.PowerShell.VMNetworkAdapter - -Disconnects the virtual network adapter. -PS C:\>$report.Incompatibilities[0].Source | Disconnect-VMNetworkAdapter - - -Generates a new compatibility report to determine if the virtual machine is compatible with the Hyper-V host. -PS C:\>Compare-VM -CompatibilityReport $report - - -Displays the compatibility report. -PS C:\>$report -VM : Microsoft.HyperV.PowerShell.VirtualMachine -OperationType : ImportVirtualMachine -Destination : HYPER-V-1 -Path : D:\vm1\Virtual Machines\53EAE599-4D3B-4923-B173-6AEA29CB7F42.XML -SnapshotPath : D:\vm1\Snapshots -VhdDestinationPath : -VhdSourcePath : -Incompatibilities : - -Imports the virtual machine. -PS C:\>import-vm -CompatibilityReport $report -Name State CPUUsage(%) MemoryAssigned(M) MemoryDemand(M) MemoryStatus Uptime Status ReplicationState ----- ----- ----------- ----------------- --------------- ------------ ------ ------ ---------------- -VM1 Off 0 0 0 00:00:00 Operating normally Disabled -``` - -Imports a virtual machine whose configuration is not compatible with the Hyper-V host. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityReport -Specifies a compatibility report which resolves any incompatibilities between the virtual machine and the Hyper-V host. - -```yaml -Type: VMCompatibilityReport -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts from which the virtual machine is to be imported. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateNewId -Specifies that the imported virtual machine should be copied and given a new unique identifier. -(By default, **Import-VM** gives the new virtual machine the same unique identifier as the imported virtual machine.) - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the exported virtual machine to be imported. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Copy -Specifies that the imported virtual machine's files should be copied to the server's default locations, as opposed to registering the virtual machine in-place. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Register -Specifies that the imported virtual machine is to be registered in-place, as oppsed to copying its files to the server's default locations. -Choose this option if the virtual machines files are already in the location from which they are to run. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartPagingFilePath -Specifies the new path to use for a smart paging file, if one is needed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotFilePath -Specifies the path for any snapshot files associated with the virtual machine. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdDestinationPath -Specifies the folder to which the virtual machine's VHD files are to be copied. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VhdSourcePath -Specifies the folder from which the virtual machine's VHD files are to be copied. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachinePath - - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -None. - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.VirtualMachine - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Import-VMInitialReplication.md b/docset/winserver2012-ps/hyper-v/Import-VMInitialReplication.md deleted file mode 100644 index b524c667c4..0000000000 --- a/docset/winserver2012-ps/hyper-v/Import-VMInitialReplication.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/import-vminitialreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-VMInitialReplication - -## SYNOPSIS -Imports initial replication files for a Replica virtual machine to complete the initial replication when using external media as the source. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Import-VMInitialReplication [-VMName] [-Path] [-AsJob] [-ComputerName ] - [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Import-VMInitialReplication [-VM] [-Path] [-AsJob] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Import-VMInitialReplication [-VMReplication] [-Path] [-AsJob] [-PassThru] -``` - -## DESCRIPTION -The **Import-VMInitialReplication** cmdlet imports initial replication files on a Replica server. -It completes the initial replication of a virtual machine when external is used as the source of the files for initial replication. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Import-VMInitialReplication VM01 d:\VMImportLocation\VM01 -``` - -This example imports the initial replication files for a virtual machine named VM01 from location d:\VMImportLocation\VM01. - -### Example 2 -``` -PS C:\>Get-VMReplication | % {$path = "D:\OOBLoc\" + $_.VMName + "_" + $_.VMID; if (Test-Path $path -PathType Container) {Import-VMInitialReplication $_ $path}} -``` - -This example imports the initial replication files for a set of virtual machines using files located in D:\OOBLoc\ - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which initial replication files are to be imported. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that an object is to be passed through to the pipeline representing the virtual machine for which initial replication files are to be imported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the initial replication files to import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which the initial replication files are to be imported. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which the initial replication files are to be imported. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies the virtual machine replication object for which initial replication files are to be imported. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Measure-VM.md b/docset/winserver2012-ps/hyper-v/Measure-VM.md deleted file mode 100644 index 48336e292a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Measure-VM.md +++ /dev/null @@ -1,175 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/measure-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Measure-VM - -## SYNOPSIS -Reports resource utilization data for one or more virtual machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Measure-VM [-Name] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Measure-VM [-VM] -``` - -## DESCRIPTION -The **Measure-VM** cmdlet reports data on processor usage, memory usage, network traffic, and disk capacity for one or more virtual machines. - -Note: Data is available for reporting through the **Measure-VM** cmdlet only after resource metering is enabled for a virtual machine. - -The report has the following fields: - - -- ComputerName: The name of the virtual machine host. - - -- VMId: The unique identifier of the virtual machine. - - -- VMName: The friendly name of the virtual machine. - - -- MeteringDuration: The duration over which resource utilization data is being reported. - - -- AverageProcessorUsage: The average processor usage, in megahertz, of the virtual machine over the period reported in the MeteringDuration field. - - -- AverageMemoryUsage: The average memory usage, in megabytes, of the virtual machine over the period reported in the MeteringDuration field. - - -- MaximumMemoryUsage: The maximum memory usage, in megabytes, of the virtual machine over the period reported in the MeteringDuration field. - - -- MinimumMemoryUsage: The minimum memory usage, in megabytes, of the virtual machine over the time period reported in the MeteringDuration field. - - -- TotalDiskAllocation: The maximum disk capacity, in megabytes, allocated to the virtual machine over the time period reported in the MeteringDuration field. -For more information, see the 'Notes' following the field descriptions. - - -- NetworkMeteredTrafficReport: An array whose elements report the traffic through each NetworkAdapterAcl on the virtual machine or machines over the time period reported in the MeteringDuration field. -Each array element has the following properties: - - -- NetworkAdapter: The virtual machine network adapter object on which the NetworkAdapterAcl has been configured. - - -- LocalAddress: for an inbound packet, the destination IP address in the packet header; for an outbound packet, the source IP address in the packet header. - - -- RemoteAddress: for an inbound packet, the source IP address in the packet header; for an outbound packet, the destination IP address in the packet header. - - -- Direction: the direction of the network traffic to which the ACL applies. -Allowed values are Inbound, Outbound, or Both. - - -- TotalTraffic: the amount of network traffic, in megabytes, through the NetworkAdapterAcl. - -Notes: - - -- The disk capacity allocated to the virtual machine is reported as the sum of two totals -- the total storage capacity of all attached virtual hard disks, and the total amount of physical storage consumed by the virtual machine's snapshots. - - -- If the virtual machine has more than one virtual hard disk, then the TotalDiskAllocation property displays the sum of disk capacity allocated to all virtual hard disks. - - -- Resource utilization is not reported for disks attached through a virtual Fiber Channel connection or network adapters configured to use single-root I/O virtualization (SR-IOV). - - -- If the virtual machine is configured with static memory rather than Dynamic Memory, then AverageMemoryUsage, MinimumMemoryUsage, and MaximumMemoryUsage metrics equals the memory amount configured for the virtual machine. - -The default display of a resource pool resource utilization report includes the following columns: - - -- VMName: The name of the virtual machine. - - -- AvgCPU(Mhz): The average processor usage, in megahertz, of the virtual machine. - - -- TotalDisk(M): The average disk usage, in megabytes, of the virtual machine. -For more information, see the 'Notes' following the field descriptions. - - -- NetworkInbound(M): Total incoming network traffic, in megabytes, to the virtual machine. - - -- NetworkOutbound(M): Total outgoing network traffic, in megabytes, from the vritual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Measure-VM -VMName TestVM -``` - -This example reports resource utilization data for a virtual machine named TestVM. - -### Example 2 -``` -PS C:\>$UtilizationReport = Get-VM TestVM | Measure-VM -PS C:\>Get-VM TestVM | Reset-VMResourceMetering -``` - -This example uses two commands as well as the pipeline. -The first command uses the Get-VM cmdlet and passes the object to the Measure-VM cmdlet to retrieve collected resource utilization data for a virtual machine named TestVM, and stores the data in a variable named $UtilizationReport. -The second command uses the Reset-VMResourceMetering cmdlet to clear existing data so that Hyper-V begins collecting new data. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts for which resource utilization is to be reported. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the virtual machine whose resource utilization data will be reported. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose resource utilization will be reported. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VMNetworkAdapterAcl](./Add-VMNetworkAdapterAcl.md) - -[Disable-VMResourceMetering](./Disable-VMResourceMetering.md) - -[Enable-VMResourceMetering](./Enable-VMResourceMetering.md) - -[Remove-VMNetworkAdapterAcl](./Remove-VMNetworkAdapterAcl.md) - -[Reset-VMResourceMetering](./Reset-VMResourceMetering.md) - diff --git a/docset/winserver2012-ps/hyper-v/Measure-VMReplication.md b/docset/winserver2012-ps/hyper-v/Measure-VMReplication.md deleted file mode 100644 index 25e2edbbfc..0000000000 --- a/docset/winserver2012-ps/hyper-v/Measure-VMReplication.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/measure-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Measure-VMReplication - -## SYNOPSIS -Gets replication statistics and information associated with a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Measure-VMReplication [[-VMName] ] [-ComputerName ] [-PrimaryServerName ] - [-ReplicaServerName ] [-ReplicationHealth ] - [-ReplicationMode ] [-ReplicationState ] [-TrustGroup ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Measure-VMReplication [-VM] -``` - -## DESCRIPTION -The **Measure-VMReplication** cmdlet gets replication statistics and information associated with virtual machine. -Replication statistics are calculated for a predetermined amount of time based on the monitoring interval specified through the Set-VMReplicationServer cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Measure-VMReplication -``` - -This example gets the replication monitoring details of all replicating virtual machines on the local host. - -### Example 2 -``` -PS C:\>Measure-VMReplication VM01 -``` - -This example gets the replication monitoring details of a virtual machine named VM01. - -### Example 3 -``` -PS C:\> Measure-VMReplication -ReplicationHealth Warning -``` - -This example gets the replication monitoring details of all virtual machines that have a replication health of "Warning". - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which to get replication statistics. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryServerName -Specifies the name of a primary server. -Replication statistics are retrieved for all virtual machines from the specified primary server. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: PrimaryServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which you want to get replication statistics. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which you want to get virtual machine replication statistics. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Name - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ReplicaServerName -Specifies the name of a Replica server of the virtual machines whose replication statistics you want to get. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ReplicaServer - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationHealth -Specifies the replication health of the virtual machines whose replication statistics you want to get. -Valid values are "Critical", "Warning", "Normal", and "NotApplicable". - -```yaml -Type: VMReplicationHealthState -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Health - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationMode -Specifies the replication mode of the virtual machines whose replication statistics you want to get. -Valid values are "None", "Primary", "Replica" and "TestReplica". - -```yaml -Type: VMReplicationMode -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Mode - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationState -Specifies the replication state of the virtual machines for which you want to get replication statistics. -Valid values are: - -Error - -FailOverWaitingCompletion - -FailedOver - -NotApplicable - -ReadyForInitialReplication - -Replicating - -Resynchronizing - -ResynchronizeSuspended - -Suspended - -SyncedReplicationComplete - -WaitingForInitialReplication - -WaitingForStartResynchronize - -```yaml -Type: VMReplicationState -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: State - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustGroup -Specifies a trust group associated with the virtual machines whose replication statistics you want to get. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMReplicationHealth - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Measure-VMResourcePool.md b/docset/winserver2012-ps/hyper-v/Measure-VMResourcePool.md deleted file mode 100644 index e1e237a814..0000000000 --- a/docset/winserver2012-ps/hyper-v/Measure-VMResourcePool.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/measure-vmresourcepool?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Measure-VMResourcePool - -## SYNOPSIS -Reports resource utilization data for one or more resource pools. - -## SYNTAX - -``` -Measure-VMResourcePool [-Name] [[-ResourcePoolType] ] - [-ComputerName ] -``` - -## DESCRIPTION -The **Measure-VMResourcePool** cmdlet reports data on processor usage, memory usage, network traffic, and disk capacity for one or more virtual machine resource pools. - -Note: Data is available for reporting by the **Measure-VMResourcePool** cmdlet only after resource metering is enabled for the virtual machine resource pool or pools. - -This cmdlet can also be called with an array of resource pools with the same name. -In this case, resource utilization data for different resource types will be aggregated in a single report. - -The report has the following fields: - - -- ComputerName: The name of the virtual machine host. - - -- ResourcePoolType: The type of the virtual machine resource pool. - - -- ResourcePoolName: The name of the resource pool. - - -- MeteringDuration: The duration over which resource utilization data is being reported. - - -- AverageProcessorUsage: The sum of the average processor usage, in megahertz, of the virtual machines under the specified resource pool over the time period reported in the MeteringDuration field. - - -- AverageMemoryUsage: The sum of the average memory usage, in megabytes, of the virtual machines under the specified resource pool over the time period reported in the MeteringDuration field. - - -- MaximumMemoryUsage: The maximum memory usage, in megabytes, of any virtual machine under the specified resource pool over the time period reported in the MeteringDuration field. - - -- MinimumMemoryUsage: The minimum memory usage, in megabytes, of any virtual machine under the specified resource pool over the time period reported in the MeteringDuration field. - - -- TotalDiskAllocation: The maximum disk capacity, in gigabytes, allocated to any virtual machine under the specified resource pool over the time period reported in the MeteringDuration field. - - -- NetworkMeteredTrafficReport: An array whose elements report the traffic through each NetworkAdapterAcl on the virtual machines under the specified resource pool over the time period reported in the MeteringDuration field. - -Each array element has the following properties: - - -- LocalAddress: for an inbound packet, the destination IP address in the packet header; for an outbound packet, the source IP address in the packet header. - - -- RemoteAddress: for an inbound packet, the source IP address in the packet header; for an outbound packet, the destination IP address in the packet header. - - -- Direction: the direction of the network traffic to which the ACL applies. -Allowed values are Inbound, Outbound, or Both. - - -- TotalTraffic: the amount of network traffic, in megabytes, through the NetworkAdapterAcl. - -Notes: - - -- The disk capacity allocated to the virtual machine is reported as the sum of the virtual capacity of the virtual machine's virtual hard disks, together with the sum of the physical disk capacity of the virtual machine's virtual hard disk snapshots. - - -- Resource utilization information is not available for resource pool types of FiberChannelConnection, FibreChannelPort, VFD, and ISO. - - -- If the virtual machines under the specified resource pool are configured with the same values for LocalAddress, RemoteAddress, and Direction, the information from each of these NetworkAdapterAcl objects is aggregated in the TotalTraffic property specified by the NetworkMeteredTrafficReport of the object returned by the Measure-VMResourcePool cmdlet. - -Default display of a resource pool resource utilization report includes the following columns: - - -- Name: the name of the resource pool. - - -- ResourcePoolType: the type of the virtual machine resource pool. - - --AvgCPU(Mhz): the sum of the average processor usage, in megahertz, of the virtual machines under the specified resource pool. - - -- AvgRAM(M): the sum of the average memory usage, in megabytes, of the virtual machines under the specified resource pool. - - -- TotalDisk(G): the maximum disk capacity, in gigabytes, allocated to any virtual machine under the specified resource pool. - - -- NetworkInbound(M): total incoming traffic, in megabytes, to the virtual machines under the specified resource pool. - - -- NetworkOutbound(M): total outgoing network traffic, in megabytes, to the virtual machines under the specified resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Measure-VMResourcePool -Name TestResourcePool -ResourcePoolType -Memory -``` - -This example reports resource utilization data for a resource pool named TestResourcePool. - -### Example 2 -``` -PS C:\>$UtilizationReport = Get-VMResourcePool -Name "TestResourcePool" -ResourcePoolType @("Processor","VHD","Ethernet","Memory") | Measure-VMResourcePool -PS C:\>Get-VMResourcePool -ResourcePoolType @("Processor","VHD","Ethernet","Memory") | Reset-VMResourceMetering -``` - -This example uses two commands as well as the pipeline. -The first command retrieves resource utilization data for a set of resource pools using the Get-VMResourcePool cmdlet, passes the object to the Measure-VMResourcePool cmdlet, and stores that data in a variable named $UtilizationReport. -The second command resets resource utilization data for these resource pools so that Hyper-V begins collecting new data for the resource pools. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts for which resource utilization is to be reported. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the resource pool for which resource utilization is to be reported. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the resource type of the virtual machine resource pool for which resource utilization is to be reported. - -```yaml -Type: VMResourcePoolType[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VMResourcePoolType[] - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-VMNetworkAdapterAcl](Add-VMNetworkAdapterAcl.md) - -[Disable-VMResourceMetering](Disable-VMResourceMetering.md) - -[Enable-VMResourceMetering](Enable-VMResourceMetering.md) - -[Remove-VMNetworkAdapterAcl](Remove-VMNetworkAdapterAcl.md) - -[Reset-VMResourceMetering](Reset-VMResourceMetering.md) - diff --git a/docset/winserver2012-ps/hyper-v/Merge-VHD.md b/docset/winserver2012-ps/hyper-v/Merge-VHD.md deleted file mode 100644 index 82a89451cf..0000000000 --- a/docset/winserver2012-ps/hyper-v/Merge-VHD.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/merge-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Merge-VHD - -## SYNOPSIS -Merges virtual hard disks. - -## SYNTAX - -``` -Merge-VHD [-Path] [[-DestinationPath] ] [-AsJob] [-ComputerName ] [-Force] - [-Passthru] -``` - -## DESCRIPTION -The **Merge-VHD** cmdlet merges virtual hard disks in a differencing virtual hard disk chain. -The merge is from a specified source child disk to a specified destination child disk. - -Merge is an offline operation; the virtual hard disk chain must not be attached when merge is initiated. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Merge-VHD -Path c:\test\Child4.vhdx -DestinationPath c:\test\Child2.vhdx -``` - -This example merges the virtual hard disk from Child4 to Child2, for a virtual disk chain with Child4 as a child of Child3, Child3 as a child of Child2, Child2 as a child of Child1, and Child1 as a child of Parent, and with the virtual hard disk file for each located in c:\test. -This example merges all data from Child4 and Child3 up to Child2. -Child4.vhdx and Child3.vhdx are not deleted, but are no longer valid virtual hard disk files after the operation. - -## PARAMETERS - -### -AsJob -Run the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which virtual hard disks are to be merged. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPath -Specifies the path to the child in the virtual hard disk chain that is the destination for the merge command. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Force -Runs the cmdlet without prompting for confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the merged virtual hard disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the child in the virtual hard disk chain that is the source for the merge command. -If a filename or relative path is specified, the virtual hard disk path will be calculated relative to the current working directory. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -## INPUTS - -### VHDObject - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Mount-VHD.md b/docset/winserver2012-ps/hyper-v/Mount-VHD.md deleted file mode 100644 index 18710f04d1..0000000000 --- a/docset/winserver2012-ps/hyper-v/Mount-VHD.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/mount-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Mount-VHD - -## SYNOPSIS -Mounts one or more virtual hard disks. - -## SYNTAX - -``` -Mount-VHD [-Path] [-ComputerName ] [-NoDriveLetter] [-Passthru] [-ReadOnly] -``` - -## DESCRIPTION -The **Mount-VHD** cmdlet mounts one or more virtual hard disks. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Mount-VHD -Path c:\test\testvhdx.vhdx -``` - -Mounts a virtual hard disk where the path to the virtual hard disk file is c:\test\testvhdx.vhdx. - -### Example 2 -``` -PS C:\>Mount-VHD -Path c:\test\testvhdx.vhdx -ReadOnly -``` - -Mounts a virtual hard disk in read-only mode where the path to the virtual hard disk file is c:\test\testvhdx.vhdx. - -### Example 3 -``` -PS C:\>Mount-VHD -Path c:\test\testvhdx -PassThru | Get-Disk | Get-Partition | Get-Volume -``` - -Attaches a virtual hard disk to the system where the path to the virtual hard disk file is c:\test\testvhdx.vhdx, and gets the volumes associated with it. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual hard disk is to be mounted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoDriveLetter -Specifies that the virtual hard disk is to be mounted without assigning drive letters to the volumes contained within the virtual hard disk. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual hard disk to be mounted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual hard disk file for the virtual hard disk to be mounted. -If a filename or relative path is specified, the virtual hard disk path is calculated relative to the current working directory. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -ReadOnly -Specifies that the virtual hard disk is to be mounted in read-only mode. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Move-VM.md b/docset/winserver2012-ps/hyper-v/Move-VM.md deleted file mode 100644 index b11cc22c71..0000000000 --- a/docset/winserver2012-ps/hyper-v/Move-VM.md +++ /dev/null @@ -1,339 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/move-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-VM - -## SYNOPSIS -Moves a virtual machine to a new Hyper-V host. - -## SYNTAX - -### Name (default) -``` -Move-VM [-Name] [-DestinationHost] [-AsJob] [-ComputerName ] - [-DestinationStoragePath ] [-IncludeStorage] [-Passthru] [-ResourcePoolName ] - [-RetainVhdCopiesOnSource] [-SmartPagingFilePath ] [-SnapshotFilePath ] [-Vhds ] - [-VirtualMachinePath ] [-Confirm] [-WhatIf] -``` - -### CompatibilityReport -``` -Move-VM [-CompatibilityReport] [-AsJob] [-Passthru] [-Confirm] [-WhatIf] -``` - -### VM -``` -Move-VM [-VM] [-DestinationHost] [-AsJob] [-DestinationStoragePath ] - [-IncludeStorage] [-Passthru] [-ResourcePoolName ] [-RetainVhdCopiesOnSource] - [-SmartPagingFilePath ] [-SnapshotFilePath ] [-Vhds ] - [-VirtualMachinePath ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Move-VM** cmdlet moves a virtual machine to a new Hyper-V host. - -## EXAMPLES - -### Example 1: Move VM to remote computer -```powershell -PS C:\> Move-VM -Name "Test VM" -DestinationHost remoteServer -``` - -Moves a virtual machine test VM to a remote computer remoteServer when the virtual machine is stored on an SMB share. - -### Example 2: Move VM and all storage to remote computer -```powershell -PS C:\> Move-VM -Name "Test VM" -DestinationHost remoteServer -IncludeStorage -DestinationStoragePath D:\TestVM -``` - -Moves virtual machine test VM to remote computer remoteServer, and moves all files associated with the virtual machine to D:\TestVM on the remote computer. - -### Example 3: Move VM and specified storage file to remote computer -```powershell -PS C:\> Move-VM -Name "Test VM" -DestinationHost remoteServer -VirtualMachinePath D:\TestVM\Config -SnapshotFilePath D:\TestVM\Snapshots -SmartPagingFilePath D:\TestVM\SmartPaging -IncludeStorage -VHDs @(@{"SourceFilePath" = "C:\TestVM\Disk1.VHDX"; "DestinationFilePath" = "D:\TestVM\Disks\Disk1.VHDX"}, @{"SourceFilePath" = "C:\TestVM\Disk2.VHDX"; "DestinationFilePath" = "D:\TestVM\Disks\Disk2.VHDX"}) -``` - -Moves a virtual machine Test VM to a remote computer remoteServer and places the files associated with the virtual machine in the specified locations under D:\TestVM on the remote computer. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityReport -Specifies a compatibility report which includes any adjustments required for the move. - -```yaml -Type: VMCompatibilityReport -Parameter Sets: CompatibilityReport -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts that run this cmdlet. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: Name -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationHost -Specifies the virtual machine host to which the virtual machine is to be moved. - -```yaml -Type: String -Parameter Sets: Name, VM -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationStoragePath -Specifies a destination storage path to which all virtual machine storage is to be moved. - -```yaml -Type: String -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeStorage -Specifies that both the virtual machine and its storage are to be moved. - -```yaml -Type: SwitchParameter -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the virtual machine to be moved. - -```yaml -Type: String -Parameter Sets: Name -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to be pipeline representing the moved virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be moved. - -```yaml -Type: VirtualMachine -Parameter Sets: VM -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the storage resource pool to use after the move operation is complete. - -```yaml -Type: String -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainVhdCopiesOnSource -Specify **$true** to keep any parent virtual hard disks on the source computer. -If not specified, all virtual hard disks will be removed from the source computer once the virtual machine is successfully moved. - -```yaml -Type: SwitchParameter -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartPagingFilePath -Specifies the new path to use for a smart paging file, if one is needed. - -```yaml -Type: String -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotFilePath -Specifies the new path for any snapshot files associated with the virtual machine. - -```yaml -Type: String -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vhds -An array of hashtables that specifies a location for each individual virtual hard disk that needs to be moved. -Each hashtable has two entries. -The first entry specifies the current location of the virtual hard disk to move, and has a key of SourceFilePath. -The second entry specifies the new location for the virtual hard disk, and has a key of DestinationFilePath. -The virtual hard disk names must be identical in both entries. - -```yaml -Type: Hashtable[] -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachinePath -Specifies the path for the virtual machine configuration file and associated memory files. - -```yaml -Type: String -Parameter Sets: Name, VM -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None, by default. -**Microsoft.Virtualization.Powershell.VirtualMachine** if the migration succeeds and **-PassThru** is specified. -**Microsoft.Virtualization.Powershell.CompatibilityReport** if the migration fails because of an incompatibility. - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/hyper-v/Move-VMStorage.md b/docset/winserver2012-ps/hyper-v/Move-VMStorage.md deleted file mode 100644 index 36d40d2e56..0000000000 --- a/docset/winserver2012-ps/hyper-v/Move-VMStorage.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/move-vmstorage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-VMStorage - -## SYNOPSIS -Moves the storage of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Move-VMStorage [-VMName] [-DestinationStoragePath] [-AllowUnverifiedPaths] [-AsJob] - [-ComputerName ] [-ResourcePoolName ] [-RetainVhdCopiesOnSource] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Move-VMStorage [-VMName] [-AllowUnverifiedPaths] [-AsJob] [-ComputerName ] - [-ResourcePoolName ] [-RetainVhdCopiesOnSource] [-SmartPagingFilePath ] - [-SnapshotFilePath ] [-Vhds ] [-VirtualMachinePath ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Move-VMStorage [-VM] [-DestinationStoragePath] [-AllowUnverifiedPaths] [-AsJob] - [-ResourcePoolName ] [-RetainVhdCopiesOnSource] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Move-VMStorage [-VM] [-AllowUnverifiedPaths] [-AsJob] [-ResourcePoolName ] - [-RetainVhdCopiesOnSource] [-SmartPagingFilePath ] [-SnapshotFilePath ] [-Vhds ] - [-VirtualMachinePath ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Move-VMStorage** cmdlet moves the storage of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Move-VMStorage "Test VM" -DestinationStoragePath D:\TestVM -``` - -Moves all files associated with a virtual machine test VM to D:\TestVM - -### Example 2 -``` -PS C:\>Move-VMStorage "Test VM" -VirtualMachinePath D:\TestVM\Config -SnapshotFilePath D:\TestVM\Snapshots -SmartPagingFilePath D:\TestVM\SmartPaging -VHDs @(@{"SourceFilePath" = "C:\TestVM\Disk1.VHDX"; "DestinationFilePath" = "D:\TestVM\Disks\Disk1.VHDX"}, @{"SourceFilePath" = "C:\TestVM\Disk2.VHDX"; "DestinationFilePath" = "D:\TestVM\Disks\Disk2.VHDX"}) -``` - -Moves all files associated with a virtual machine test VM to different locations under D:\TestVM. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the storage resource pool to use after the move operation is complete. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotFilePath -Specifies the new path for any snapshot files associated with the virtual machine. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose storage is to be moved. - -```yaml -Type: VirtualMachine -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose storage is to be moved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VirtualMachinePath -Specifies the path to the virtual machine configuration file and associated memory files. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowUnverifiedPaths -Allows the move operation to be attempted even if the paths specified for the destination computer cannot be verified prior to attempting the move operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationStoragePath -Specifies a destination storage path to which all virtual machine storage is to be moved. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetainVhdCopiesOnSource -Specify **$true** to keep any parent virtual hard disks on the source computer. -If not specified, all virtual hard disks will be removed from the source computer once the virtual machine is successfully moved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartPagingFilePath -Specifies the new path to use for a smart paging file, if one is needed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Vhds -Specifies an array of hashtables that contain locations for each individual virtual hard disk to be moved. -Each hashtable should have two entries. -The first entry specifies the current location of the virtual hard disk to move, and has a key of SourceFilePath. -The second entry specifies the new location for the virtual hard disk, and has a key of DestinationFilePath. -The virtual hard disk name must be identical in both entries. - -```yaml -Type: Hashtable[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more virtual machine hosts on which the virtual machine storage is to be moved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/New-VFD.md b/docset/winserver2012-ps/hyper-v/New-VFD.md deleted file mode 100644 index 209a74cab6..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VFD.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vfd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VFD - -## SYNOPSIS -Creates a virtual floppy disk. - -## SYNTAX - -``` -New-VFD [-Path] [-ComputerName ] -``` - -## DESCRIPTION -The **New-VFD** cmdlet creates a new virtual floppy disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-VFD "c:\floppy.vfd" -``` - -Creates a new virtual floppy drive at the specified path. -This can be then used in the Set-VMFloppyDiskDrive cmdlet to attach the virtual floppy disk to a virtual machine. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts on which the virtual floppy disk is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the new virtual floppy disk files to be created. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### System.IO.FileInfo - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/New-VHD.md b/docset/winserver2012-ps/hyper-v/New-VHD.md deleted file mode 100644 index 7f00bddf46..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VHD.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VHD - -## SYNOPSIS -Creates one or more new virtual hard disks. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-VHD [-Path] [-SizeBytes] [-AsJob] [-BlockSizeBytes ] [-ComputerName ] - [-Dynamic] [-LogicalSectorSizeBytes ] [-PhysicalSectorSizeBytes ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-VHD [-Path] [-ParentPath] [[-SizeBytes] ] [-AsJob] [-BlockSizeBytes ] - [-ComputerName ] [-Differencing] [-PhysicalSectorSizeBytes ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -New-VHD [-Path] [-AsJob] [-BlockSizeBytes ] [-ComputerName ] [-Dynamic] - -SourceDisk [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -New-VHD [-Path] [-AsJob] [-BlockSizeBytes ] [-ComputerName ] [-Fixed] - -SourceDisk [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -New-VHD [-Path] [-SizeBytes] [-AsJob] [-BlockSizeBytes ] [-ComputerName ] - [-LogicalSectorSizeBytes ] [-PhysicalSectorSizeBytes ] [-Fixed] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-VHD** cmdlet creates one or more new virtual hard disks in either VHD format or the newer VHDX format. -The file extension you specify determines the format. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-VHD -Path c:\Base.vhdx -SizeBytes 10GB -``` - -This example creates a dynamic virtual hard disk in VHDX format that is 10 GB in size. -The file extension determines the format and the default type of dynamic is used because no type is specified. - -### Example 2 -``` -PS C:\>New-VHD -ParentPath c:\Base.vhdx -Path c:\Diff.vhdx -Differencing -``` - -This example creates a VHDX-format differencing virtual hard disk with a parent path of c:\Base.vhdx. - -### Example 3 -``` -PS C:\>New-VHD -Path C:\fixed.vhd -Fixed -SourceDisk 2 -SizeBytes 1TB -``` - -This example creates a 1 TB VHD-format fixed virtual hard disk at the specified path. -The data for the virtual hard disk is populated from the disk identified in the system by the number 2. -You can list the disks attached to the system and the number associated with each disk using the Get-Disk cmdlet. - -### Example 4 -``` -PS C:\>New-VHD -Path c:\LargeSectorBlockSize.vhdx -BlockSizeBytes 128MB -LogicalSectorSize 4KB -SizeBytes 1TB -``` - -This example creates a new 1 TB VHDX-format dynamic virtual hard disk at the specified path with a block size of 128 MB and a logical sector size of 4 KB. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BlockSizeBytes -Specifies the block size, in bytes, of the virtual hard disk to be created. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual hard disk file(s) are to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogicalSectorSizeBytes -Specifies the logical sector size, in bytes, of the virtual hard disk to be created. -Valid values are 512 and 4096. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: 512 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParentPath -Specifies the path to the parent of the differencing disk to be created (this parameter may be specified only for the creation of a differencing disk). - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Path to the new virtual hard disk file(s) that is being created as a result of a command. -If a filename or relative path is specified, the new virtual hard disk path is calculated relative to the current working directory. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -PhysicalSectorSizeBytes -Specifies the physical sector size, in bytes. -Valid values are 512 and 4096. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SizeBytes -The maximum size, in bytes, of the virtual hard disk to be created. - -```yaml -Type: UInt64 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: UInt64 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SourceDisk -Specifies the physical disk to be used as the source for the virtual hard disk to be created. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: Number - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Differencing -Specifies that a differencing virtual hard disk is to be created. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Dynamic -Specifies that a dynamic virtual hard disk is to be created. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Fixed -Specifies that a fixed virtual hard disk is to be created. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VHDObject[] - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/New-VM.md b/docset/winserver2012-ps/hyper-v/New-VM.md deleted file mode 100644 index 376b643621..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VM.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VM - -## SYNOPSIS -Creates a new virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-VM [[-Name] ] [[-MemoryStartupBytes] ] [-AsJob] [-BootDevice ] - [-ComputerName ] [-NoVHD] [-Path ] [-SwitchName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-VM [[-Name] ] [[-MemoryStartupBytes] ] [-AsJob] [-BootDevice ] - [-ComputerName ] [-Path ] [-SwitchName ] -NewVHDPath - -NewVHDSizeBytes [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -New-VM [[-Name] ] [[-MemoryStartupBytes] ] [-AsJob] [-BootDevice ] - [-ComputerName ] [-Path ] [-SwitchName ] -VHDPath [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-VM** cmdlet creates a new virtual machine. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\>New-VM -Name "new 1" -MemoryStartupBytes 512MB -``` - -This example creates a new virtual machine named new 1 that has 512 MB of memory. - -### Example 2 -```powershell -PS C:\>New-VM -Name "new 2" -MemoryStartupBytes 1GB -NewVHDPath d:\vhd\base.vhdx -NewVHDSizeBytes 40GB -``` - -This example creates a virtual machine named new 2 that has 1 GB of memory and that is connected to a new 40 GB virtual hard disk that uses the VHDX format. - -### Example 3 -```powershell -PS C:\>New-VM -Name "new 3" -MemoryStartupBytes 1GB -VHDPath d:\vhd\BaseImage.vhdx -``` - -This example creates a virtual machine named new 3 that has 1 GB of memory and connects it to an existing virtual hard disk that uses the VHDX format. - -### Example 4 - -```powershell -New-VM -Name "new 4" -MemoryStartupBytes 2GB -Credential (Get-Credential) -ComputerName HostServer01 -``` - -This example asks for credentials, then creates a virtual machine named new 4, which has 2 GB of memory, on the server named HostServer01. - -### Example 5 - -```powershell -New-VM -Name "new 5" -BootDevice CD -NoVHD -``` - -This example creates a virtual machine named new 5. The machine doesn't have any VHD disk and is set to boot from CD. - -### Example 6 - -```powershell -$oldVM = Get-VM "old 1" -$memory = (Get-VMMemory -VMName $oldVM.name).Startup -$switch = (Get-VMNetworkAdapter -VMName $oldVM.name).SwitchName -New-VM -Name "new 6" -MemoryStartupBytes $memory -SwitchName $switch -``` - -This example creates a virtual machine named new 6. The machine has the same amount of assigned memory as the existing machine named old 1 and connects to the same network switch. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BootDevice -Specifies the device to use as the boot device for the new virtual machine. -Allowed values are **CD**, **Floppy**, **LegacyNetworkAdapter**, and **IDE**. -When LegacyNetworkAdapter is specified, this configures the new virtual machine with a legacy network adapter (which can be used to perform a PXE boot and install an operating system from a network installation server.) - -```yaml -Type: BootDevice -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryStartupBytes -Specifies the amount of memory, in bytes, to assign to the virtual machine. -The default value is 512 MB. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new virtual machine. -The default name is New virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: VMName - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -NewVHDPath -Creates a new virtual hard disk with the specified path and connects it to the new virtual machine. -Absolute paths are allowed. -If only a file name is specified, the virtual hard disk is created in the default path configured for the host. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NoVHD -Creates a virtual machine without attaching any virtual hard disks. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the directory to store the files for the new virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the friendly name of the virtual switch if you want to connect the new virtual machine to an existing virtual switch to provide connectivity to a network. -Hyper-V automatically creates a virtual machine with one virtual network adapter, but connecting it to a virtual switch is optional. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VHDPath -Specifies the path to a virtual hard disk file. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewVHDSizeBytes -Specifies the size of the dynamic virtual hard disk that is created and attached to the new virtual machine. - -```yaml -Type: UInt64 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.VirtualMachine - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/hyper-v/New-VMReplicationAuthorizationEntry.md b/docset/winserver2012-ps/hyper-v/New-VMReplicationAuthorizationEntry.md deleted file mode 100644 index bff02442d0..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VMReplicationAuthorizationEntry.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vmreplicationauthorizationentry?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VMReplicationAuthorizationEntry - -## SYNOPSIS -Creates a new authorization entry that allows one or more primary servers to replicate data to a specified Replica server. - -## SYNTAX - -``` -New-VMReplicationAuthorizationEntry [-AllowedPrimaryServer] [-ReplicaStorageLocation] - [-TrustGroup] [-ComputerName ] -``` - -## DESCRIPTION -The **New-VMReplicationAuthorizationEntry** cmdlet creates a new authorization entry that allows one or more primary servers to replicate data. -To use this cmdlet, the value of the ReplicationAllowedFromAnyServer property of the Replica server must be false. -You can use the Get-VMReplicationServer cmdlet to check the value of this property. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-VMReplicationAuthorizationEntry server01.domain01.contoso.com D:\ReplicaVMStorage DEFAULT -``` - -This example creates a replication authorization entry on the local server for a primary server named server01.domain01.contoso.com and a trust group named DEFAULT. -It also specifies D:\ReplicaVMStorage as the location to create replica virtual hard disks for virtual machines replicated from server01.domain01.contoso.com. - -### Example 2 -``` -PS C:\>New-VMReplicationAuthorizationEntry *.domain01.contoso.com D:\ReplicaVMStorage MyDomain01 -ComputerName server02.domain01.contoso.com -``` - -This example creates a replication authorization entry on server server02.domain01.contoso.com that allows replication from all primary servers in the domain domain01.contoso.com that also belong to the trust group MyDomain01. -It also specifies D:\ReplicaVMStorage as the location to create replica virtual hard disks for virtual machines replicated from these allowed primary servers. - -## PARAMETERS - -### -AllowedPrimaryServer -Specifies the server that is allowed to send replication data to the Replica server. -Only fully-qualified domain names and fully qualified international domain names are supported. -You can use a wildcard (for example, "*") in the first octect to specify a fully qualified domain name, such as *.contoso.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the authorization entry is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaStorageLocation -Specifies the location to store the Replica virtual hard disk files sent from the allowed server when a new Replica virtual machine is created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustGroup -Identifies a group of primary servers within which a given primary virtual machine can move so replications of the primary virtual machine are accepted by the Replica server only from primary servers that belong to the trust group. -You can use any string to create a new trust group. -Ensure all primary servers within a specific trust group use the same string as the value you specify for this parameter. - -Use of a trust group can help you keep virtual machines isolated by maintaining control over which primary servers are trusted to provide replication, while also allowing the virtual machines to move from one primary server to another (such as through live migration or failover from a cluster node). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### VMReplicationAuthorizationEntry - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/New-VMResourcePool.md b/docset/winserver2012-ps/hyper-v/New-VMResourcePool.md deleted file mode 100644 index 8ccae2363c..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VMResourcePool.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vmresourcepool?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VMResourcePool - -## SYNOPSIS -Creates a resource pool. - -## SYNTAX - -``` -New-VMResourcePool [-Name] [-ResourcePoolType] [[-ParentName] ] - [[-Paths] ] [-ComputerName ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-VMResourcePool** cmdlet creates a resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-VMResourcePool "New Resource Pool" VHD -Paths d:\VHDs -``` - -Creates a new virtual hard disk resource pool with associated with a single path. - -### Example 2 -``` -PS C:\>New-VMResourcePool "New Resource Pool" VHD -Paths "d:\VHDs","e:\Temp" -``` - -Creates a new virtual hard disk resrouce pool associated with multiple paths. - -### Example 3 -``` -PS C:\>New-VMResourcePool "New Resource Pool" Ethernet -``` - -Creates a new ethernet resource pool. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the resource pool is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource pool - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ParentName -Specifies the name of the parent resource pool for the new resource pool. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Paths -Specifies an array of paths to be associated with a new storage resource pool. - -```yaml -Type: Object[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the resource type of the resource pool. - -```yaml -Type: VMResourcePoolType[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.ResourcePool - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/New-VMSan.md b/docset/winserver2012-ps/hyper-v/New-VMSan.md deleted file mode 100644 index 903762ead1..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VMSan.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VMSan - -## SYNOPSIS -Creates a new virtual storage area network (SAN) on a Hyper-V host. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-VMSan [-Name] [-ComputerName ] [-HostBusAdapter ] [-Note ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-VMSan [-Name] [-ComputerName ] [-Note ] -WorldWideNodeName - -WorldWidePortName [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-VMSan** cmdlet creates a new virtual storage area network (SAN) on a Hyper-V host. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-VMSan -Name Production -Note "Production SAN" -WorldWideNodeName C003FF0000FFFF00 -WorldWidePortName C003FF5778E50002 -``` - -Creates a new virtual storage area network (SAN) with the specified Name, Note, WorldWideNodeName, and WorldWidePortName. - -## PARAMETERS - -### -ComputerName -Specifies the friendly name of a Hyper-V host on which the new virtual storage area network (SAN) is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -HostBusAdapter -Specifies the host bus adapter (HBA) to be associated with the virtual storage area network (SAN) to be created. -This can be retrieved by running the Get-InitiatorPort cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the virtual storage area network (SAN) to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Note -Specifies a note to be associated with the virtual storage area network (SAN) to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeName -Specifies the world wide node name (WWNN) of the host bus adapters to be associated with the virtual storage area network (SAN) to be created. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortName -Specifies the world wide port name (WWPN) of the host bus adapters to be associated with the virtual storage area network (SAN) to be created. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/New-VMSwitch.md b/docset/winserver2012-ps/hyper-v/New-VMSwitch.md deleted file mode 100644 index 39a6356149..0000000000 --- a/docset/winserver2012-ps/hyper-v/New-VMSwitch.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/new-vmswitch?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-VMSwitch - -## SYNOPSIS -Creates a new virtual switch on one or more virtual machine hosts. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-VMSwitch [-Name] [-AllowManagementOS ] [-ComputerName ] [-EnableIov ] - [-MinimumBandwidthMode ] [-Notes ] -NetAdapterName [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-VMSwitch [-Name] [-AllowManagementOS ] [-ComputerName ] [-EnableIov ] - [-MinimumBandwidthMode ] [-Notes ] -NetAdapterInterfaceDescription - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -New-VMSwitch [-Name] [-ComputerName ] [-EnableIov ] - [-MinimumBandwidthMode ] [-Notes ] -SwitchType [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **New-VMSwitch** cmdlet creates a new virtual switch on one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>New-VMSwitch "QoS Switch" -NetAdapterName "Wired Ethernet Connection 3" -MinimumBandwidthMode Weight -``` - -Creates a new switch QoS switch, which binds to a network adapter called Wired Ethernet Connection 3 and supports weight-based minimum bandwidth. - -## PARAMETERS - -### -AllowManagementOS -Specifies whether the parent partition (i.e. -the management operating system) is to have access to the physical NIC bound to the virtual switch to be created. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual switch is to be created. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: PSComputerName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableIov -Specifies that IO virtualization is to be enabled on the virtual switch to be created. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumBandwidthMode -Specifies how minimum bandwidth is to be configured on the virtual switch. -Allowed values are **Absolute**, **Default**, **None**, or **Weight**. -If **Absolute** is specified, minimum bandwidth is bits per second. -If **Weight** is specified, minimum bandwidth is a value ranging from 1 to 100. -If **None** is specified, minimum bandwidth is disabled on the switch - that is, users cannot configure it on any network adapter connected to the switch. -If **Default** is specified, the system will set the mode to **Weight**, if the switch is not IOV-enabled, or **None** if the switch is IOV-enabled. - -```yaml -Type: VMSwitchBandwidthMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: Weight -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the switch to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: SwitchName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies a note to be associated with the switch to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchType -Specifies the type of the switch to be created. -Allowed values are **Internal** and **Private**. -To create an External virtual switch, specify either the **NetAdapterInterfaceDescription** or the **NetAdapterName** parameter, which implicitly set the type of the virtual switch to External. - -```yaml -Type: VMSwitchType -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetAdapterInterfaceDescription -Specifies the interface description of the network adapter to be bound to the switch to be created. -You can use the Get-NetAdapter cmdlet to get the interface description of a network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: InterfaceDescription - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetAdapterName -Specifies the name of the network adapter to be bound to the switch to be created. -You can use the Get-NetAdapter cmdlet to get the interface description of a network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: InterfaceAlias - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Virtualization.Powershell.EthernetSwitch - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Optimize-VHD.md b/docset/winserver2012-ps/hyper-v/Optimize-VHD.md deleted file mode 100644 index 0a4efe871a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Optimize-VHD.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/optimize-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Optimize-VHD - -## SYNOPSIS -Optimizes the allocation of space used by virtual hard disk files, except for fixed virtual hard disks. - -## SYNTAX - -``` -Optimize-VHD [-Path] [-AsJob] [-ComputerName ] [-Mode ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Optimize-VHD** cmdlet optimizes the allocation of space in one or more virtual hard disk files, except for fixed virtual hard disks. -The **Compact** operation is used to optimize the files. -This operation reclaims unused blocks as well as rearranges the blocks to be more efficiently packed, which reduces the size of a virtual hard disk file. - -To use Optimize-VHD, the virtual hard disk must not be attached or must be attached in read-only mode. - -The compact operation can succeed without reducing the file size, if no optimization is possible. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Optimize-VHD -Path c:\test\dynamic.vhdx -Mode Full -``` - -Runs the compact operation in Full mode. -(If the VHDX-format file is not attached as read-only prior to the operation, it will default to Prezeroed mode.) - -### Example 2 -``` -PS C:\> Optimize-VHD -Path c:\test\dynamic.vhdx -Mode Retrim -``` - -Runs the compact operation in Retrim mode. -(If the VHDX-format disk is not mounted as read-only prior to the operation, running the cmdlet returns an error.) - -### Example 3 -``` -PS C:\>Optimize-VHD -Path c:\test\dynamic.vhdx -Mode Quick -``` - -Runs the compact operation in Quick mode. -(If the VHDX-format file is not attached as read-only prior to the operation, it defaults to Pretrimmed mode.) - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual machine is to be optimized. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Mode -Specifies the mode in which the virtual hard disk is to be optimized. -For a **VHD** disk, the default mode is **Full**. -For a **VHDX** disk, the default mode is **Quick**. -Valid modes are as follows: - ---**Full** scans for zero blocks and reclaims unused blocks. (Allowable only if the virtual hard disk is mounted read-only.) ---**Pretrimmed** performs as **Quick** mode, but does not require the virtual hard disk to be mounted read-only. The detection of unused space is less effective than **Quick** mode (in which the virtual hard disk had been mounted read-only) because the scan cannot query information about free space in the NTFS file system within the virtual hard disk. Useful when the VHDX-format file has been used by operating system instances that are at least Windows 8 or Windows Server 2012, or when this cmdlet has already been run on a .vhdx file in **Retrim** mode. ---**Prezeroed** performs as **Quick** mode, but does not require the virtual hard disk to be mounted read-only. The unused space detection will be less effective than if the virtual hard disk had been mounted read-only as the scan will be unable to query information about free space in the NTFS file system within the virtual hard disk. Useful if a tool was run previously to zero all the free space on the virtual disk as this mode of compaction can then reclaim that space for subsequent block allocations. This form of compaction can also be useful in handling virtual hard disk containing file systems other than NTFS. ---**Quick** reclaims unused blocks, but does not scan for zero blocks. (Allowable only if the virtual hard disk is mounted read-only.) ---**Retrim** sends down retrims without scanning for zero blocks or reclaiming unused blocks. (Allowable only if the virtual hard disk is mounted read-only.) - -```yaml -Type: VhdCompactMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual hard disk to be optimized. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies one or more paths to the dynamic or differencing virtual hard disk files to be optimized. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: FullName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VM.md b/docset/winserver2012-ps/hyper-v/Remove-VM.md deleted file mode 100644 index 82731069f4..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VM.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VM - -## SYNOPSIS -Deletes a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VM [-Name] [-AsJob] [-ComputerName ] [-Force] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VM [-VM] [-AsJob] [-Force] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VM** cmdlet deletes a virtual machine. -Running this cmdlet deletes the virtual machine's configuration file, but does not delete any virtual hard drives. -If the virtual machine has any snapshots, these are deleted and merged into the virtual hard disk files after the virtual machine is deleted. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VM "new 1" -ConfirmAre you sure you want to remove virtual machine "new 1"? -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Removes virtual machine new 1. - -### Example 2 -``` -PS C:\>Remove-VM -Name "new 2" -Force -``` - -Removes virtual machine new 2, suppressing the confirmation prompt. - -### Example 3 -``` -PS C:\>Get-VM -Name New* | Remove-VM -Force -``` - -Removes with no confirmation prompt all virtual machines having names starting with New. - -## PARAMETERS - -### -AsJob -Specifies that this cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts from which the virtual machine is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that confirmation prompts are to be suppressed during deletion of the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be deleted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual machine to be deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be deleted. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMDvdDrive.md b/docset/winserver2012-ps/hyper-v/Remove-VMDvdDrive.md deleted file mode 100644 index fd55de49b8..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMDvdDrive.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmdvddrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMDvdDrive - -## SYNOPSIS -Deletes a DVD drive from a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMDvdDrive [-VMName] [-ControllerNumber] [-ControllerLocation] - [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMDvdDrive [-VMDvdDrive] [-Passthru] -``` - -## DESCRIPTION -The **Remove-VMDvdDrive** cmdlet deletes a DVD drive from a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 -``` - -Removes the virtual DVD drive at IDE 1,0 on virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VMDvdDrive -VMName TestVM -ControllerNumber 1 | Remove-VMDvdDrive -``` - -Removes all virtual DVD drives on IDE controller 1 of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the DVD drive is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the DVD drive to be deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMDvdDrive -Specifies the DVD drive to be deleted. - -```yaml -Type: DvdDrive[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller at which the DVD drive is to be deleted. -If not specified, the number of the first available location on the controller is used. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller from which the DVD drive is to be deleted. -If not specified, the first IDE controller on which the specified **ControllerLocation** is available is used. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the DVD drive is to be deleted. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.DriveController -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMFibreChannelHba.md b/docset/winserver2012-ps/hyper-v/Remove-VMFibreChannelHba.md deleted file mode 100644 index 52113d9cee..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMFibreChannelHba.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmfibrechannelhba?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMFibreChannelHba - -## SYNOPSIS -Removes a Fibre Channel host bus adapter from a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMFibreChannelHba [-VMFibreChannelHba] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMFibreChannelHba [-VMName] [-WorldWideNodeNameSetA] [-WorldWidePortNameSetA] - [-WorldWideNodeNameSetB] [-WorldWidePortNameSetB] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMFibreChannelHba** removes a Fibre Channel host bus adapter from a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMFibreChannelHba -VMName MyVM | Remove-VMFibreChannelHba -``` - -Removes a Fibre Channel host bus adapter from a virtual machine MyVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the Fibre Channel host bus adapter is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to be pipeline representing the removed Fibre Channel host bus adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMFibreChannelHba -Specifies one or more Fibre Channel host bus adapters to be removed from a virtual machine. - -```yaml -Type: VMFibreChannelHba[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the virtual machine from which the Fibre Channel host bus adapters are to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeNameSetA -Specifies the World Wide Node name of address set A associated with the Fibre Channel host bus adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeNameSetB -Specifies the World Wide Node name of address set B associated with the Fibre Channel host bus adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortNameSetA -Specifies the World Wide Port name of address set A associated with the Fibre Channel host bus adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortNameSetB -Specifies the World Wide Port name of address set B associated with the Fibre Channel host bus adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMFibreChannelHba -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMHardDiskDrive.md b/docset/winserver2012-ps/hyper-v/Remove-VMHardDiskDrive.md deleted file mode 100644 index 781785668b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMHardDiskDrive.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmharddiskdrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMHardDiskDrive - -## SYNOPSIS -Deletes a hard disk drive from a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMHardDiskDrive [-VMName] [-ControllerType] [-ControllerNumber] - [-ControllerLocation] [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMHardDiskDrive [-VMHardDiskDrive] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMHardDiskDrive** cmdlet deletes a hard disk drive from a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMHardDiskDrive -VMName TestVM -ControllerType IDE -ControllerNumber 1 -ControllerLocation 0 -``` - -Removes the virtual hard drive at IDE 1,0 on virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VMHardDiskDrive -VMName TestVM -ControllerType IDE -ControllerNumber 1 | Remove-VMHardDiskDrive -``` - -Removes all virtual hard drives on IDE controller 1 from virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the virtual hard disk drive is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to be pipeline representing the virtual hard disk drive to be deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMHardDiskDrive -Specifies the virtual hard disk drive to be deleted. - -```yaml -Type: HardDiskDrive[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller at which the virtual hard disk drive is to be deleted. -If not specified, the number of the first available location on the controller is used. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller from which the virtual hard disk drive is to be deleted. -If not specified, the first controller on which the specified **ControllerLocation** is available is used. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerType -Specifies the type of the controller where the virtual hard disk is to be deleted. -Allowed values are **IDE** and **SCSI**. - -```yaml -Type: ControllerType -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the virtual hard disk is to be deleted. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.HardDiskDrive[] - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.DriveController -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMMigrationNetwork.md b/docset/winserver2012-ps/hyper-v/Remove-VMMigrationNetwork.md deleted file mode 100644 index 67cf7b01d8..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMMigrationNetwork.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmmigrationnetwork?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMMigrationNetwork - -## SYNOPSIS -Removes a network from use with migration. - -## SYNTAX - -``` -Remove-VMMigrationNetwork [-Subnet] [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMMigrationNetwork** cmdlet removes a network from use with migration. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMMigrationNetwork 2001:836c:6456:1c99::/64 -``` - -Remove an IPv6 network for use with migration. - -### Example 2 -``` -PS C:\>Remove-VMMigrationNetwork 192.168.* -``` - -Remove all networks starting with 192.168 for use with migration. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the network is to be removed from use with migration. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.MigrationNetwork** object is to be passed through to the pipeline representing the network removed from use with migration. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a string representing an IPv4 or IPv6 subnet mask which identifies the network to be removed from use with migration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.MigrationNetwork -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Remove-VMNetworkAdapter.md deleted file mode 100644 index 2c5524e923..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMNetworkAdapter.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMNetworkAdapter - -## SYNOPSIS -Removes one or more virtual network adapters from a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMNetworkAdapter [-VMName] [-ComputerName ] [-Name ] [-Passthru] - [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMNetworkAdapter [-ComputerName ] [-Name ] [-Passthru] [-SwitchName ] - [-VMNetworkAdapterName ] [-ManagementOS] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMNetworkAdapter [-VM] [-Name ] [-Passthru] [-VMNetworkAdapterName ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Remove-VMNetworkAdapter [-VMNetworkAdapter] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMNetworkAdapter** cmdlet removes one or more virtual network adapters from a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMNetworkAdapter -VMName Redmond -VMNetworkAdapterName Redmond_NIC1 -``` - -This example removes network adapter Redmond_NIC1 from a virtual machine named Redmond. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual network adapter is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies the management operating system of the virtual network adapter to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object to be passed through to the pipeline representing the virtual machine network adapter to be removed. -This is a **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** object, if **-ManagementOS** is specified; otherwise it is a **Microsoft.Virtualization.Powershell.VMNetworkAdapter** object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine that has the virtual network adapter you want to remove. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that has the virtual network adapter you want to remove. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter to be removed. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual network adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: VMNetworkAdapterName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch connected to the virtual network adapter to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default. -If **-PassThru** is specified, **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter**, if **-ManagementOS** is also specified;otherwise **Microsoft.Virtualization.Powershell.VMNetworkAdapter**. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMNetworkAdapterAcl.md b/docset/winserver2012-ps/hyper-v/Remove-VMNetworkAdapterAcl.md deleted file mode 100644 index 96a24eae71..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMNetworkAdapterAcl.md +++ /dev/null @@ -1,354 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmnetworkadapteracl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMNetworkAdapterAcl - -## SYNOPSIS -Removes an ACL applied to the traffic through a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMNetworkAdapterAcl [-VMName] [-ComputerName ] [-LocalIPAddress ] - [-LocalMacAddress ] [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] - [-VMNetworkAdapterName ] -Action -Direction - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMNetworkAdapterAcl [-ComputerName ] [-LocalIPAddress ] - [-LocalMacAddress ] [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] - [-VMNetworkAdapterName ] -Action -Direction - [-ManagementOS] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMNetworkAdapterAcl [-VM] [-LocalIPAddress ] [-LocalMacAddress ] - [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] [-VMNetworkAdapterName ] - -Action -Direction [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Remove-VMNetworkAdapterAcl [-VMNetworkAdapter] [-LocalIPAddress ] - [-LocalMacAddress ] [-Passthru] [-RemoteIPAddress ] [-RemoteMacAddress ] - -Action -Direction [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Remove-VMNetworkAdapterAcl [-InputObject] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMNetworkAdapterAcl** cmdlet removes an ACL applied to the traffic through a virtual network adapter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMNetworkAdapterAcl -VMName Redmond -RemoteIPAddress 0.0.0.0/0 -Direction Both -Action Allow -``` - -Removes from virtual machine Redmond the ACL allowing any IPv4 traffic sent from or to the virtual machine. - -### Example 2 -``` -PS C:\>Remove-VMNetworkAdapterAcl -VMName Redmond -RemoteIPAddress ::/0 -Direction Both -Action Allow -``` - -Removes from virtual machine Redmond the ACL that allows any IPv6 traffic sent from and to the virtual machine. - -### Example 3 -``` -PS C:\>Remove-VMNetworkAdapterAcl -VMName Redmond -RemoteMacAddress 03-0f-01-0e-aa-b2 -Direction Both -Action Deny -``` - -Removes the MAC ACL to prevent virtual machine Redmond from sending traffic to or receiving traffic from a remote device with MAC address 03-0f-01-0e-aa-b2. - -### Example 4 -``` -PS C:\>Get-VMNetworkAdapterAcl -VMName Redmond | Remove-VMNetworkAdapterAcl -``` - -Retrieves all the port ACLs configured for virtual machine Redmond and pipelines them to Remove-VMNetworkAdapterAcl, which removes all of them from the virtual machine. - -## PARAMETERS - -### -Action -Specifies the action of the ACL to be removed. -Allowed values are **Allow**, **Deny**, and **Meter**. - -```yaml -Type: VMNetworkAdapterAclAction -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the ACL applied to a virtual machine network adapter is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Direction -The direction of the network traffic (from the perspective of the virtual machine) to which the ACL applies. -Allowed values are **Inbound**, **Outbound**, or **Both**. - -```yaml -Type: VMNetworkAdapterAclDirection -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the ACL to be removed. - -```yaml -Type: VMNetworkAdapterAclSetting[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalIPAddress -Specifies the local IP address. -It can be either IPv4 or IPv6 address. -It can be either a host address or a subnet address, e.g. -1.2.3.4, 2001::2008, 192.168.1.0/24, or f001:f002:f003:f004::1/64.the IP address can also be a wildcard, 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all IPv4 and IPv6 addresses. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalMacAddress -Specifies the local MAC address (e.g. -00-ab-00-11-22-33). -Use the wildcard **ANY** to specify all MAC addresses. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the ACL is to be removed from the management (e.g. -the parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VMNetworkAdapterAclSetting** object is to be passed through to the pipeline representing the ACL to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteIPAddress -Specifies the remote IP address. -. It can be either IPv4 or IPv6 address. -It can be either a host address or a subnet address, e.g. -1.2.3.4, 2001::2008, 192.168.1.0/24, or f001:f002:f003:f004::1/64. -the IP address can also be a wildcard, 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all IPv4 and IPv6 addresses. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteMacAddress -Specifies the remote MAC address. -. It can be a host MAC address, e.g. -00-ab-00-11-22-33, or a wildcard, ANY, for all MAC addresses. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which the ACL is to be removed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the ACL is to be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter from which ACL is to be removed. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual machine network adapter from which the ACL is to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default, **Microsoft.Virtualization.Powershell.VMNetworkAdapterAclSetting** if **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMRemoteFx3dVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Remove-VMRemoteFx3dVideoAdapter.md deleted file mode 100644 index c8afb3f8b0..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMRemoteFx3dVideoAdapter.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmremotefx3dvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMRemoteFx3dVideoAdapter - -## SYNOPSIS -Removes a RemoteFX 3D video adapter from a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMRemoteFx3dVideoAdapter [-VMName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMRemoteFx3dVideoAdapter [-VM] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMRemoteFx3dVideoAdapter [-VMRemoteFx3dVideoAdapter] [-Passthru] -``` - -## DESCRIPTION -The **Remove-VMRemoteFx3dVideoAdapter** cmdlet removes a RemoteFX 3D video adapter from a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMRemoteFx3dVideoAdapter -VMName TestVM1,TestVM2 -``` - -Removes the RemoteFX adapter from virtual machines TestVM1 and TestVM2. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a RemoteFX 3D video adapter is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMRemoteFxVideoAdapter** object is to be to be passed through to the pipeline representing the RemoteFX 3D video adapter to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMRemoteFx3dVideoAdapter -Specifies the RemoteFX 3D video adapater to be removed. - -```yaml -Type: VMRemoteFx3DVideoAdapter[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which the RemoteFX 3D video adapter to be removed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the RemoteFX 3D video adapter is to be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMRemoteFxVideoAdapter -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMReplication.md b/docset/winserver2012-ps/hyper-v/Remove-VMReplication.md deleted file mode 100644 index 3b6001df6b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMReplication.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMReplication - -## SYNOPSIS -Removes the replication relationship of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMReplication [-VMName] [-ComputerName ] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMReplication [-VM] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMReplication [-VMReplication] [-PassThru] -``` - -## DESCRIPTION -The **Remove-VMReplication** removes the replication relationship of a virtual machine. -Replication must be removed independently from both the primary and Replica virtual machines. -Removing replication on a Replica virtual machine does not delete the Replica virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMReplication VM01 -``` - -This example removes the replication relationship of virtual machine VM01. - -### Example 2 -``` -PS C:\>Remove-VMReplication * -``` - -This example removes the replication relationships from all replica-enabled virtual machines on the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the replication relationship of a virtual machine is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplication** object is to be passed through to the pipeline representing the virtual machine for which the replication relationship will be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which the replication relationship is to be removed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which the replication relationship is to be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies a virtual machine replication object associated with the virtual machine whose replication relationship is to be removed. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplication -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMReplicationAuthorizationEntry.md b/docset/winserver2012-ps/hyper-v/Remove-VMReplicationAuthorizationEntry.md deleted file mode 100644 index 3acf8263f1..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMReplicationAuthorizationEntry.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmreplicationauthorizationentry?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMReplicationAuthorizationEntry - -## SYNOPSIS -Removes an authorization entry from a Replica server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMReplicationAuthorizationEntry [-AllowedPrimaryServer] [-ComputerName ] [-PassThru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMReplicationAuthorizationEntry [-TrustGroup] [-ComputerName ] [-PassThru] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMReplicationAuthorizationEntry [-VMReplicationAuthorizationEntry] - [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMReplicationAuthorizationEntry** cmdlet removes an authorization entry from a Replica server, which cancels authorization for the primary server associated with the entry. -After the authorization entry is removed, the Replica server does not accept replication data from the corresponding primary server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMReplicationAuthorizationEntry -AllowedPrimaryServer server01.domain01.contoso.com -``` - -This example removes an authorization entry on the local Replica server for allowed primary server server01.domain01.contoso.com. - -### Example 2 -``` -PS C:\>Get-VMReplicationAuthorizationEntry | Remove-VMReplicationAuthorizationEntry -``` - -This example removes all authorization entries on the local Replica server. - -## PARAMETERS - -### -AllowedPrimaryServer -Specifies the allowed primary server for which the authorization entry is to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: AllowedPS - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the authorization entry is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplicationAuthorizationEntry** object is to be passed through to the pipeline representing the authorization entry to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustGroup -Specifies the trust group for which the authorization entries are to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMReplicationAuthorizationEntry -Specifies the authorization entry to be removed. - -```yaml -Type: VMReplicationAuthorizationEntry[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: VMRepAuthEntry - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplicationAuthorizationEntry -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMResourcePool.md b/docset/winserver2012-ps/hyper-v/Remove-VMResourcePool.md deleted file mode 100644 index db671c2761..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMResourcePool.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmresourcepool?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMResourcePool - -## SYNOPSIS -Deletes a resource pool from one or more virtual machine hosts. - -## SYNTAX - -``` -Remove-VMResourcePool [-Name] [-ResourcePoolType] [-ComputerName ] - [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMResourcePool** deletes a resource pool from one or more virtual machine hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMResourcePool Test VHD -``` - -Removes a virtual hard disk resource pool named Test. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the resource pool is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the resource pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that a **VMResourcePool** object is to be passed through to the pipeline representing the removed resource pool. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the type of the resource pool to be deleted. - -```yaml -Type: VMResourcePoolType[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMResourcePool -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMSan.md b/docset/winserver2012-ps/hyper-v/Remove-VMSan.md deleted file mode 100644 index b3db5dc055..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMSan.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMSan - -## SYNOPSIS -Removes a virtual storage area network (SAN) from a Hyper-V host. - -## SYNTAX - -``` -Remove-VMSan [-Name] [-ComputerName ] [-Passthru] -``` - -## DESCRIPTION -The **Remove-VMSan** cmdlet removes a virtual storage area network (SAN) from a Hyper-V host. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMSan -Name Production -``` - -Removes the virtual storage area network named Production from the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies a Hyper-V host from which the virtual storage area network (SAN) is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual storage area network (SAN) to be removed from the Hyper-V host. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the removed virtual machine storage area network. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.SAN -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMSavedState.md b/docset/winserver2012-ps/hyper-v/Remove-VMSavedState.md deleted file mode 100644 index 3e23b1dcec..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMSavedState.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmsavedstate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMSavedState - -## SYNOPSIS -Deletes the saved state of a saved virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMSavedState [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMSavedState [-VM] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMSavedState [-VMSnapshot] -``` - -## DESCRIPTION -Deletes the saved state of a saved virtual machine. -Note: data contained in the memory of the virtual machine may be lost; data on its virtual hard disk drives are unaffected. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMSavedState TestVM -``` - -Removes the saved state from virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VMSnapshot TestVM | Remove-VMSavedState -``` - -Removes the saved state from all snapshots belonging to virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine saved state is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose saved state is to be deleted. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose saved state is to be deleted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot whose saved state is to be deleted. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMScsiController.md b/docset/winserver2012-ps/hyper-v/Remove-VMScsiController.md deleted file mode 100644 index 02773ecc3c..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMScsiController.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmscsicontroller?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMScsiController - -## SYNOPSIS -Removes a SCSI controller from a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMScsiController [-VMName] [-ControllerNumber] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMScsiController [-VMScsiController] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMScsiController** cmdlet removes a SCSI controller from a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMScsiController -VMName TestVM -ControllerNumber 0 | Remove-VMScsiController -``` - -Deletes SCSI controller 0 from virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the SCSI controller is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber - - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMScsiController** object is to be passed through to the pipeline representing the SCSI controller to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName - - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMScsiController -Specifies the SCSI controller to be removed. - -```yaml -Type: VMScsiController[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMScsiController -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMSnapshot.md b/docset/winserver2012-ps/hyper-v/Remove-VMSnapshot.md deleted file mode 100644 index c73a8ed16b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMSnapshot.md +++ /dev/null @@ -1,202 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmsnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMSnapshot - -## SYNOPSIS -Deletes a virtual machine snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMSnapshot [-VMName] [[-Name] ] [-AsJob] [-ComputerName ] - [-IncludeAllChildSnapshots] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMSnapshot [-VM] [[-Name] ] [-AsJob] [-IncludeAllChildSnapshots] - [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMSnapshot [-VMSnapshot] [-AsJob] [-IncludeAllChildSnapshots] [-Passthru] -``` - -## DESCRIPTION -The **Remove-VMSnapshot** deletes a virtual machine snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VM TestVM | Remove-VMSnapshot -Name Experiment* -``` - -Deletes all snapshots of virtual machine TestVM whose names starts with Experiment. - -### Example 2 -``` -PS C:\>Get-VMSnapshot -VMName TestVM | Where-Object {$_.CreationTime -lt (Get-Date).AddDays(-90) } | Remove-VMSnapshot -``` - -Deletes all snapshots of virtual machine TestVM older than 90 days. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which a snapshot is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeAllChildSnapshots -Specifies that the snapshot's children are to be deleted along with the snapshot. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the snapshot to be deleted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the snapshot to be deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine of which the snapshot is to be deleted. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine of which the snapshot is to be deleted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the snapshot to be deleted. - -```yaml -Type: VMSnapshot[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMStoragePath.md b/docset/winserver2012-ps/hyper-v/Remove-VMStoragePath.md deleted file mode 100644 index 707a390144..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMStoragePath.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmstoragepath?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMStoragePath - -## SYNOPSIS -Removes a path from a storage resource pool. - -## SYNTAX - -``` -Remove-VMStoragePath [-Path] [-ResourcePoolName] [-ResourcePoolType] - [-ComputerName ] [-PassThru] -``` - -## DESCRIPTION -The **Remove-VMStoragePath** cmdlet removes a path from a storage resource pool. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMStoragePath -Path D:\Test -ResourcePoolName VHD1 -ResourcePoolType VHD -``` - -Removes path D:\Test from VHD resource pool VHD1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a path is to be removed from a resource pool. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **System.String** is to be passed through to the pipeline representing the path to be removed from the resource pool. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to be removed from the storage resource pool. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the resource pool from which the path is to be removed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the type of the resource pool from which the path is to be removed. -Allowed values are **VFD**, **ISO**, and **VHD**. - -```yaml -Type: VMResourcePoolType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### System.String -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMSwitch.md b/docset/winserver2012-ps/hyper-v/Remove-VMSwitch.md deleted file mode 100644 index 0d346c0588..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMSwitch.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmswitch?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMSwitch - -## SYNOPSIS -Deletes a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMSwitch [-Name] [[-ResourcePoolName] ] [-ComputerName ] [-Force] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMSwitch [-VMSwitch] [[-ResourcePoolName] ] [-Force] -``` - -## DESCRIPTION -The **Remove-VMSwitch** cmdlet deletes a virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Remove-VMSwitch "QoS Switch" -``` - -Removes a virtual switch named Qos Switch. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual switch is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual switch to be deleted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -ResourcePoolName -Specifies the name of the resource pool from which the switch is to be deleted. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMSwitch -Specifies the virtual switch to be deleted. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMSwitchExtensionPortFeature.md b/docset/winserver2012-ps/hyper-v/Remove-VMSwitchExtensionPortFeature.md deleted file mode 100644 index bc9b256389..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMSwitchExtensionPortFeature.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmswitchextensionportfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMSwitchExtensionPortFeature - -## SYNOPSIS -Removes a feature from a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMSwitchExtensionPortFeature [-VMName] [-ComputerName ] [-Passthru] - [-VMNetworkAdapterName ] -VMSwitchExtensionFeature [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMSwitchExtensionPortFeature [-SwitchName] [-ComputerName ] [-Passthru] - [-ExternalPort] -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-VMSwitchExtensionPortFeature [-ComputerName ] [-Passthru] [-VMNetworkAdapterName ] - [-ManagementOS] -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Remove-VMSwitchExtensionPortFeature [-VM] [-Passthru] [-VMNetworkAdapterName ] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Remove-VMSwitchExtensionPortFeature [-VMNetworkAdapter] [-Passthru] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMSwitchExtensionPortFeature** removes a feature from a virtual network adapter. -The feature must have already been configured on the virtual network adapter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$feature = Get-VMSwitchExtensionPortFeature -VMName VM2 -FeatureId 776e0ba7-94a1-41c8-8f28-951f524251b5 -PS C:\>Remove-VMSwitchExtensionPortFeature VM2 -VMSwitchExtensionFeature $feature -``` - -Removes a feature configured on the virtual network adapter(s) on a virtual machine. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the feature is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalPort -Specifies the external port on the virtual switch that binds to a physical network adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that the feature is to be removed from the management (e.g. -the parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.HyperV.PowerShell.VMSwitchExtensionPortFeature** is to be passed through to the pipeline representing the feature to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch from which the feature is to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine from which the feature is to be removed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine from which the feature is to be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter from which the feature is to be removed. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter from which the feature is to be removed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be removed. - -```yaml -Type: VMSwitchExtensionPortFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMSwitchExtensionPortFeature -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Remove-VMSwitchExtensionSwitchFeature.md b/docset/winserver2012-ps/hyper-v/Remove-VMSwitchExtensionSwitchFeature.md deleted file mode 100644 index 8e5784702d..0000000000 --- a/docset/winserver2012-ps/hyper-v/Remove-VMSwitchExtensionSwitchFeature.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/remove-vmswitchextensionswitchfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-VMSwitchExtensionSwitchFeature - -## SYNOPSIS -Removes a feature from a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-VMSwitchExtensionSwitchFeature [-SwitchName] [-ComputerName ] [-Passthru] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-VMSwitchExtensionSwitchFeature [-VMSwitch] [-Passthru] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-VMSwitchExtensionSwitchFeature** removes a feature from a virtual switch. -The feature already must have been configured on the virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$feature = Get-VMSwitchExtensionSwitchFeature -SwitchName External -FeatureId 3eb2b8e8-4abf-4dbf-9071-16dd47481fbe -PS C:\>Remove-VMSwitchExtensionSwitchFeature External $feature -``` - -Removes a feature from virtual switch External. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts from which the feature is to be removed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.HyperV.PowerShell.VMSwitchExtensionSwitchFeature** is to be passed through to the pipeline representing the feature to be removed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch from which the feature is to be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch from which the feature is to be removed. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be removed. - -```yaml -Type: VMSwitchExtensionSwitchFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMSwitchExtensionSwitchFeature -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Rename-VM.md b/docset/winserver2012-ps/hyper-v/Rename-VM.md deleted file mode 100644 index 7bed6c0ab2..0000000000 --- a/docset/winserver2012-ps/hyper-v/Rename-VM.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/rename-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-VM - -## SYNOPSIS -Renames a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Rename-VM [-Name] [-NewName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Rename-VM [-VM] [-NewName] [-Passthru] -``` - -## DESCRIPTION -The **Rename-VM** cmdlet renames a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Rename-VM VM1 -NewName VM2 -``` - -Renames virtual machine VM1 to VM2. - -### Example 2 -``` -PS C:\>Get-VM VM1 | Rename-VM -NewName VM2 -PassThru -``` - -Renames virtual machine VM1 to VM2 and displays the renamed virtual machine. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be deleted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be renamed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -NewName -Specifies the name to which the virtual machine is to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual machine to be renamed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be renamed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Rename-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Rename-VMNetworkAdapter.md deleted file mode 100644 index c68d1f4760..0000000000 --- a/docset/winserver2012-ps/hyper-v/Rename-VMNetworkAdapter.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/rename-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-VMNetworkAdapter - -## SYNOPSIS -Renames a virtual network adapter on a virtual machine or on the management operating system. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Rename-VMNetworkAdapter [-VMName] [-NewName] [-ComputerName ] [-Name ] - [-Passthru] [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Rename-VMNetworkAdapter [-NewName] [-ComputerName ] [-Name ] [-Passthru] - [-VMNetworkAdapterName ] [-ManagementOS] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Rename-VMNetworkAdapter [-VM] [-NewName] [-Name ] [-Passthru] - [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Rename-VMNetworkAdapter [-VMNetworkAdapter] [-NewName] [-Passthru] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Rename-VMNetworkAdapter** cmdlet renames a virtual network adapter on a virtual machine or on the management operating system. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Rename-VMNetworkAdapter -VMName Redmond -NewName CoreNet -``` - -This example renames all the virtual network adapters of virtual machine Redmond to CoreNet. - -### Example 1 -``` -PS C:\>Rename-VMNetworkAdapter -VMName Kirkland -Name Private -NewName CoreNet -``` - -This example renames the virtual network adapter Private to CoreNet in virtual machine Kirkland. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual network adapter is to be renamed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies that you want to rename a virtual network adapter that belongs to the management operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the existing name of the virtual network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: VMNetworkAdapterName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name for the virtual network adapter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual network adapter to be renamed. -This is a **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** object, if ManagementOS is specified; otherwise it is a **Microsoft.Virtualization.PowerShell.VMNetworkAdapter** object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine that has the virtual network adapter you want to rename. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that has the virtual network adapter you want to rename. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter to be renamed. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the existing name of the virtual network adapter you want to rename. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default. -If **-PassThru** is specified, then a **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** object is passed through to the pipeline if **-ManagementOS** is also specified; otherwise a **Microsoft.Virtualization.PowerShell.VMNetworkAdapter** is passed. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Rename-VMResourcePool.md b/docset/winserver2012-ps/hyper-v/Rename-VMResourcePool.md deleted file mode 100644 index 0422069cc1..0000000000 --- a/docset/winserver2012-ps/hyper-v/Rename-VMResourcePool.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/rename-vmresourcepool?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-VMResourcePool - -## SYNOPSIS -Renames a resource pool on one or more Hyper-V hosts. - -## SYNTAX - -``` -Rename-VMResourcePool [-Name] [-ResourcePoolType] [-NewName] - [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Rename-VMResourcePool** cmdlet renames a resource pool on one or more Hyper-V hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Rename-VMResourcePool Test VHD Production -``` - -Renames a VHD resource pool from Test to Production. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the resource pool is to be renamed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the friendly name of the resource pool to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -NewName -Specifies the name to which the specified resource pool is to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMResourcePool** object is to be passed through to the pipeline representing the resource pool to be renamed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the type of the resource pool to be renamed. - -```yaml -Type: VMResourcePoolType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMResourcePool -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Rename-VMSan.md b/docset/winserver2012-ps/hyper-v/Rename-VMSan.md deleted file mode 100644 index 90138f303b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Rename-VMSan.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/rename-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-VMSan - -## SYNOPSIS -Renames a virtual storage area network (SAN). - -## SYNTAX - -``` -Rename-VMSan [-Name] [-NewName] [-ComputerName ] [-Passthru] -``` - -## DESCRIPTION -The **Rename-VMSan** cmdlet renames a virtual storage area network (SAN). - -## EXAMPLES - -### Example 1 -``` -PS C:\>Rename-VMSan -Name Production -NewName Test -``` - -Renames a virtual storage area network from Production to Test. - -## PARAMETERS - -### -ComputerName -Specifies the name of the Hyper-V host on which the virtual storage area network (SAN) is to be renamed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the current name of the virtual storage area network (SAN) to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name of the virtual storage area network (SAN) to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the renamed virtual storage area network (SAN). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.PowerShell.SAN -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Rename-VMSnapshot.md b/docset/winserver2012-ps/hyper-v/Rename-VMSnapshot.md deleted file mode 100644 index 2c56a7edf8..0000000000 --- a/docset/winserver2012-ps/hyper-v/Rename-VMSnapshot.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/rename-vmsnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-VMSnapshot - -## SYNOPSIS -Renames a virtual machine snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Rename-VMSnapshot [-Name] [-VMName] [-NewName] [-ComputerName ] - [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Rename-VMSnapshot [-VM] [-NewName] [-Passthru] [-Name] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Rename-VMSnapshot [-VMSnapshot] [-NewName] [-Passthru] -``` - -## DESCRIPTION -The **Rename-VMSnapshot** cmdlet renames a virtual machine snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Rename-VMSnapshot -VMName TestVM -Name "Configuration 2" -NewName "Configuration 2: applied all updates" -``` - -Renames snapshot Configuration 2 of virtual machine TestVM to Configuration 2: applied all updates. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine snapshot is to be renamed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine snapshot to be renamed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -NewName -Specifies the name to which the virtual machine snapshot is to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMSnapshot** object is to be passed through to the pipeline representing the virtual machine snapshot to be renamed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine of which the snapshot is to be renamed. - -```yaml -Type: VirtualMachine -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine of which the snapshot is to be renamed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMSnapshot -Specifies the virtual machine snapshot to be renamed. - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMSnapshot -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Rename-VMSwitch.md b/docset/winserver2012-ps/hyper-v/Rename-VMSwitch.md deleted file mode 100644 index 6a0ec63cc0..0000000000 --- a/docset/winserver2012-ps/hyper-v/Rename-VMSwitch.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/rename-vmswitch?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-VMSwitch - -## SYNOPSIS -Renames a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Rename-VMSwitch [-Name] [-NewName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Rename-VMSwitch [-VMSwitch] [-NewName] [-Passthru] -``` - -## DESCRIPTION -The **Rename-VMSwitch** cmdlet renames a virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Rename-VMSwitch "QoS Switch" -NewName "IIS Switch" -``` - -Renames virtual switch QoS Switch as IIS Switch. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual switch is to be renamed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual switch to be renamed. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -NewName -Specifies the name to which the virtual switch is to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.EthernetSwitch** object is to be passed through to the pipeline representing the virtual switch to be renamed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch to be renamed. - -```yaml -Type: VMSwitch -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.EthernetSwitch -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Repair-VM.md b/docset/winserver2012-ps/hyper-v/Repair-VM.md deleted file mode 100644 index 5eba180445..0000000000 --- a/docset/winserver2012-ps/hyper-v/Repair-VM.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/repair-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Repair-VM - -## SYNOPSIS -Repairs one or more virtual machines. - -## SYNTAX - -``` -Repair-VM [-CompatibilityReport] [-ComputerName ] [-Passthru] - [-Path ] [-SnapshotFilePath ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Repair-VM** cmdlet repairs one or more virtual machines. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Repair-VM -CompatibilityReport $VMCompatReport -Path C:\Test -``` - -Changes the configuration path for a virtual machine compatibility report. - -### Example 2 -``` -PS C:\>Repair-VM -CompatibilityReport $VMCompatReport -SnapshotFilePath C:\Snapshots -``` - -Adds missing snapshots to a virtual machine compatibility report. - -## PARAMETERS - -### -CompatibilityReport -Specifies a compatibility report which includes adjustments to be made during repair. - -```yaml -Type: VMCompatibilityReport -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine or machines are to be repaired. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the newly modified compatibility report. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual machine to be repaired. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotFilePath -Specifies the path to be search for virtual machine snapshots. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.CompatibilityReport -If **-PassThru** is specified. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Reset-VMReplicationStatistics.md b/docset/winserver2012-ps/hyper-v/Reset-VMReplicationStatistics.md deleted file mode 100644 index 9c25c9d835..0000000000 --- a/docset/winserver2012-ps/hyper-v/Reset-VMReplicationStatistics.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/reset-vmreplicationstatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-VMReplicationStatistics - -## SYNOPSIS -Resets the replication statistics of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Reset-VMReplicationStatistics [-VMName] [-ComputerName ] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Reset-VMReplicationStatistics [-VM] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Reset-VMReplicationStatistics [-VMReplication] [-PassThru] -``` - -## DESCRIPTION -The **Reset-VMReplicationStatistics** cmdlet resets the replication statistics of a virtual machine. -Statistics accumulated up to that time are deleted, and replication monitoring begins collecting a new set of statistics. -If replication health was reported as "Warning", then this operation also changes the health to "Normal". - -## EXAMPLES - -### Example 1 -``` -PS C:\>Reset-VMReplicationStatistics VM01 -``` - -Resets replication statistics for virtual machine VM01. - -### Example 2 -``` -PS C:\>Get-VMReplication | Reset-VMReplicationStatistics -``` - -Resets the replication statistics of all replication-enabled virtual machines on the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the replication statistics of a virtual machine are to be reset. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplication** object is to be passed through to the pipeline representing the replication whose statistics are to be reset. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose replication statistics are to be reset. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose replication statistics are to be reset. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMReplication -Specifies the virtual machine replication whose replication statistics are to be reset. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplication -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/hyper-v/Reset-VMResourceMetering.md b/docset/winserver2012-ps/hyper-v/Reset-VMResourceMetering.md deleted file mode 100644 index 8d7e089788..0000000000 --- a/docset/winserver2012-ps/hyper-v/Reset-VMResourceMetering.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/reset-vmresourcemetering?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-VMResourceMetering - -## SYNOPSIS -Resets the resource utilization data collected by Hyper-V resource metering. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Reset-VMResourceMetering [-ResourcePoolName] [[-ResourcePoolType] ] - [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Reset-VMResourceMetering [-VMName] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Reset-VMResourceMetering [-VM] -``` - -## DESCRIPTION -The **Reset-VMResourceMetering** cmdlet resets the resource utilization data collected by Hyper-V resource metering. - -When this cmdlet is called, the virtual machine or resource pool resource utilization data collected up to current point of time is deleted. -Hyper-V continues to collect resource utilization data after reset. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Reset-VMResourceMetering -VMName TestVM -``` - -Resets resource utilization data collection on a virtual machine named TestVM. - -### Example 2 -``` -PS C:\>Reset-VMResourceMetering -ResourcePoolName TestResourcePool -ResourcePoolType Memory -``` - -Resets resource utilization data collection for a single resource pool named TestResourcePool of type Memory. - -### Example 3 -``` -PS C:\>Get-VMResourcePool -ResourcePoolType @("Processor","VHD","Ethernet","Memory") | Reset-VMResourceMetering -``` - -Resets resource utilization data collection for all supported resource pool types on the virtual machine host. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts for which resource utilization data is to be reset. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the friendly name of the virtual machine resource pool for which resource utilization data is to be reset. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the resource type of the virtual machine resource pool for which resource utilization data is to be reset. - -```yaml -Type: VMResourcePoolType -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which resource utilization data is to be reset. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the friendly name of the virtual machine for which resource utilization data is to be reset. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.HyperV.PowerShell.VirtualMachine[] - -### Microsoft.HyperV.PowerShell.VMResourcePoolType - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Measure-VM](./Measure-VM.md) - -[Measure-VMResourcePool](./Measure-VMResourcePool.md) diff --git a/docset/winserver2012-ps/hyper-v/Resize-VHD.md b/docset/winserver2012-ps/hyper-v/Resize-VHD.md deleted file mode 100644 index e368c1a9be..0000000000 --- a/docset/winserver2012-ps/hyper-v/Resize-VHD.md +++ /dev/null @@ -1,191 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/resize-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resize-VHD - -## SYNOPSIS -Resizes a virtual hard disk. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Resize-VHD [-Path] [-SizeBytes] [-AsJob] [-ComputerName ] [-Passthru] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Resize-VHD [-Path] [-AsJob] [-ComputerName ] [-Passthru] [-ToMinimumSize] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Resize-VHD** cmdlet resizes a virtual hard disk. -This cmdlet lets you shrink or expand the size of a virtual hard disk, but the shrink operation is allowed only on VHDX virtual hard disks. -The shrink operation fails if it would shrink the virtual disk to less than its minimum size (available through the VHDX object's **MinimumSize** property). - -**Resize-VHD** is an offline operation; the virtual hard disk must not be attached when the operation is initiated. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Resize-VHD -Path c:\BaseVHD.vhd -SizeBytes 1TB -``` - -Expands the VHDX to 1 terabyte (assuming that the previous size was less than the new size prior to the command). - -### Example 2 -``` -PS C:\>Resize-VHD -Path c:\BaseVHDX.vhdx -SizeBytes 1TB -``` - -Shrinks the VHDX to one terabyte (assuming that the virtual hard disk object associated with the file path has a **MinimumSize** less than or equal to 1TB). - -### Example 3 -``` -PS C:\>Resize-VHD -Path c:\BaseVHDX.vhdx -ToMinimumSize -``` - -Shrinks the VHDX to its minimum possible size. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual hard disk is to be resized. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual hard disk to be resized. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual hard disk that is to be resized. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -SizeBytes -Specifies the size to which the virtual hard disk is to be resized. - -```yaml -Type: UInt64 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToMinimumSize -Specifies that the virtual hard disk is to be resized to its minimum possible size. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Restart-VM.md b/docset/winserver2012-ps/hyper-v/Restart-VM.md deleted file mode 100644 index 4095d16945..0000000000 --- a/docset/winserver2012-ps/hyper-v/Restart-VM.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/restart-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restart-VM - -## SYNOPSIS -Restarts a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Restart-VM [-Name] [-AsJob] [-ComputerName ] [-Force] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Restart-VM [-VM] [-AsJob] [-Force] [-Passthru] -``` - -## DESCRIPTION -The **Restart-VM** cmdlet restarts a virtual machine. -Running this cmdlet results in a "hard" restart, like powering the machine down, then back up again. -This can result in data loss in the virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Restart-VM Win7 -Confirm -Are you sure you want to restart virtual machine "win7"? -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y -``` - -Performs a hard restart of virtual machine Win7. -This is equivalent to turning off the power to the virtual machine and then restarting it. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be restarted. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that no prompt for confirmation is to appear before the virtual machine is restarted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be restarted. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual machine to be restarted. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be restarted. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default, **Microsoft.HyperV.Powershell.VirtualMachine** if **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Restore-VMSnapshot.md b/docset/winserver2012-ps/hyper-v/Restore-VMSnapshot.md deleted file mode 100644 index f267f32670..0000000000 --- a/docset/winserver2012-ps/hyper-v/Restore-VMSnapshot.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/restore-vmsnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-VMSnapshot - -## SYNOPSIS -Restores a virtual machine snapshot. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Restore-VMSnapshot [-Name] [-VMName] [-AsJob] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Restore-VMSnapshot [-VM] [-AsJob] [-Passthru] [-Name] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Restore-VMSnapshot [-VMSnapshot] [-AsJob] [-Passthru] -``` - -## DESCRIPTION -The **Restore-VMSnapshot** cmdlet restores a virtual machine snapshot. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Restore-VMSnapshot -Name 'Base image' -VMName TestVM -Confirm -Are you sure you want to perform this action? -Restore-VMSnapshot will restore snapshot "Base image". -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help -(default is "Y"): Y -``` - -Restores snapshot Base image of virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM | Foreach-Object { $_ | Get-VMSnapshot | Sort CreationTime | Select -Last 1 | Restore-VMSnapshot -Confirm:$false } -``` - -Applies the most recent snapshot on all virtual machines with no confirmation prompts. - -## PARAMETERS - -### -AsJob -Specified that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine snapshot is to be restored. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the snapshot to be restored. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Passthru -Specifies that a **VMSnapshot** is to be passed through to the pipeline representing the snapshot to be restored. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be restored. - -```yaml -Type: VirtualMachine -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to be restored. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VMSnapshot -```yaml -Type: VMSnapshot[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMSnapshot -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Resume-VM.md b/docset/winserver2012-ps/hyper-v/Resume-VM.md deleted file mode 100644 index 05f621415b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Resume-VM.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/resume-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-VM - -## SYNOPSIS -Resumes a suspended (paused) virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Resume-VM [-Name] [-AsJob] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Resume-VM [-VM] [-AsJob] [-Passthru] -``` - -## DESCRIPTION -The **Resume-VM** cmdlet resumes a suspended (paused) virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Resume-VM -Name TestVM -``` - -Resumes suspended (paused) virtual machine TestVM. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be resumed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be resumed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual machine to be resumed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Resume-VMReplication.md b/docset/winserver2012-ps/hyper-v/Resume-VMReplication.md deleted file mode 100644 index 9730694549..0000000000 --- a/docset/winserver2012-ps/hyper-v/Resume-VMReplication.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/resume-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-VMReplication - -## SYNOPSIS -Resumes a virtual machine replication that is in a state of Paused, Error, Resynchronization Required, or Suspended. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Resume-VMReplication [-VMName] [-AsJob] [-ComputerName ] [-PassThru] [-Resynchronize] - [-ResynchronizeStartTime ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Resume-VMReplication [-VM] [-AsJob] [-PassThru] [-Resynchronize] - [-ResynchronizeStartTime ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Resume-VMReplication [-VMReplication] [-AsJob] [-PassThru] [-Resynchronize] - [-ResynchronizeStartTime ] -``` - -## DESCRIPTION -The **Resume-VMReplication** cmdlet resumes replication of a virtual machine with a replication state of Paused, Error, Resynchronization Required, or Suspended. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Resume-VMReplication VM01 -``` - -This example resumes replication of virtual machine VM01. - -### Example 2 -``` -PS C:\>Resume-VMReplication VM01 -Resynchronize -``` - -This example resynchronizes replication of virtual machine VM01. - -### Example 3 -``` -PS C:\>Resume-VMReplication VM01 -Resynchronize -ResynchronizeStartTime "8/1/2012 05:00 AM" -``` - -This example schedules the resynchronization of replication for virtual machine VM01 to start at 5:00 AM on August 1, 2012. - -### Example 4 -``` -PS C:\>Resume-Replication * -``` - -This example resumes replication of all virtual machines for which replication is paused. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine replication is to be resumed. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplication** object is to be passed through to the pipeline representing the virtual machine replication to be resumed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Resynchronize -Specifies that resynchronization is to be started for the virtual machine. -Resynchronization requires significant storage, processor, and network resources. -We recommend running this process during off-peak hours. -Use the **Set-VMReplication** cmdlet to specify whether to automatically resynchronize the virtual machine in the future. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResynchronizeStartTime -Specifies when resynchronization should start. -If not specified, resynchronization starts immediately. -You can schedule the resynchronization to start up to 7 days later. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose replication is to be resumed. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose replication is to be resumed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies a virtual machine replication object representing the virtual machine replication to be resumed. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplication -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Revoke-VMConnectAccess.md b/docset/winserver2012-ps/hyper-v/Revoke-VMConnectAccess.md deleted file mode 100644 index a13f37889d..0000000000 --- a/docset/winserver2012-ps/hyper-v/Revoke-VMConnectAccess.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/revoke-vmconnectaccess?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Revoke-VMConnectAccess - -## SYNOPSIS -Revokes access for one or more users to connect to a one or more virtual machines. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Revoke-VMConnectAccess [-VMName] [-UserName] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Revoke-VMConnectAccess [-VMId] [-UserName] [-ComputerName ] [-Passthru] -``` - -## DESCRIPTION -The **Revoke-VMConnectAccess** cmdlet revokes access for one or more users to connect to one or more virtual machines. -This cmdlet is intended for use in providing other applications with the appropriate permissions required to initiate a session with Virtual Machine Connection. -Examples of such applications are Virtual Machine Manager. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Revoke-VMConnectAccess -VMName VM1 -UserName Contoso\John -``` - -This command revokes the access of user Contoso\John to connect to virtual machine VM1. - -## PARAMETERS - -### -ComputerName -Specifies one or more virtual machine hosts on which access to connect to a virtual machine or machines is to be revoked. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMConnectAce** is to be passed through to the pipeline for each revocation of access. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the user or users to whom access to connect to a virtual machine or machines is to be revoked, in one of the following forms. - -Local User Account: - john - ComputerName\john - -Domain User Account: - CONTOSO\john - Contoso.com\john - -User Principal Name (UPN): - john@contoso.com - -Security Identifier: - S-1-5-21-3165297888-301567370-576410423-1103 - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -VMId -Specifies the unique identifier of a virtual machine or machines to which connect access is to be revoked. - -```yaml -Type: Guid[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name or names of the virtual machine or machines to which access is being revoked. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMConnectAce -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Save-VM.md b/docset/winserver2012-ps/hyper-v/Save-VM.md deleted file mode 100644 index 02dd00ff5e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Save-VM.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/save-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Save-VM - -## SYNOPSIS -Saves a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Save-VM [-Name] [-AsJob] [-ComputerName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Save-VM [-VM] [-AsJob] -``` - -## DESCRIPTION -The **Save-VM** cmdlet saves a virtual machine. -This is similar to hibernating a physical machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Save-VM -Name TestVM -``` - -Saves virtual machine TestVM. - -### Example 2 -``` -PS C:\>Get-VM -Name Win* | Save-VM -``` - -Saves all virtual machines whose name starts with Win. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be saved. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be saved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VM -Specifies the virtual machine to be saved. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VHD.md b/docset/winserver2012-ps/hyper-v/Set-VHD.md deleted file mode 100644 index c074f6b097..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VHD.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VHD - -## SYNOPSIS -Set properties associated with a virtual hard disk. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VHD [-Path] [-ParentPath] [-ComputerName ] [-IgnoreIdMismatch] - [-LeafPath ] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VHD [-Path] [-ComputerName ] [-Passthru] -PhysicalSectorSizeBytes [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-VHD** cmdlet sets the ParentPath or PhysicalSectorSizeBytes properties of a virtual hard disk. -The two properties must be set in separate operations. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VHD -Path Child1.vhd -ParentPath ParentCopy.vhd -LeafPath Child2.vhd -``` - -This example sets the parent of the virtual hard disk associated with ParentCopy.vhd as the parent of the chained virtual hard disk associated with Child1.vhd, where the leaf of the virtual disk chain is the virtual hard disk associated with Child2.vhd. -The operation is performed in online mode. - -### Example 2 -``` -PS C:\>Set-VHD -Path Child1.vhd -ParentPath ParentCopy.vhd -``` - -This example sets the parent of the virtual hard disk associated with ParentCopy.vhd as the parent of the chained virtual hard disk associated with Child1.vhd. -This operation cannot be performed when the virtual disk chain is attached. - -### Example 3 -``` -PS C:\>Set-VHD -Path Child1.vhd -parentpath parentcopywithnewid.vhd -IgnoreIdMismatch -``` - -This example sets the parent of Child1.vhd to point to parentcopywithnewid.vhd, even though parentcopywithnewid.vhd has a different ID than the original parent of child1.vhd. -The operation is performed in offline mode. -This mode should be used with extreme caution, and only when it is certain that the block contents of the new and old parents are exactly the same. -Otherwise data loss can occur. - -### Example 4 -``` -PS C:\> Set-VHD -Path c:\test.vhdx -PhysicalSectorSizeBytes 512 -``` - -This example sets the physical sector size of a VHDX to 512 bytes. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the parent of a virtual hard disk in a differencing hard disk chain is to be set. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IgnoreIdMismatch -Specifies that the check for identifier mismatch between the parent and child virtual hard disk is to be skipped. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LeafPath -Specifies the path to the virtual hard disk file of the virtual hard disk representing the leaf node of the virtual hard disk chain. -Required when performing the operation in online mode. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -ParentPath -Specifies the path to the parent disk of a differencing virtual hard disk. -Can be performed regardless of whether the disk is online or offline. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual hard disk whose parent is to be set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual hard disk file of the virtual hard disk drive whose parent in the virtual hard disk chain is to be set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -PhysicalSectorSizeBytes -Specifies the physical sector size, in bytes. -Valid values are 512 and 4096. -This parameter is supported only on a VHDX-format disk that is not attached when the operation is initiated. - -```yaml -Type: UInt32 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VM.md b/docset/winserver2012-ps/hyper-v/Set-VM.md deleted file mode 100644 index ed1e1dc3e0..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VM.md +++ /dev/null @@ -1,378 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VM - -## SYNOPSIS -Configures a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VM [-Name] [-AllowUnverifiedPaths] [-AutomaticStartAction ] - [-AutomaticStartDelay ] [-AutomaticStopAction ] [-ComputerName ] [-DynamicMemory] - [-MemoryMaximumBytes ] [-MemoryMinimumBytes ] [-MemoryStartupBytes ] - [-NewVMName ] [-Notes ] [-Passthru] [-ProcessorCount ] [-SmartPagingFilePath ] - [-SnapshotFileLocation ] [-StaticMemory] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VM [-VM] [-AllowUnverifiedPaths] [-AutomaticStartAction ] - [-AutomaticStartDelay ] [-AutomaticStopAction ] [-DynamicMemory] - [-MemoryMaximumBytes ] [-MemoryMinimumBytes ] [-MemoryStartupBytes ] - [-NewVMName ] [-Notes ] [-Passthru] [-ProcessorCount ] [-SmartPagingFilePath ] - [-SnapshotFileLocation ] [-StaticMemory] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VM** cmdlet configures a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VM -Name TestVM -AutomaticStopAction Shutdown -``` - -Configures virtual machine TestVM to shut down when the Hyper-V host shuts down. - -### Example 2 -``` -PS C:\>Stop-VM -Name TestVM -Passthru | Set-VM -ProcessorCount 2 -DynamicMemory -MemoryMaximumBytes 2GB -Passthru | Start-VM -``` - -Stops virtual machine TestVM, sets it to use dynamic memory, sets its maximum amount of memory to 2GB, sets it to use 2 virtual processors, and starts it. - -## PARAMETERS - -### -AutomaticStartAction -Specifies the action the virtual machine is to take upon start. -Allowed values are **Nothing**, **StartIfRunning**, and **Start**. - -```yaml -Type: StartAction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticStartDelay -Specifies the number of seconds by which the virtual machine's start should be delayed. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutomaticStopAction -Specifies the action the virtual machine is to take when the virtual machine host shuts down. -Allowed values are **TurnOff**, **Save**, and **ShutDown**. - -```yaml -Type: StopAction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual machine is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicMemory -Specifies that the virtual machine is to be configured to use dynamic memory. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryMaximumBytes -Specifies the maximum amount of memory that the virtual machine is to be allocated. -(Applies only to virtual machines using dynamic memory.) - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryMinimumBytes -Specifies the minimum amount of memory that the virtual machine is to be allocated. -(Applies only to virtual machines using dynamic memory.) - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemoryStartupBytes -Specifies the amount of memory that the virtual machine is to be allocated upon startup. -(If the virtual machine does not use dynamic memory, then this is the static amount of memory to be allocated.) - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: VMName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NewVMName -Specifies the name to which the virtual machine is to be renamed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual machine to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProcessorCount -Specifies the number of virtual processors for the virtual machine. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotFileLocation -Specifies the folder in which the virtual machine is to store its snapshot files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticMemory -Specifies the amount of static memory for the virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowUnverifiedPaths -Specifies that no error is to be thrown if the specified path is not verified as accessible by the cluster. -This parameter is applicable to clustered virtual machines. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SmartPagingFilePath -Specifies the folder in which the Smart Paging file is to be stored. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies notes to be associated with the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMBios.md b/docset/winserver2012-ps/hyper-v/Set-VMBios.md deleted file mode 100644 index e2d7ed0bb3..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMBios.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmbios?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMBios - -## SYNOPSIS -Configures the BIOS of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMBios [-VMName] [-ComputerName ] [-DisableNumLock] [-EnableNumLock] [-Passthru] - [-StartupOrder ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMBios [-VM] [-DisableNumLock] [-EnableNumLock] [-Passthru] - [-StartupOrder ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMBios [-VMBios] [-DisableNumLock] [-EnableNumLock] [-Passthru] [-StartupOrder ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMBios** cmdlet configures the BIOS of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-VMBios TestVM -DisableNumLock -``` - -This example disables the NumLock key by default on virtual machine TestVM. - -### Example 2 -``` -PS C:\> Set-VMBios TestVM -StartupOrder @("Floppy", "LegacyNetworkAdapter", "CD", "IDE") -``` - -This example configures virtual machine TestVM to check for a boot device in the following order: floppy disk, network, CD drive, hard disk. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts for which the BIOS is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableNumLock -Specifies that NumLock is to be disabled in the BIOS of the virtual machine to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableNumLock -Specifies that NumLock is to be enabled in the BIOS of the virtual machine to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an **Microsoft.Virtualization.Powershell.Bios** object is to be passed through to the pipeline representing the BIOS to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartupOrder -Specifies an array of boot devices representing the boot order in the BIOS of the virtual machine. -The boot devices are specified as members of the **BootDevices** enumeration (**CD**, **IDE**, **LegacyNetworkAdapter**, **Floppy**). - -```yaml -Type: BootDevice[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which the BIOS is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMBios -```yaml -Type: VMBios[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which the BIOS is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.Bios -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMComPort.md b/docset/winserver2012-ps/hyper-v/Set-VMComPort.md deleted file mode 100644 index 608b858cb5..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMComPort.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmcomport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMComPort - -## SYNOPSIS -Configures the COM port of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMComPort [-VMName] [-Number] [-Path] [-ComputerName ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMComPort [-VM] [-Path] [-Passthru] [-Number] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMComPort [-VMComPort] [-Path] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMComPort** cmdlet configures the COM port of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMComPort TestVM 2 \\.\pipe\TestPipe -``` - -Configure the second COM port on virtual machine TestVM to connect to named pipe TestPipe on the local computer. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the COM port of a virtual machine is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Number -Specifies the Id (1 or 2) of the COM port to be configured. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.ComPort** object is to be passed through to the pipeline representing the COM port to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies a named pipe path for the COM port to be configured. -Specify local pipes as "\\\\.\pipe\PipeName" and remote pipes as "\\\\RemoteServer\pipe\PipeName". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which the COM port is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMComPort -Specifies the COM port to be configured. - -```yaml -Type: VMComPort[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which the COM port is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.ComPort -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMDvdDrive.md b/docset/winserver2012-ps/hyper-v/Set-VMDvdDrive.md deleted file mode 100644 index bbbb02d4f0..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMDvdDrive.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmdvddrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMDvdDrive - -## SYNOPSIS -Configures a virtual DVD drive. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMDvdDrive [-VMName] [[-ControllerNumber] ] [[-ControllerLocation] ] - [[-Path] ] [-AllowUnverifiedPaths] [-ComputerName ] [-Passthru] [-ResourcePoolName ] - [-ToControllerLocation ] [-ToControllerNumber ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMDvdDrive [-VMDvdDrive] [[-Path] ] [-AllowUnverifiedPaths] [-Passthru] - [-ResourcePoolName ] [-ToControllerLocation ] [-ToControllerNumber ] -``` - -## DESCRIPTION -The **Set-VMDvdDrive** cmdlet configures the controller and location of a virtual DVD drive. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMDvdDrive -VMName TestVM -Path .\Windows7.iso -``` - -Configures the virtual DVD drive of virtual machine TestVM to use Test.iso as its media. - -### Example 2 -``` -PS C:\>Set-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 -Path $null -``` - -Configures the virtual DVD drive at IDE 1,0 of virtual machine TestVM to use no media. -(This ejects any existing media from the virtual DVD drive.) - -### Example 3 -``` -PS C:\>Get-VMDvdDrive -VMName TestVM -ControllerNumber 1 -ControllerLocation 0 | Set-VMDvdDrive -ToControllerLocation 1 -``` - -Moves virtual DVD drive from IDE 1,0 to IDE 1,1 on virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the DVD drive is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the IDE controller location of the DVD drives to be configured. -If not specified, DVD drives in all controller locations are configured. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the IDE controller of the DVD drives to be configured. -If not specified, DVD drives attached to all controllers are configured. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.DvdDrive** object is to be passed through to the pipeline representing the virtual DVD drive to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the ISO file or physical DVD drive that will serve as media for the virtual DVD drive. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -ResourcePoolName -Specifies the friendly name of the ISO resource pool to which this DVD drive is to be associated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMDvdDrive -Specifies the virtual DVD drive to be configured. - -```yaml -Type: DvdDrive[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowUnverifiedPaths -Specifies that no error is to be thrown if the specified path is not verified as accessible by the cluster. -This parameter is applicable to clustered virtual machines. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToControllerLocation -Specifies the controller location to which this virtual DVD drive should be moved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToControllerNumber -Specifies the controller number to which this VMDvdDrive should be moved. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the DVD drive is to be configured. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.DvdDrive -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMFibreChannelHba.md b/docset/winserver2012-ps/hyper-v/Set-VMFibreChannelHba.md deleted file mode 100644 index cd330312ec..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMFibreChannelHba.md +++ /dev/null @@ -1,322 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmfibrechannelhba?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMFibreChannelHba - -## SYNOPSIS -Configures a Fibre Channel host bus adapter on a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMFibreChannelHba [-VMName] [-WorldWideNodeNameSetA] [-WorldWidePortNameSetA] - [-WorldWideNodeNameSetB] [-WorldWidePortNameSetB] [-ComputerName ] [-Passthru] - -SanName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMFibreChannelHba [-VMName] [-WorldWideNodeNameSetA] [-WorldWidePortNameSetA] - [-WorldWideNodeNameSetB] [-WorldWidePortNameSetB] [-ComputerName ] [-Passthru] - [-GenerateWwn] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMFibreChannelHba [-VMName] [-WorldWideNodeNameSetA] [-WorldWidePortNameSetA] - [-WorldWideNodeNameSetB] [-WorldWidePortNameSetB] [-ComputerName ] - [-NewWorldWideNodeNameSetA ] [-NewWorldWideNodeNameSetB ] [-NewWorldWidePortNameSetA ] - [-NewWorldWidePortNameSetB ] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-VMFibreChannelHba [-VMFibreChannelHba] [-Passthru] [-GenerateWwn] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Set-VMFibreChannelHba [-VMFibreChannelHba] [-NewWorldWideNodeNameSetA ] - [-NewWorldWideNodeNameSetB ] [-NewWorldWidePortNameSetA ] [-NewWorldWidePortNameSetB ] - [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Set-VMFibreChannelHba [-VMFibreChannelHba] [-Passthru] -SanName [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMFibreChannelHba** cmdlet configures a Fibre Channel host bus adapter on a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMFibreChannelHba -VMName MyVM | Set-VMFibreChannelHba -GenerateWwn -``` - -Configures a Fibre Channel host bus adapter on a virtual machine named MyVM, with World Wide Names to be generated automatically. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a Fibre Channel host bus adapter is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the configured Fibre Channel host bus adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SanName -Specifies the name of the virtual storage area network (SAN) to be associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMFibreChannelHba -Specifies the Fibre Channel host bus adapter to be configured. - -```yaml -Type: VMFibreChannelHba -Parameter Sets: UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WorldWideNodeNameSetA -Specifies the World Wide Node name of address set A that is associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: Wwnn1 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeNameSetB -Specifies the World Wide Node name of address set B that is associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: Wwnn2 - -Required: True -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortNameSetA -Specifies the World Wide Port name of address set A that is associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: Wwpn1 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortNameSetB -Specifies the World Wide Port name of address set B that is associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: Wwpn2 - -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GenerateWwn -Specifies that the World Wide Names for sets A and B are to be generated automatically. -When this parameter is specified, parameters **WorldWideNodeNameSetA**, **WorldWideNodeNameSetB**, **WorldWidePortNameSetA**, and **WorldWidePortNameSetB** cannot be used. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWorldWideNodeNameSetA -Specifies the World Wide Node name of address set A to be associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWorldWideNodeNameSetB -Specifies the World Wide Node name of address set B to be associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWorldWidePortNameSetA -Specifies the World Wide Port name of address set A to be associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewWorldWidePortNameSetB -Specifies the World Wide Port name of address set B to be associated with the Fibre Channel host bus adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine to which the virtual Fibre Channel host bus adapter parameters are to be set. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMFloppyDiskDrive.md b/docset/winserver2012-ps/hyper-v/Set-VMFloppyDiskDrive.md deleted file mode 100644 index 2d75cc0461..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMFloppyDiskDrive.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmfloppydiskdrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMFloppyDiskDrive - -## SYNOPSIS -Configures a virtual floppy disk drive. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMFloppyDiskDrive [-VMName] [[-Path] ] [-ComputerName ] [-Passthru] - [-ResourcePoolName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMFloppyDiskDrive [-VM] [[-Path] ] [-Passthru] [-ResourcePoolName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMFloppyDiskDrive [-VMFloppyDiskDrive] [[-Path] ] [-Passthru] - [-ResourcePoolName ] -``` - -## DESCRIPTION -The **Set-VMFloppyDiskDrive** cmdlet configures a virtual floppy disk drive. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMFloppyDiskDrive TestVM C:\Test.vfd -``` - -Connect C:\Test.vfd to the virtual floppy disk of virtual machine TestVM. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual floppy disk drive is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.FloppyDiskDrive** object is to be passed through to the pipeline representing the virtual floppy disk drive to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual floppy drive file. -If specified as **$null**, the drive is set to contain no media. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ResourcePoolName -Specifies the name of the virtual floppy disk resource pool to use for this virtual floppy disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -VM -Specifies the virtual machine in which the virtual floppy disk drive is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMFloppyDiskDrive -Specifies the virtual floppy disk drive to be configured. - -```yaml -Type: VMFloppyDiskDrive[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the virtual floppy disk drive is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMHardDiskDrive.md b/docset/winserver2012-ps/hyper-v/Set-VMHardDiskDrive.md deleted file mode 100644 index 897268ed0e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMHardDiskDrive.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmharddiskdrive?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMHardDiskDrive - -## SYNOPSIS -Configures a virtual hard disk. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMHardDiskDrive [-VMName] [[-ControllerType] ] [[-ControllerNumber] ] - [[-ControllerLocation] ] [[-Path] ] [-AllowUnverifiedPaths] [-ComputerName ] - [-DiskNumber ] [-Passthru] [-ResourcePoolName ] [-ToControllerLocation ] - [-ToControllerNumber ] [-ToControllerType ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMHardDiskDrive [-VMHardDiskDrive] [[-Path] ] [-AllowUnverifiedPaths] - [-ComputerName ] [-DiskNumber ] [-Passthru] [-ResourcePoolName ] - [-ToControllerLocation ] [-ToControllerNumber ] [-ToControllerType ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMHardDiskDrive** cmdlet configures a virtual hard disk. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMHardDiskDrive -VMName TestVM -Path .\Test.vhd -``` - -Configures the hard drive of virtual machine TestVM to use Test.vhd as its media. - -### Example 2 -``` -PS C:\>Get-VMHardDiskDrive -VMName TestVM -ControllerType IDE -ControllerNumber 1 -ControllerLocation 0 | Set-VMHardDiskDrive -ToControllerLocation 1 -``` - -Moves the virtual hard drive on virtual machine TestVM from IDE 1,0 to IDE 1,1. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual hard drive is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: PSComputerName - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ControllerLocation -Specifies the number of the location on the controller to which the virtual hard drive to be configured is attached. -If not specified, all hard drives are configured. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerNumber -Specifies the number of the controller to which the virtual hard drive to be configured is attached. -If not specified, all hard drives are configured. - -```yaml -Type: Int32 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ControllerType -Specifies the type of the controller to which the virtual hard drive to be configured is attached. -Allowed values are **IDE** and **SCSI**. - -```yaml -Type: ControllerType -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.HardDiskDrive** object is to be passed through to the pipeline representing the virtual hard drive to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to media the virtual hard disk is to use. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the virtual hard disk resource pool to which this drive belongs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMHardDiskDrive -Specifies one or more hard disks to be configured. - -```yaml -Type: HardDiskDrive[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AllowUnverifiedPaths -Specifies that no error is to be thrown if the specified path is not verified as accessible by the cluster. -This parameter is applicable to clustered virtual machines. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DiskNumber -Specifies the disk number of the offline physical hard drive that should be connected as a passthrough disk. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: Number - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ToControllerLocation -Specifies the controller location to which this drive should be moved. -Allowed values are 0 and 1 for IDE controllers, and from 0 to 63 for SCSI controllers. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToControllerNumber -Specifies the controller location to which this drive should be moved. -Allowed values are 0 and 1 for IDE controllers, and from 0 to 3 for SCSI controllers. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ToControllerType -Specifies the type of controller to which this drive should be moved. -Allowed values are IDE and SCSI. - -```yaml -Type: ControllerType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the virtual hard drive is to be configured. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMHost.md b/docset/winserver2012-ps/hyper-v/Set-VMHost.md deleted file mode 100644 index f5d7307f3b..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMHost.md +++ /dev/null @@ -1,375 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmhost?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMHost - -## SYNOPSIS -Configures a Hyper-V host. - -## SYNTAX - -``` -Set-VMHost [[-ComputerName] ] [-FibreChannelWwnn ] [-FibreChannelWwpnMaximum ] - [-FibreChannelWwpnMinimum ] [-MacAddressMaximum ] [-MacAddressMinimum ] - [-MaximumStorageMigrations ] [-MaximumVirtualMachineMigrations ] - [-NumaSpanningEnabled ] [-Passthru] [-ResourceMeteringSaveInterval ] - [-UseAnyNetworkForMigration ] [-VirtualHardDiskPath ] - [-VirtualMachineMigrationAuthenticationType ] [-VirtualMachinePath ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMHost** cmdlet configures a Hyper-V host. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMHost -MaximumVirtualMachineMigrations 10 -MaximumStorageMigrations 10 -``` - -This example configures the local Hyper-V host to allow 10 simultaneous live migrations and storage migrations. - -### Example 2 -``` -PS C:\>Set-VMHost -MacAddressMinimum 00155D020600 -MacAddressMaximum 00155D0206FF -``` - -This example configures a range of MAC addresses range for the local Hyper-V host. - -### Example 3 -``` -PS C:\>Set-VMHost -UseAnyNetworkForMigration $true -``` - -This example enables the use of any network for incoming live migrations on the local Hyper-V host. - -### Example 4 -``` -PS C:\> Set-VMHost -VirtualHardDiskPath "C:\Hyper-V\Virtual Hard Disks" -VirtualMachinePath "C:\Hyper-V" -``` - -This example specifies new default locations for virtual hard disks and virtual machines on the local Hyper-V host. In this case: - -- Virtual machines are stored in "C:\Hyper-V\Virtual Machines" (not "C:\Hyper-V") -- Virtual hard disks are stored in "C:\Hyper-V\Virtual Hard Disks" - -### Example 5 -``` -PS C:\>Set-VMHost -FibreChannelWwnn C003FF0000FFFF00 -FibreChannelWwpnMinimum C003FF661D200000 -FibreChannelWwpnMaximum C003FF661D200000 -``` - -This example configures Fibre Channel host settings on the local Hyper-V host. - -### Example 6 -``` -PS C:\>Set-VMHost -NumaSpanningEnabled $false -``` - -This example disables NUMA spanning on the local Hyper-V host. - -### Example 7 -``` -PS C:\>Set-VMHost -ResourceMeteringSaveInterval 01:30:00 -``` - -This example configures the local Hyper-V host to save data that tracks resource consumption every hour and a half. - -### Example 8 -``` -PS C:\>Set-VMHost -VirtualMachineMigrationAuthenticationType Kerberos -``` - -The example configures the local Hyper-V host to use Kerberos to authenticate incoming live migrations. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MacAddressMaximum -Specifies the maximum MAC address using a valid hexadecimal value. -Use with MacAddressMinimum to establish a range of MAC addresses that the specified Hyper-V host can assign to virtual machines configured to receive dynamic MAC addresses. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacAddressMinimum -Specifies the minimum MAC address using a valid hexadecimal value. -Use with MacAddressMaximum to establish a range of MAC addresses that the specified Hyper-V host can assign to virtual machines configured to receive dynamic MAC addresses. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.Host** is to be passed through to the pipeline representing the Hyper-V host to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseAnyNetworkForMigration -Specifies how networks are selected for incoming live migration traffic. -If set to **$TRUE**, any available network on the host can be used for this traffic. -If set to **$FALSE**, incoming live migration traffic is transmitted only on the networks specified in the **MigrationNetworks** property of the host. -The **Get-VMMigrationNetwork** returns the list of networks that can be used for migration traffic. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualHardDiskPath -Specifies the default folder to store virtual hard disks on the Hyper-V host. This is not a functional setting. The Hyper-V Manager snap-in and Windows Admin Center query it to offer you a default path, but the Hyper-V API (for example `CreateFixedVirtualHardDisk`) and `New-VHD` don't use it. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachinePath -Specifies the default folder to store virtual machine configuration files on the Hyper-V host. This is a functional setting, meaning that if you do not supply a path to VM creation tools (for example `New-VM`), Hyper-V will use this path. Hyper-V will create at least one subfolder in this path, called "Virtual Machines". - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FibreChannelWwnn -Specifies the default value of the World Wide Node Name on the Hyper-V host. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FibreChannelWwpnMaximum -Specifies the maximum value that can be used to generate World Wide Port Names on the Hyper-V host. -Use with FibreChannelWwpnMinimum to establish a range of WWPNs that the specified Hyper-V host can assign to virtual Fibre Channel adapters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FibreChannelWwpnMinimum -Specifies the minimum value that can be used to generate the World Wide Port Names on the Hyper-V host. -Use with FibreChannelWwpnMaximum to establish a range of WWPNs that the specified Hyper-V host can assign to virtual Fibre Channel adapters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumStorageMigrations -Specifies the maximum number of storage migrations that can be performed at the same time on the Hyper-V host. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumVirtualMachineMigrations -Specifies the maximum number of live migrations that can be performed at the same time on the Hyper-V host. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumaSpanningEnabled -Specifies whether virtual machines on the Hyper-V host can use resources from more than one NUMA node. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceMeteringSaveInterval -Specifies how often the Hyper-V host saves the data that tracks resource usage. -The range is a minimum of 1 hour to a maximum of 24 hours. -Time within that range can be specified using a format of hh:mm:ss, where hh indicates hours, mm indicates minutes, and ss indicates seconds. -You also can use a Timespan object to specify the interval. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualMachineMigrationAuthenticationType -Specifies the type of authentication to be used for live migrations. -Allowed values are **Kerberos** or **CredSSP**. - -```yaml -Type: MigrationAuthenticationType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.Host -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMMemory.md b/docset/winserver2012-ps/hyper-v/Set-VMMemory.md deleted file mode 100644 index c9b393835a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMMemory.md +++ /dev/null @@ -1,264 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmmemory?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMMemory - -## SYNOPSIS -Configures the memory of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMMemory [-VMName] [-Buffer ] [-ComputerName ] - [-DynamicMemoryEnabled ] [-MaximumAmountPerNumaNodeBytes ] [-MaximumBytes ] - [-MinimumBytes ] [-Passthru] [-Priority ] [-ResourcePoolName ] [-StartupBytes ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMMemory [-VM] [-Buffer ] [-DynamicMemoryEnabled ] - [-MaximumAmountPerNumaNodeBytes ] [-MaximumBytes ] [-MinimumBytes ] [-Passthru] - [-Priority ] [-ResourcePoolName ] [-StartupBytes ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMMemory [-VMMemory] [-Buffer ] [-DynamicMemoryEnabled ] - [-MaximumAmountPerNumaNodeBytes ] [-MaximumBytes ] [-MinimumBytes ] [-Passthru] - [-Priority ] [-ResourcePoolName ] [-StartupBytes ] -``` - -## DESCRIPTION -The **Set-VMMemory** cmdlet configures the memory of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMMemory TestVM -DynamicMemoryEnabled $true -MinimumBytes 64MB -StartupBytes 256MB -MaximumBytes 2GB -Priority 80 -Buffer 25 -``` - -Enables dynamic memory on virtual machine TestVM, sets its minimum, startup, and maximum memory, its memory priority, and its buffer. - -## PARAMETERS - -### -Buffer -Specifies the percentage of memory to reserve as a buffer in the virtual machine to be configured. -Allowed values range from 5 to 2000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the memory of a virtual machine is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicMemoryEnabled -Specifies whether dynamic memory is to be enabled on the virtual machine to be configured. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumAmountPerNumaNodeBytes -Specifies the maximum amount of memory per NUMA node in the virtual machine to be configured. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumBytes -Specifies the maximum amount of memory to be used by a virtual machine which has dynamic memory enabled. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumBytes -Specifies the minimum amount of memory to be used by a virtual machine which has dynamic memory enabled. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.Memory** object is to be passed through to the pipeline representing the virtual machine memory to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Priority -Sets the priority for memory availability to this virtual machine relative to other virtual machines on the virtual machine host. -Allowed values range from 0 to 100. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the memory resource pool for this virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartupBytes -Specifies the initial amount of memory to be assigned to a virtual machine with dynamic memory enabled, or the total amount of memory to be assigned to a virtual machine with dynamic memory disabled. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose memory is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMMemory -Specifies the virtual machine memory to be configured. - -```yaml -Type: VMMemory[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose memory is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.Memory -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMMigrationNetwork.md b/docset/winserver2012-ps/hyper-v/Set-VMMigrationNetwork.md deleted file mode 100644 index b9a075451d..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMMigrationNetwork.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmmigrationnetwork?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMMigrationNetwork - -## SYNOPSIS -Sets the subnet, subnet mask, and/or priority of a migration network. - -## SYNTAX - -``` -Set-VMMigrationNetwork [-Subnet] [[-NewSubnet] ] [-ComputerName ] - [-NewPriority ] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMMigrationNetwork** cmdlet sets the subnet, subnet mask, and/or priority of a migration network. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMMigrationNetwork 192.168.10.1 192.168.10.3 -``` - -This example changes an IPv4 address on a migration network. - -### Example 2 -``` -PS C:\>Set-VMMigrationNetwork 192.168.10.* 192.168.10.3 -``` - -This example changes the IPv4 address on a migration network selected using a wildcard. - -### Example 3 -``` -PS C:\>Set-VMMigrationNetwork 2001:836c:6456:1c99::/64 -NewPriority 12 -``` - -This example changes the priority of a migration network to 12. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which migration network properties are to be set. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NewPriority -Specifies the new priority of the virtual machine migration network. -Multiple networks can have the same priority. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewSubnet -Specifies a string representing the new subnet value to be set on the migration network. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.MigrationNetwork** is to be passed through to the pipeline representing the migration network to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subnet -Specifies a string representing an IPv4 or IPv6 subnet mask which identifies the migration network whose properties are to be set. -Wildcards are allowed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.MigrationNetwork -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapter.md b/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapter.md deleted file mode 100644 index a4f1de6318..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapter.md +++ /dev/null @@ -1,635 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmnetworkadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMNetworkAdapter - -## SYNOPSIS -Configures features of the virtual network adapter in a virtual machine or the management operating system. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMNetworkAdapter [-VMName] [-AllowTeaming ] [-ComputerName ] - [-DhcpGuard ] [-DynamicMacAddress] [-IeeePriorityTag ] - [-IovInterruptModeration ] [-IovQueuePairsRequested ] - [-IovWeight ] [-IPsecOffloadMaximumSecurityAssociation ] [-MacAddressSpoofing ] - [-MandatoryFeatureId ] [-MaximumBandwidth ] [-MinimumBandwidthAbsolute ] - [-MinimumBandwidthWeight ] [-Name ] [-Passthru] - [-PortMirroring ] [-ResourcePoolName ] [-RouterGuard ] - [-StaticMacAddress ] [-TestReplicaPoolName ] [-TestReplicaSwitchName ] - [-VirtualSubnetId ] [-VMNetworkAdapterName ] [-VmqWeight ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMNetworkAdapter [-AllowTeaming ] [-ComputerName ] [-DhcpGuard ] - [-IeeePriorityTag ] [-IovInterruptModeration ] - [-IovQueuePairsRequested ] [-IovWeight ] [-IPsecOffloadMaximumSecurityAssociation ] - [-MacAddressSpoofing ] [-MandatoryFeatureId ] [-MaximumBandwidth ] - [-MinimumBandwidthAbsolute ] [-MinimumBandwidthWeight ] [-Name ] [-Passthru] - [-PortMirroring ] [-ResourcePoolName ] [-RouterGuard ] - [-TestReplicaPoolName ] [-TestReplicaSwitchName ] [-VirtualSubnetId ] - [-VMNetworkAdapterName ] [-VmqWeight ] [-ManagementOS] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMNetworkAdapter [-VM] [-AllowTeaming ] [-DhcpGuard ] - [-DynamicMacAddress] [-IeeePriorityTag ] [-IovInterruptModeration ] - [-IovQueuePairsRequested ] [-IovWeight ] [-IPsecOffloadMaximumSecurityAssociation ] - [-MacAddressSpoofing ] [-MandatoryFeatureId ] [-MaximumBandwidth ] - [-MinimumBandwidthAbsolute ] [-MinimumBandwidthWeight ] [-Name ] [-Passthru] - [-PortMirroring ] [-ResourcePoolName ] [-RouterGuard ] - [-StaticMacAddress ] [-TestReplicaPoolName ] [-TestReplicaSwitchName ] - [-VirtualSubnetId ] [-VMNetworkAdapterName ] [-VmqWeight ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-VMNetworkAdapter [-VMNetworkAdapter] [-AllowTeaming ] - [-DhcpGuard ] [-DynamicMacAddress] [-IeeePriorityTag ] - [-IovInterruptModeration ] [-IovQueuePairsRequested ] - [-IovWeight ] [-IPsecOffloadMaximumSecurityAssociation ] [-MacAddressSpoofing ] - [-MandatoryFeatureId ] [-MaximumBandwidth ] [-MinimumBandwidthAbsolute ] - [-MinimumBandwidthWeight ] [-Passthru] [-PortMirroring ] - [-ResourcePoolName ] [-RouterGuard ] [-StaticMacAddress ] - [-TestReplicaPoolName ] [-TestReplicaSwitchName ] [-VirtualSubnetId ] - [-VmqWeight ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMNetworkAdapter** cmdlet configures features of the virtual network adapter in a virtual machine or the management operating system. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMNetworkAdapter -VMName Redmond -DhcpGuard On -``` - -This example enables DHCP Guard on all the virtual network adapters of virtual machine Redmond. -When DHCP Guard enabled, if virtual machine Redmond replies to requests from DHCP clients, these replies are dropped. - -### Example 2 -``` -PS C:\>Set-VMNetworkAdapter -VMName Kirkland -PortMirroring Source -``` - -This example enables port mirroring for all virtual network adapters on virtual machine Kirkland. -When port mirroring is enabled, every packet sent or received by this virtual machine is copied and sent to a monitoring virtual machine. - -### Example 3 -``` -PS C:\>Set-VMNetworkAdapter -VMName Bellevue -Name PM_Dest -PortMirroring Destination -``` - -This example configures the virtual network adapter named PM_Dest as the destination for port mirroring, which configures the virtual machine named Bellevue to monitor network traffic. -That is, a copy of every packet sent or received by a monitored virtual machine connected to the same virtual switch is sent to virtual machine Bellevue through virtual network adapter PM_Dest. - -### Example 4 -``` -PS C:\>Get-VMNetworkAdapter -All | Set-VMNetworkAdapter -VmqWeight 100 -``` - -This example enables VMQ and sets a weight of 100 on every virtual network adapter on the local host. - -### Example 5 -``` -PS C:\>Get-VM Redmond | Set-VMNetworkAdapter -AllowTeaming On -``` - -This example configures NIC Teaming for all virtual network adapters of the virtual machine named Redmond. - -### Example 6 -``` -PS C:\>Get-VMNetworkAdapter -VMName Redmond,Kirkland,Bellevue | Set-VMNetworkAdapter -MinimumBandwidthWeight 1 -``` - -This example sets the same minimum bandwidth weight for all virtual network adapters of three virtual machines: Redmond, Kirkland, and Bellevue. -This configuration shares bandwidth equally among all of the virtual network adapters of these virtual machines. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which features of the network adapter are to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DhcpGuard -Specifies whether to drop DHCP messages from a virtual machine claiming to be a DHCP server. -Allowed values are **On**, which drops DHCP messages because the virtualized DHCP server is considered untrusted) or **Off**, which allows the message to be received because the virtualized DHCP server is considered to be trustworthy. - -```yaml -Type: OnOffState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DynamicMacAddress -Assigns a dynamically generated MAC address to the virtual network adapter.. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPsecOffloadMaximumSecurityAssociation -Specifies the maximum number of security associations that can be offloaded to the physical network adapter that is bound to the virtual switch and that supports IPSec Task Offload. -Specify zero to disable the feature. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IeeePriorityTag -Specifies whether IEEE 802.1p tagged packets from the virtual machine should be trusted. -The value should be either **On** (trusted) or **Off** (not trusted). -If it is on, the IEEE 802.1p tagged packets will be let go as is. -If it is off, the priority value is reset to 0. - -```yaml -Type: OnOffState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IovInterruptModeration -Specifies the interrupt moderation value for a single-root I/O virtualization (SR-IOV) virtual function assigned to a virtual network adapter. -Allowed values are **Default**, **Adaptive**, **Off**, **Low**, **Medium**, and **High**. -If **Default** is chosen, the value is determined by the physical network adapter vendor's setting. -If **Adaptive** is chosen, the interrupt moderation rate will be based on the runtime traffic pattern. - -```yaml -Type: IovInterruptModerationValue -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IovWeight -Specifies whether single-root I/O virtualization (SR-IOV) is to be enabled on this virtual network adapter. -The relative weight sets the affinity of the virtual network adapter to the assigned SR-IOV virtual function. -The range of the value is from 0 through 100. -Specify 0 to disable SR-IOV on the virtual network adapter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MacAddressSpoofing -Specifies whether virtual machines may change the source MAC address in outgoing packets to one not assigned to them. -Allowed values are **On** (allowing the virtual machine to use a different MAC address) and **Off** (allowing the virtual machine to use only the MAC address assigned to it). - -```yaml -Type: OnOffState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies the virtual network adapter in the management operating system to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MandatoryFeatureId -Specifies the unique identifiers of the virtual switch extension features that are required for this virtual network adapter to operate. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumBandwidth -Specifies the maximum bandwidth, in bits per second, for the virtual network adapter. -The specified value is rounded to the nearest multiple of eight. -Specify zero to disable the feature. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumBandwidthAbsolute -Specifies the minimum bandwidth, in bits per second, for the virtual network adapter. -The specified value is rounded to the nearest multiple of eight. -A value larger than 100 Mbps is recommended. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinimumBandwidthWeight -Specifies the minimum bandwidth, in terms of relative weight, for the virtual network adapter. -The weight describes how much bandwidth to provide to the virtual network adapter relative to other virtual network adapters connected to the same virtual switch. -The range of the value is from 0 through 100. -Specify 0 to disable the feature. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: VMNetworkAdapterName - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the virtual network adapter to be configured. -This is a **Microsoft.Virtualization.PowerShell.VMInternalNetworkAdapter** object, if ManagementOS is specified; or a **Microsoft.Virtualization.PowerShell.VMNetworkAdapter** object otherwise. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PortMirroring -Specifies the port mirroring mode for the network adapter to be configured. -Allowed values are **None**, **Source**, and **Destination**. -If a virtual network adapter is configured as **Source**, every packet it sends or receives is copied and forwarded to a virtual network adapter configured to receive the packets. -If a virtual network adapter is configured as **Destination**, it receives copied packets from the source virtual network adapter. -The source and destination virtual network adapters must be connected to the same virtual switch. -Specify **None** to disable the feature. - -```yaml -Type: VMNetworkAdapterPortMirroringMode -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the resource pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouterGuard -Specifies whether to drop **Router Advertisement** and **Redirection** messages from unauthorized virtual machines. -The value can be either **On** or **Off**. -If **On** is specified, such messages are dropped. -If **Off** is specified, such messages are sent. - -```yaml -Type: OnOffState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StaticMacAddress -Assigns a specific a MAC address to the virtual network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine that has the virtual network you want to configure. - -```yaml -Type: VirtualMachine -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine that has the virtual network adapteryou want to configure. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter. - -```yaml -Type: VMNetworkAdapterBase -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VmqWeight -Specifies whether virtual machine queue (VMQ) is to be enabled on the virtual network adapter. -. The relative weight describes the affinity of the virtual network adapter to use VMQ. -The range of value is from 0 through 100. -Specify 0 to disable VMQ on the virtual network adapter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestReplicaPoolName -This parameter applies only to virtual machines that are enabled for replication. -It specifies the name of the network resource pool that will be used by this virtual network adapter when its virtual machine is created during a test failover. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestReplicaSwitchName -This parameter applies only to virtual machines that are enabled for replication. -It specifies the name of the virtual switch to which the virtual network adapter should be connected when its virtual machine is created during a test failover. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowTeaming -Specifies whether the virtual network adapter can be teamed with other network adapters connected to the same virtual switch. -The value can be **On** (allowed) or **Off** (disallowed). - -```yaml -Type: OnOffState -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IovQueuePairsRequested -Specifies the number of hardware queue pairs to be allocated to an SR-IOV virtual function. -If receive-side scaling (RSS) is required, and if the physical network adapter that binds to the virtual switch supports RSS on SR-IOV virtual functions, then more than one queue pair is required. -Allowed values range from 1 to 4294967295. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VirtualSubnetId -Specifies the virtual subnet ID to use with Hyper-V Network Virtualization. -Allowed values range from 4096 to 16777215 (2^24 - 1), in addition to 0. -Use 0 to clear this parameter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default. -If **-PassThru** is specified, then a **Microsoft.Virtualization.Powershell.VMInternalNetworkAdapter** is passed through to the pipeline if **-ManagementOS** is also specified, otherwise **Microsoft.Virtualization.Powershell.VMNetworkAdapter**. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapterFailoverConfiguration.md b/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapterFailoverConfiguration.md deleted file mode 100644 index c42da7b37e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapterFailoverConfiguration.md +++ /dev/null @@ -1,404 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmnetworkadapterfailoverconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMNetworkAdapterFailoverConfiguration - -## SYNOPSIS -Configures the IP address of a virtual network adapter to be used when a virtual machine fails over. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMNetworkAdapterFailoverConfiguration [-VMName] [-ClearFailoverIPv4Settings] - [-ClearFailoverIPv6Settings] [-ComputerName ] [-IPv4Address ] - [-IPv4AlternateDNSServer ] [-IPv4DefaultGateway ] [-IPv4PreferredDNSServer ] - [-IPv4SubnetMask ] [-IPv6Address ] [-IPv6AlternateDNSServer ] - [-IPv6DefaultGateway ] [-IPv6PreferredDNSServer ] [-IPv6SubnetPrefixLength ] - [-PassThru] [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMNetworkAdapterFailoverConfiguration [-VM] [-ClearFailoverIPv4Settings] - [-ClearFailoverIPv6Settings] [-IPv4Address ] [-IPv4AlternateDNSServer ] - [-IPv4DefaultGateway ] [-IPv4PreferredDNSServer ] [-IPv4SubnetMask ] - [-IPv6Address ] [-IPv6AlternateDNSServer ] [-IPv6DefaultGateway ] - [-IPv6PreferredDNSServer ] [-IPv6SubnetPrefixLength ] [-PassThru] - [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMNetworkAdapterFailoverConfiguration [-VMNetworkAdapter] - [-ClearFailoverIPv4Settings] [-ClearFailoverIPv6Settings] [-IPv4Address ] - [-IPv4AlternateDNSServer ] [-IPv4DefaultGateway ] [-IPv4PreferredDNSServer ] - [-IPv4SubnetMask ] [-IPv6Address ] [-IPv6AlternateDNSServer ] - [-IPv6DefaultGateway ] [-IPv6PreferredDNSServer ] [-IPv6SubnetPrefixLength ] - [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMNetworkAdapterFailoverConfiguration** cmdlet sets the configuration of an IP address of a virtual network adapter to be used when a virtual machine fails over. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration -IPv4Address 10.100.1.100 -IPv4SubnetMask 255.255.255.0 -``` - -This example configures a failover IPv4 address for virtual network adapter NetworkAdapter01 on virtual machine VM01. - -### Example 2 -``` -PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration -ClearFailoverIPv4Settings -``` - -This example clears the current failover IPv4 settings on virtual network adapter NetworkAdapter01 for virtual machine VM01. - -### Example 3 -``` -PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration -Ipv6Address aaaa:aaaa:aaaa:aaaa:aaaa:aaaa:aaa:aaaa -Ipv6SubnetPrefixLength 12 -``` - -This example configures an IPv6 address and a prefix length of 12 for a virtual network adapter NetworkAdapter01 for virtual machine VM01. - -### Example 4 -``` -PS C:\>Get-VMNetworkAdapter VM01 NetworkAdapter01 | Set-VMNetworkAdapterFailoverConfiguration -ClearFailoverIPv6Settings -``` - -This example clears the current failover IPv6 settings on a virtual network adapter NetworkAdapter01 for virtual machine VM01. - -## PARAMETERS - -### -ClearFailoverIPv4Settings -Clears the configured IPv4 failover settings. -The IPv4 address configured in the primary virtual machine (static or dynamic) will be used by the Replica virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClearFailoverIPv6Settings -Clears the configured IPv6 failover settings. -The IPv6 address configured in the primary virtual machine (static or dynamic) will be used by the Replica virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the IP address configuration of a virtual network adapter is to be set. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which you want to configure the IP address. - -```yaml -Type: VirtualMachine -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the friendly name of the virtual machine for which you want to configure the IP address. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter for which you want to configure the IP address. - -```yaml -Type: VMNetworkAdapterBase -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv4Address -Specifies the IPv4 address to set on the VMNetworkAdapter for use on failover of the virtual machine. -You must also specify the **IPv4SubnetMask** parameter when you specify this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4AlternateDNSServer -Specifies the IPv4 alternate DNS server to be set on the VMNetworkAdapter for use on failover of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4DefaultGateway -Specifies the IPv4 default gateway to be set on VMNetworkAdapter for use on failover of the virtual machine.. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4PreferredDNSServer -Specifies the IPv4 preferred DNS server to be set on VMNetworkAdapter for use on failover of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4SubnetMask -Specifies the IPv4 subnet mask to be set on VMNetworkAdapter for use on failover of the virtual machine. -You must specify the **IPv4Address** parameter when you specify this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6Address -Specifies the IPv6 address to be set on VMNetworkAdapter for use on failover of the virtual machine. -You must specify the **IPv6SubnetPrefixLength** parameter when you specify this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6AlternateDNSServer -Specifies the IPv6 alternate DNS server to be set on VMNetworkAdapter for use on failover of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6DefaultGateway -Specifies the IPv6 default gateway to be set on VMNetworkAdapter for use on failover of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6PreferredDNSServer -Specifies the IPv6 preferred DNS server to be set on VMNetworkAdapter for use on failover of the virtual machine. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6SubnetPrefixLength -Specifies the IPv6 subnet prefix length to be set on VMNetworkAdapter for use on failover of the virtual machine. -You must specify the **IPv6Address** parameter when you specify this parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **Microsoft.Virtualization.Powershell.VMNetworkAdapterFailoverConfiguration** object is to be passed through to the pipeline representing the IP address configuration to be set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter for which you want to set the IP address. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMNetworkAdapterFailoverConfiguration -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapterVlan.md b/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapterVlan.md deleted file mode 100644 index 76357baaa0..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMNetworkAdapterVlan.md +++ /dev/null @@ -1,441 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmnetworkadaptervlan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMNetworkAdapterVlan - -## SYNOPSIS -Configures the virtual LAN settings for the traffic through a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMNetworkAdapterVlan [-VMName] [-Access] [-AllowedVlanIdList ] [-Community] - [-ComputerName ] [-Isolated] [-NativeVlanId ] [-Passthru] [-PrimaryVlanId ] - [-Promiscuous] [-SecondaryVlanId ] [-SecondaryVlanIdList ] [-Trunk] [-Untagged] - [-VlanId ] [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMNetworkAdapterVlan [-Access] [-AllowedVlanIdList ] [-Community] [-ComputerName ] - [-Isolated] [-NativeVlanId ] [-Passthru] [-PrimaryVlanId ] [-Promiscuous] - [-SecondaryVlanId ] [-SecondaryVlanIdList ] [-Trunk] [-Untagged] [-VlanId ] - [-VMNetworkAdapterName ] [-ManagementOS] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMNetworkAdapterVlan [-VM] [-Access] [-AllowedVlanIdList ] [-Community] - [-Isolated] [-NativeVlanId ] [-Passthru] [-PrimaryVlanId ] [-Promiscuous] - [-SecondaryVlanId ] [-SecondaryVlanIdList ] [-Trunk] [-Untagged] [-VlanId ] - [-VMNetworkAdapterName ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-VMNetworkAdapterVlan [-VMNetworkAdapter] [-Access] [-AllowedVlanIdList ] - [-Community] [-Isolated] [-NativeVlanId ] [-Passthru] [-PrimaryVlanId ] [-Promiscuous] - [-SecondaryVlanId ] [-SecondaryVlanIdList ] [-Trunk] [-Untagged] [-VlanId ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMNetworkAdapterVlan** cmdlet configures virtual LAN settings for the traffic through a virtual network adapter. -Access, Trunk, Private VLAN (isolated, community, or promiscuous), and untagged are mutually exclusive. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMNetworkAdapterVlan -VMName Redmond -Access -VlanId 121 -``` - -Sets the virtual network adapter(s) in virtual machine Redmond to the Access mode. -Traffic sent by this virtual machine is tagged with VLAN ID 121. - -### Example 2 -``` -PS C:\>Set-VMNetworkAdapterVlan -VMName Redmond -Trunk -AllowedVlanIdList 1-100 -NativeVlanId 10 -``` - -Sets the virtual network adapter(s) in virtual machine Redmond to the Trunk mode. -Any traffic tagged with one of the VLAN IDs in the allowed VLAN list will be permitted to be sent or received by the VLAN. -If traffic is untagged, it will be treated as if it were on VLAN 10. - -### Example 3 -``` -PS C:\>Get-VMNetworkAdapter -VMName Redmond | Set-VMNetworkAdapterVlan -Isolated -PrimaryVlanId 10 -SecondaryVlanId 200 -``` - -Gets the virtual network adapters from virtual machine Redmond and sets them to the Private VLAN isolated mode, where primary VLAN is 10 and the secondary VLAN is 200. - -### Example 4 -``` -PS C:\>Get-VMNetworkAdapter -VMName WA | Set-VMNetworkAdapterVlan -Promiscuous -PrimaryVlanId 10 -SecondaryVlanIdList 200-201 -``` - -Gets the virtual network adapters from virtual machine WA and sets them to the Private VLAN promiscuous mode, where primary VLAN is 10 and the secondary VLANs are 201 and 202. - -### Example 5 -``` -PS C:\>Get-VM Redmond | Set-VMNetworkAdapterVlan -Untagged -``` - -Gets virtual machine Redmond and sets the virtual network adapters in the virtual machine to the untagged mode. - -## PARAMETERS - -### -Access -Specifies **Access** mode for the virtual machine network adapter. -This parameter must be specified in conjunction with parameter **VlanId**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: a - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedVlanIdList -Specifies a list of virtual LANs allowed on a virtual machine network adapter. -This parameter must be specified in conjunction with the switch parameter **Trunk**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Community -Specifies **Community** mode for the virtual machine network adapter to be configured. -This parameter must be specified in conjunction with parameters **PrimaryVlanId** and **SecondaryVlanId**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: c - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual LAN settings on a virtual machine network adapter are to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Isolated -Specifies **Isolated** mode for the virtual machine network adapter to be configured. -This parameter must be specified in conjunction with parameters **PrimaryVlanId** and **SecondaryVlanId**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: i - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies the management (e.g. -parent OS, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NativeVlanId -Specifies the native virtual LAN identifier for a virtual machine network adapter. -This parameter must be specified in conjunction with the switch parameter **Trunk**. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VMNetworkAdapterVlanSetting** object is to be passed through to the pipeline representing the virtual machine network adapter virtual LAN settings to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryVlanId -Specifies the primary virtual LAN identifier for a virtual network adapter in **Community**, **Isolated**, or **Promiscuous** mode. - -This parameter must be specified in conjunction with parameter **SecondaryVlanId** if the virtual machine network adapter is in **Community** or **Isolated** mode. -It must be used in conjunction with parameter **SecondaryVlanIdList** if the virtual machine network adapter is in **Promiscuous** mode. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Promiscuous -Specifies **Promiscuous** mode for the virtual machine network adapter. - -This parameter must be specified in conjunction with parameters **PrimaryVlanId** and **SecondaryVlanIdList**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: p - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryVlanId -Specifies the secondary virtual LAN identifier for a virtual network adapter in **Community** or **Isolated** mode. - -This parameter must be specified in conjunction with parameter **PrimaryVlanId**, along with switch parameter **Community** or **Isolated**. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecondaryVlanIdList -Specifies a list of private virtual LAN secondary virtual LANs on a virtual machine network adapter.This parameter must be specified in conjunction with parameter **PrimaryVlanId** and switch parameter **Promiscuous**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Trunk -Specifies **Trunk** mode for the virtual machine network adapter. -This parameter must be used in conjunction with parameters **AllowedVlanIdList** and **NativeVlanId**. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: t - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Untagged -Specifies **Untagged** mode for the virtual machine network adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: u - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual machine network adapter. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual machine network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanId -Specifies the virtual LAN identifier of a virtual machine network adapter. -This parameter must be specified in conjunction with switch parameter **Access**. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: AccessVlanId - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMNetworkAdapterVlanSetting -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMProcessor.md b/docset/winserver2012-ps/hyper-v/Set-VMProcessor.md deleted file mode 100644 index fdc6c03d49..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMProcessor.md +++ /dev/null @@ -1,297 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmprocessor?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMProcessor - -## SYNOPSIS -Configures one or more processors of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMProcessor [-VMName] [-CompatibilityForMigrationEnabled ] - [-CompatibilityForOlderOperatingSystemsEnabled ] [-ComputerName ] [-Count ] - [-Maximum ] [-MaximumCountPerNumaNode ] [-MaximumCountPerNumaSocket ] [-Passthru] - [-RelativeWeight ] [-Reserve ] [-ResourcePoolName ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMProcessor [-VM] [-CompatibilityForMigrationEnabled ] - [-CompatibilityForOlderOperatingSystemsEnabled ] [-Count ] [-Maximum ] - [-MaximumCountPerNumaNode ] [-MaximumCountPerNumaSocket ] [-Passthru] [-RelativeWeight ] - [-Reserve ] [-ResourcePoolName ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMProcessor [-VMProcessor] [-CompatibilityForMigrationEnabled ] - [-CompatibilityForOlderOperatingSystemsEnabled ] [-Count ] [-Maximum ] - [-MaximumCountPerNumaNode ] [-MaximumCountPerNumaSocket ] [-Passthru] [-RelativeWeight ] - [-Reserve ] [-ResourcePoolName ] -``` - -## DESCRIPTION -The **Set-VMProcessor** cmdlet configures one or more processors of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMProcessor TestVM -Count 2 -Reserve 10 -Maximum 75 -RelativeWeight 200 -``` - -Configures virtual machine TestVM with two virtual processors, a reserve of 10%, a limit of 75%, and a relative weight of 200. - -### Example 2 -``` -PS C:\>Set-VMProcessor TestVM -CompatibilityForMigrationEnabled $true -``` - -Configures virtual machine TestVM, enabling processor compatibility for live migration. - -### Example 3 -``` -PS C:\>Set-VMProcessor TestVM -CompatibilityForOlderOperatingSystemsEnabled $true -``` - -Configures virtual machine TestVM, enabling compatibility for running older operating systems. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which processors are to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Count -Specifies the number of processors for the virtual machine. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Maximum -Specifies the maximum percentage of resources available to the virtual machine processor to be configured. -Allowed values range from 0 to 100. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumCountPerNumaNode -Specifies the maximum number of processors per NUMA node to be configured for the virtual machine. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumCountPerNumaSocket -Specifies the maximum number of sockets per NUMA node to be configured for the virtual machine. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.Processor** is to be passed through to the pipeline representing the processor to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RelativeWeight -Specifies the priority for allocating the physical machine's processing power to this virtual machine relative to others. -Allowed values range from 1 to 10000. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reserve -Specifies the percentage of processor resources to be reserved for this virtual machine. -Allowed values range from 0 to 100. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolName -Specifies the name of the processor resource pool to be used. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the processor is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the processor is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMProcessor -Specifies the virtual machine processor to be configured. - -```yaml -Type: VMProcessor[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -CompatibilityForMigrationEnabled -Specifies whether the virtual processor's features are to be limited for compatibility when migrating the virtual machine to another host. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CompatibilityForOlderOperatingSystemsEnabled -Specifies whether the virtual processor's features are to be limited for compatibility with older operating systems. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VMNetworkAdapterVlanSetting -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md b/docset/winserver2012-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md deleted file mode 100644 index 4688bd7e92..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMRemoteFx3dVideoAdapter.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmremotefx3dvideoadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMRemoteFx3dVideoAdapter - -## SYNOPSIS -Configures the RemoteFX 3D video adapter of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMRemoteFx3dVideoAdapter [-VMName] [[-MonitorCount] ] [[-MaximumResolution] ] - [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMRemoteFx3dVideoAdapter [-VM] [[-MonitorCount] ] [[-MaximumResolution] ] - [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMRemoteFx3dVideoAdapter [-VMRemoteFx3dVideoAdapter] [[-MonitorCount] ] - [[-MaximumResolution] ] [-Passthru] -``` - -## DESCRIPTION -The **Set-VMRemoteFx3dVideoAdapter** cmdlet configures the RemoteFX 3D video adapter of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMRemoteFx3dVideoAdapter -VMName TestVM -MaximumResolution 1920x1200 -``` - -Sets the maximum resolution of the RemoteFX adapter on virtual machine TestVM to 1920x1200. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the RemoteFX 3D video adapter is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaximumResolution -Specifies the maximum resolution supported by this adapter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -MonitorCount -Specifies the maximum number of monitors supported by this adapter. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.RemoteFxVideoAdapter** object is to be passed through to the pipeline representing the adapter to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the adapter is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the adapter is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMRemoteFx3dVideoAdapter -Specifies the adapter to be configured. - -```yaml -Type: VMRemoteFx3DVideoAdapter[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### -None by default; Microsoft.Virtualization.Powershell.RemoteFxVideoAdapter if **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMReplication.md b/docset/winserver2012-ps/hyper-v/Set-VMReplication.md deleted file mode 100644 index 61d5d140ee..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMReplication.md +++ /dev/null @@ -1,558 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMReplication - -## SYNOPSIS -Modifies the replication settings of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMReplication [-VMName] [[-ReplicaServerName] ] [[-ReplicaServerPort] ] - [[-AuthenticationType] ] [-AllowedPrimaryServer ] [-AsJob] [-AsReplica] - [-AutoResynchronizeEnabled ] [-AutoResynchronizeIntervalEnd ] - [-AutoResynchronizeIntervalStart ] [-BypassProxyServer ] [-CertificateThumbprint ] - [-CompressionEnabled ] [-ComputerName ] [-DisableVSSSnapshotReplication] - [-EnableWriteOrderPreservationAcrossDisks ] [-InitialReplicationStartTime ] [-PassThru] - [-RecoveryHistory ] [-ReplicateHostKvpItems ] [-Reverse] [-UseBackup] - [-VSSSnapshotFrequency ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMReplication [-VM] [[-ReplicaServerName] ] [[-ReplicaServerPort] ] - [[-AuthenticationType] ] [-AllowedPrimaryServer ] [-AsJob] [-AsReplica] - [-AutoResynchronizeEnabled ] [-AutoResynchronizeIntervalEnd ] - [-AutoResynchronizeIntervalStart ] [-BypassProxyServer ] [-CertificateThumbprint ] - [-CompressionEnabled ] [-DisableVSSSnapshotReplication] - [-EnableWriteOrderPreservationAcrossDisks ] [-InitialReplicationStartTime ] [-PassThru] - [-RecoveryHistory ] [-ReplicateHostKvpItems ] [-Reverse] [-UseBackup] - [-VSSSnapshotFrequency ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMReplication [-VMReplication] [[-ReplicaServerName] ] - [[-ReplicaServerPort] ] [[-AuthenticationType] ] - [-AllowedPrimaryServer ] [-AsJob] [-AsReplica] [-AutoResynchronizeEnabled ] - [-AutoResynchronizeIntervalEnd ] [-AutoResynchronizeIntervalStart ] - [-BypassProxyServer ] [-CertificateThumbprint ] [-CompressionEnabled ] - [-DisableVSSSnapshotReplication] [-EnableWriteOrderPreservationAcrossDisks ] - [-InitialReplicationStartTime ] [-PassThru] [-RecoveryHistory ] - [-ReplicateHostKvpItems ] [-Reverse] [-UseBackup] [-VSSSnapshotFrequency ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMReplication** cmdlet modifies the replication settings of a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-VMReplication VM01 -AutoResynchronizedDisabled $true -AutoResynchronizeIntervalStart "18:30:00" -AutoResynchronizeIntervalEnd "06:00:00" -``` - -This example configures the auto-resynchronization of virtual machine VM01. - -### Example 2 -``` -PS C:\> Set-VMReplication VM01 -AsReplica -AllowedPrimaryServer server01.domain01.contoso.com -``` - -This example configures virtual machine VM01 as a Replica virtual machine, allowing replication from primary server server01 from domain domain01.contoso.com. - -### Example 3 -``` -PS C:\> Set-VMReplication VM01 -RecoveryHistory 4 -VSSSnapshotFrequency 4 -``` - -This example configures the recovery history and application-consistent recovery points of the virtual machine VM01. - -### Example 4 -``` -PS C:\> Set-VMReplication VM01 -Reverse -``` - -This example reverses the replication of virtual machine VM01. - -### Example 5 -``` -PS C:\> Set-VMReplication * server01.domain01.contoso.com 80 -``` - -This example configures replication for all virtual machines on the local Hyper-V host to Replica server server01.domain01.contoso.com and port 80. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the authentication type to use for virtual machine replication, either "Kerberos" or "Certificate". -The specified Replica server must support the chosen authentication type. -Run the Get-VMReplicationServer cmdlet to verify the authentication configured for the specified Replica server, or contact the administrator of the specified Replica server. - -```yaml -Type: ReplicationAuthenticationType -Parameter Sets: (All) -Aliases: AuthType - -Required: False -Position: 4 -Default value: Integrated -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoResynchronizeEnabled -Enables replicating virtual machines that require resynchronization to be resynchronized automatically. -(For example, a virtual machine requires resynchronization if the primary server shuts down abruptly). -Resynchronization requires significant storage and processing resources. -We recommended scheduling resynchronization during off-peak hours to reduce the impact to the host and other virtual machines running on the host. -Use the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd parameters to specify an off-peak time to start the automatic resynchronization. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: AutoResync - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoResynchronizeIntervalEnd -Specifies the end of the time period in which you want resynchronization to start automatically. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: AutoResyncEnd - -Required: False -Position: Named -Default value: 06:00AM -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AutoResynchronizeIntervalStart -Specifies the start of the time period in which you want resynchronization to start automatically. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: AutoResyncStart - -Required: False -Position: Named -Default value: 06:30PM -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassProxyServer -Specifies whether to bypass a proxy server while replicating data to the Replica server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Specifies the certificate to use for mutual authentication of the replication data. -This parameter is required only when "Certificate" is specified as the type of authentication. -Specify the thumbprint of a valid computer certificate from the Personal store. - -The certificate must have all of the following properties to be valid: - -It must not be expired. - -It must include both client and server authentication extensions for extended key usage (EKU), and an associated private key. - -It must terminate at a valid root certificate. - -The requirement for the subject common name (CN) differs depending on whether the virtual machine belongs to a cluster. -For virtual machines that do not belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) should contain, the FQDN of the host. -For virtual machines that belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) must contain, the and fully-qualified domain name (FQDN) of the Hyper-V Replica Broker. - -To display a list of certificates in the computer's My store and the thumbprint of each certificate, type the following: - -`PS C:\\\> cd cert:\LocalMachine\My` - -`PS C:\\\> dir | format-list` - -For more information about certificate stores, see http://technet.microsoft.com//library/cc757138.aspxhttp://technet.microsoft.com//library/cc757138.aspx. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Thumbprint,Cert - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CompressionEnabled -Specifies whether replication data sent over the network is to be compressed. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which replication is to be enabled. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitialReplicationStartTime -Specifies the time to start the initial replication, when scheduling initial replication to occur later. -You can specify a time up to 7 days later. -When this parameter is not specified, initial replication occurs immediately. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: IRTime - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplication** object is to be passed through to the pipeline representing the replication configuration to be set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RecoveryHistory -Specifies whether to store additional recovery points on the Replica virtual machine. -Storing more than the most recent recovery point of the primary virtual machine allows you to recover to an earlier point in time. -However, storing additional recovery points requires more storage and processing resources. -You can configure as many as 15 recovery points to be stored. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: RecHist - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Reverse -Reverses the replication of the virtual machine, switching it from a primary virtual machine to a Replica virtual machine, or from a Replica virtual machine to a primary virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which the replication configuration is to be set. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which the replication configuration is to be set. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: Name - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMReplication -Specifies a virtual machine replication object for which the configuration is to be set. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AsReplica -Specifies that the virtual machine is a replica virtual machine, enabling it to be used as the source for the initial replication of the primary virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableVSSSnapshotReplication -Specifies whether to replicate volume shadow copy service (VSS) snapshots. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: DisableVSS - -Required: False -Position: Named -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableWriteOrderPreservationAcrossDisks -Determines whether all virtual hard disks selected for replication are replicated to the same point in time. -This is useful if the virtual machine runs an application that saves data across virtual hard disks (for example, one virtual hard disk dedicated for application data, and another virtual hard disk dedicated for application log files). - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaServerName -Specifies the name of the Replica server to which this virtual machine will be replicated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ReplicaServer - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaServerPort -Specifies the port on the Replica server to use for replication traffic. -Make sure you specify a port that is configured on the Replica server to support the same authentication type you specify using the AuthenticationType parameter in this cmdlet. -Run the Get-VMReplicationServer cmdlet on the Replica server to check the configuration of the port, or contact the administrator of the specified Replica server. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ReplicaPort - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicateHostKvpItems -Specifies whether to replicate host-only key value pairs (KVP) for this virtual machine. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseBackup -Specifies that a restored copy of the virtual machine on the Replica server is to be used as the source of the initial replication. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VSSSnapshotFrequency -Specifies how often to replicate volume shadow copy service (VSS) copies of the virtual machine, which are called application-consistent recovery points. -Valid values are in increments of one hour. -You can specify from 1 through 12 hours. -Use of this parameter requires that you also use the "Recovery History" parameter to specify at least one additional recovery point. -Using application-consistent recovery points impacts the performance of applications running in the primary virtual machine when these snapshots are taken. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: VSSFreq - -Required: False -Position: Named -Default value: 4 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowedPrimaryServer -When you use the AsReplica parameter to specify a virtual machine as a Replica virtual machine, this parameter determines which primary servers can send replication to the Replica virtual machine. -Replication is accepted only from the server specified in the chosen authentication entry, or any other authentication entry that has the same trust group. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: AllowedPS - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplication -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMReplicationAuthorizationEntry.md b/docset/winserver2012-ps/hyper-v/Set-VMReplicationAuthorizationEntry.md deleted file mode 100644 index d9ad568999..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMReplicationAuthorizationEntry.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmreplicationauthorizationentry?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMReplicationAuthorizationEntry - -## SYNOPSIS -Modifies an authorization entry on a Replica server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMReplicationAuthorizationEntry [-AllowedPrimaryServer] [[-ReplicaStorageLocation] ] - [[-TrustGroup] ] [-ComputerName ] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMReplicationAuthorizationEntry [-VMReplicationAuthorizationEntry] - [[-ReplicaStorageLocation] ] [[-TrustGroup] ] [-PassThru] -``` - -## DESCRIPTION -The **Set-VMReplicationAuthorizationEntry** cmdlet modifies an authorization entry on Replica server. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMReplicationAuthorizationEntry server01.domain01.contoso.com -ReplicaStorageLocation "D:\NewStorageLocation" -``` - -This example sets the location of the replication authorization entry for allowed primary server server01.domain01.contoso.com to location D:\NewStorageLocation. - -### Example 2 -``` -PS C:\>Set-VMReplicationAuthorizationEntry server01.domain01.contoso.com -TrustGroup TrustGroup01 -``` - -This example sets the trust group of the replication authorization entry for allowed primary server server01.domain01.contoso.com to TrustGroup01. - -## PARAMETERS - -### -AllowedPrimaryServer -Specifies the allowed primary server of the authorization entry to be modified. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the authorization entry is to be set. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that an object is to be passed through to the pipeline representing the replication authorization entry to be set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaStorageLocation -Specifies the location to store the Replica virtual hard disk files from the allowed server when a new Replica virtual machine is created. -Modifying this location does not affect any existing virtual hard disk files on the Replica server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TrustGroup -Identifies a group of primary servers within which a given primary virtual machine can move so replications of the primary virtual machine are accepted by the Replica server only from primary servers that belong to the trust group. -You can use any string to create a new trust group. -Ensure all primary servers within a specific trust group use the same string as the value you specify for this parameter. - -Use of a trust group can help you keep virtual machines isolated by maintaining control over which primary servers are trusted to provide replication, while also allowing the virtual machines to move from one primary server to another (such as through live migration or failover from a cluster node). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMReplicationAuthorizationEntry -Specifies the authorization entry to be set. - -```yaml -Type: VMReplicationAuthorizationEntry[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplicationAuthorizationEntry -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMReplicationServer.md b/docset/winserver2012-ps/hyper-v/Set-VMReplicationServer.md deleted file mode 100644 index 7388e441cd..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMReplicationServer.md +++ /dev/null @@ -1,361 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmreplicationserver?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMReplicationServer - -## SYNOPSIS -Configures a host as a Replica server. - -## SYNTAX - -### AuthenticationPort (Default) -``` -Set-VMReplicationServer [[-ReplicationEnabled] ] - [[-AllowedAuthenticationType] ] [[-ReplicationAllowedFromAnyServer] ] - [-CertificateAuthenticationPort ] [-CertificateThumbprint ] [-ComputerName ] - [-DefaultStorageLocation ] [-Force] [-KerberosAuthenticationPort ] - [-MonitoringInterval ] [-MonitoringStartTime ] [-PassThru] [-Confirm] [-WhatIf] -``` - -### AuthenticationPortMapping -``` -Set-VMReplicationServer [[-ReplicationEnabled] ] - [[-AllowedAuthenticationType] ] [[-ReplicationAllowedFromAnyServer] ] - [-CertificateAuthenticationPortMapping ] [-CertificateThumbprint ] - [-ComputerName ] [-DefaultStorageLocation ] [-Force] - [-KerberosAuthenticationPortMapping ] [-MonitoringInterval ] - [-MonitoringStartTime ] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMReplicationServer** cmdlet configures a host as a Replica server and enables you to specify the types of authentication and ports to use for incoming replication traffic. - -To restrict the replication traffic that the Replica server will accept by allowing it only from specific servers, use the **New-VMReplicationAuthorizationEntry** cmdlet. - -## EXAMPLES - -### Example 1 -```powershell -PS C:\> Set-VMReplicationServer $true -AllowedAuthenticationType Kerberos -``` - -This example configures the local host as a Replica server and specifies Kerberos for authentication. - -### Example 2 -```powershell -PS C:\> Set-VMReplicationServer -ReplicationEnabled $true -AllowedAuthenticationType -ReplicationAllowedFromAnyServer $true -DefaultStorageLocation d:\DefaultReplicaStorage -``` - -This example configures a Replica server that accepts replication from all authenticated servers and uses a default storage location of d:\DefaultReplicaStorage. - -### Example 3 -```powershell -PS C:\> Set-VMReplicationServer -MonitoringInterval "12:00:00" -MonitoringStartTime "17:00:00" -``` - -This example configures the Replica server with a monitoring interval of 12 hours starting at 17:00 hours. - -### Example 4 -```powershells -PS C:\> $portmapping = @{"Server1.contoso.com" = 82; "Server2.contoso.com" = 81; "Broker.contoso.com" = 80} -PS C:\> Set-VMReplicationServer -KerberosAuthenticationPortMapping $portmapping -``` - -This example configures the nodes of the cluster to receive replication on different ports. -The first command declares a variable named portmapping and uses it to store the server names of the nodes and the port to use on each node. -The second command configures each node of the cluster to use port mapping for Kerberos authentication using the values stored in the portmapping variable. - -## PARAMETERS - -### -AllowedAuthenticationType -Specifies which authentication types the Replica server will use. -Allowed values are Kerberos, Certificate, or CertificateAndKerberos. - -```yaml -Type: RecoveryAuthenticationType -Parameter Sets: (All) -Aliases: AuthType - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateAuthenticationPort -Specifies the port on which the Replica server will receive replication data using certificate-based authentication. -This parameter can be set only when the value of the AllowedAuthType parameter is Certificate or CertificateAndKerberos. - -```yaml -Type: Int32 -Parameter Sets: AuthenticationPort -Aliases: CertAuthPort - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateAuthenticationPortMapping -When using Hyper-V Replica with failover clustering and certificate-based authorization, you can use this parameter to specify a different port for each node of the cluster to receive replication. -We recommend that you specify a unique port for each node of the cluster, and one unique port for the Hyper-V Replica Broker. -This parameter can be set only when the Replica server is configured with an authentication type of Certificate or CertificateAndKerberos. - -```yaml -Type: Hashtable -Parameter Sets: AuthenticationPortMapping -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Specifies the certificate to use for mutual authentication of the replication data. -This parameter is required only when Certificate is specified as the type of authentication. -Specify the thumbprint of a valid computer certificate from the Personal store. - -- The certificate must have all of the following properties to be valid: -- It must not be expired. -- It must include both client and server authentication extensions for extended key usage (EKU), and an associated private key. -- It must terminate at a valid root certificate. -- Meet the requirements for the subject common name (CN): - -For servers that are not clustered, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) should contain, the FQDN of the host. - -For servers that are clustered, each node must have two certificates - one in which the subject common name (CN) or subject alternative name (DNS Name) is the name of the node, and the other in which subject common name (CN) or subject alternative name (DNS Name) is FQDN of the Hyper-V Replica Broker. - -To display a list of certificates in the computer's My store and the thumbprint of each certificate, type the following: - -`PS C:\\\> cd cert:\LocalMachine\My` - -`PS C:\\\> dir | format-list` - -For more information about certificate stores, see [Certificate stores](/previous-versions/windows/it-pro/windows-server-2003/cc757138(v=ws.10)). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Thumbprint - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Configures Replica server settings for one or more Hyper-V hosts. -NetBIOS names, IP addresses, and fully qualified domain names are allowable. -The default is the local computer. -Use localhost or a dot (.) to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultStorageLocation -Specifies the default location to store the virtual hard disk files when a Replica virtual machine is created. -You must specify this parameter when ReplicationAllowedFromAnyServer is True. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: StorageLoc - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies whether the command runs without requiring confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosAuthenticationPort - - -```yaml -Type: Int32 -Parameter Sets: AuthenticationPort -Aliases: KerbAuthPort - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KerberosAuthenticationPortMapping -When using Hyper-V Replica with failover clustering and Kerberos authorization, you can use this parameter to specify a different port for each node of the cluster to receive replication. -We recommend that you specify a unique port for each node of the cluster, and one unique port for the Hyper-V Replica Broker. -This parameter can be set only when the Replica server is configured with an authentication type of either Kerberos or CertificateAndKerberos. - -```yaml -Type: Hashtable -Parameter Sets: AuthenticationPortMapping -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringInterval -Specifies how often (the monitoring interval) replication statistics are computed. -Valid values are: 1 hour, 2 hours, 3 hours, 4 hours, 6 hours, 8 hours, 12 hours, 24 hours, 2 days, 3 days, 4 days, 5 days, 6 days, 7 days. -Specify in the format days:hours:minutes:seconds, such as 01:00:00 for 1 hour, or 1.00:00:00 for 1 day. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 24 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MonitoringStartTime -Specifies when the monitoring interval starts. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 9 AM -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplicationServer** object is to be passed through to the pipeline representing the replication settings of the Replica server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationAllowedFromAnyServer -Specifies whether to accept replication requests from any server. -When specified as **true**, DefaultStorageLocation must also be specified. -The default storage location and DEFAULT trust group tag are used for virtual machine replicas. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: AllowAnyServer - -Required: False -Position: 3 -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicationEnabled -Specifies whether the host is enabled as a Replica server. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: RepEnabled - -Required: False -Position: 1 -Default value: True -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMRecoveryServer -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/hyper-v/Set-VMResourcePool.md b/docset/winserver2012-ps/hyper-v/Set-VMResourcePool.md deleted file mode 100644 index f3ffae1690..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMResourcePool.md +++ /dev/null @@ -1,165 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmresourcepool?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMResourcePool - -## SYNOPSIS -Sets the parent resource pool for a selected resource pool. - -## SYNTAX - -``` -Set-VMResourcePool [-Name] [-ResourcePoolType] [-ParentName] - [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMResourcePool** cmdlet sets a parent resource pool for a selected resource pool. -(To remove a parent from a resource pool, set the primordial pool of the resource pool's type as its parent.) - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMResourcePool ChildPool VHD ParentPool -``` - -Set a virtual hard drive resource pool ParentPool as the parent of virtual hard drive resource pool ChildPool. - -### Example 2 -``` -PS C:\>Set-VMResourcePool ChildPool VHD Primordial -``` - -Remove the parent resource pool from virtual hard drive resource pool ChildPool. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a resource pool's parent is to be set. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the resource pool whose parent resource pool is to be set. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentName -Specifies the name of the resource pool to be set as a parent. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **VMResourcePool** object is to be passed through to the pipeline representing the resource pool whose parent is to be set. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourcePoolType -Specifies the type of the resource pool whose parent is to be set. - -```yaml -Type: VMResourcePoolType -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMResourcePool -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMSan.md b/docset/winserver2012-ps/hyper-v/Set-VMSan.md deleted file mode 100644 index 8a64895775..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMSan.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmsan?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMSan - -## SYNOPSIS -Configures a virtual storage area network (SAN) on one or more Hyper-V hosts. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMSan [-Name] [-HostBusAdapter ] [-Note ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMSan [-Name] [-ComputerName ] [-Note ] [-Passthru] - -WorldWideNodeName -WorldWidePortName -``` - -## DESCRIPTION -The **Set-VMSan** cmdlet configures a virtual storage area network (SAN) on one or more Hyper-V hosts. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Set-VMSan -Name Production -WorldWideNodeName C003FF0000FFFF22 -WorldWidePortName C003FF5778E50024 -``` - -Configures a virtual storage area network (SAN) named Production with the specified WorldWideNodeName and WorldWidePortName values. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual storage area network (SAN) is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -HostBusAdapter -Specifies the Fibre Channel host bus adapter to be associated with the virtual storage area network (SAN). - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual storage area network (SAN) to be configured. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Note -Specifies the note to be associated with the virtual storage area network (SAN). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that an object is to be passed through to the pipeline representing the configured virtual storage area network (SAN). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWideNodeName -The World Wide Node name of the Fibre Channel host bus adapter to be associated with this virtual storage area network (SAN). - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WorldWidePortName -The World Wide Port name of the Fibre Channel host bus adapter to be associated with this virtual storage area network (SAN). - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.PowerShell.SAN -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMSwitch.md b/docset/winserver2012-ps/hyper-v/Set-VMSwitch.md deleted file mode 100644 index 47275a746d..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMSwitch.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmswitch?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMSwitch - -## SYNOPSIS -Configures a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMSwitch [-Name] [-AllowManagementOS ] [-ComputerName ] - [-DefaultFlowMinimumBandwidthAbsolute ] [-DefaultFlowMinimumBandwidthWeight ] - [-Extensions ] [-Notes ] [-Passthru] [-SwitchType ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMSwitch [-Name] [-NetAdapterInterfaceDescription] [-AllowManagementOS ] - [-ComputerName ] [-DefaultFlowMinimumBandwidthAbsolute ] - [-DefaultFlowMinimumBandwidthWeight ] [-Extensions ] [-Notes ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMSwitch [-VMSwitch] [-NetAdapterInterfaceDescription] [-AllowManagementOS ] - [-ComputerName ] [-DefaultFlowMinimumBandwidthAbsolute ] - [-DefaultFlowMinimumBandwidthWeight ] [-Extensions ] [-Notes ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-VMSwitch [-VMSwitch] [-AllowManagementOS ] [-ComputerName ] - [-DefaultFlowMinimumBandwidthAbsolute ] [-DefaultFlowMinimumBandwidthWeight ] - [-Extensions ] [-Notes ] [-Passthru] [-SwitchType ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Set-VMSwitch [-Name] [-NetAdapterName] [-AllowManagementOS ] - [-ComputerName ] [-DefaultFlowMinimumBandwidthAbsolute ] - [-DefaultFlowMinimumBandwidthWeight ] [-Extensions ] [-Notes ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Set-VMSwitch [-VMSwitch] [-NetAdapterName] [-AllowManagementOS ] - [-ComputerName ] [-DefaultFlowMinimumBandwidthAbsolute ] - [-DefaultFlowMinimumBandwidthWeight ] [-Extensions ] [-Notes ] [-Passthru] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMSwitch** cmdlet configures a virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Set-VMSwitch WA -SwitchType Internal -``` - -This example converts a virtual switch named WA to an Internal switch. - -### Example 2 -``` -PS C:\> Set-VMSwitch CA -DefaultFlowMinimumBandwidthAbsolute 500000000 -``` - -This example sets the minimum bandwidth allocation to 500Mbps on a virtual switch named CA for all virtual machines without explicit minimum bandwidth configuration. - -## PARAMETERS - -### -AllowManagementOS -Specifies whether the management operating system can use the physical network adapter that is bound to the virtual switch. Setting **AllowManagementOS** to `$true` creates management operating system virtual network adapters (VMNetworkAdapters) in the parent partition and connects it to the virtual switch. Setting **AllowManagementOS** to `$false` removes any VMNetworkAdapters connected to the virtual switch. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual switch is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: PSComputerName - -Required: False -Position: Named -Default value: . -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DefaultFlowMinimumBandwidthAbsolute -Specifies the minimum bandwidth, in bits per second, that is allocated to a special category called "default flow." Any traffic sent by a virtual network adapter that is connected to this virtual switch and does not have minimum bandwidth allocated is filtered into this category. -Specify a value for this parameter only if the minimum bandwidth mode on this virtual switch is absolute (See the New-VMSwitch cmdlet). -By default, the virtual switch allocates 10% of the total bandwidth, which depends on the physical network adapter it binds to, to this category. -For example, if a virtual switch binds to a 1 GbE network adapter, this special category can use at least 100 Mbps. -If the value is not a multiple of 8, the value is rounded down to the nearest number that is a multiple of 8. -For example, a value input as 1234567 is converted to 1234560. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DefaultFlowMinimumBandwidthWeight -Specifies the minimum bandwidth, in relative weight, that is allocated to a special category called "default flow". -Any traffic sent by a virtual network adapter that is connected to this virtual switch and doesn't have minimum bandwidth allocated is filtered into this category. -Specify a value for this parameter only if the minimum bandwidth mode on this virtual switch is weight (See the New-VMSwitch cmdlet). -By default, this special category has a weight of 1. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 10 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Extensions -Specifies an ordered list of network extensions used to reorder the bindings on the virtual switch. - -```yaml -Type: VMSwitchExtension[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual switch to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_5 -Aliases: SwitchName - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Notes -Specifies notes to be associated with the virtual switch. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.EthernetSwitch** object is to be passed through to the pipeline representing the virtual switch to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchType -Converts a virtual switch from one type to another. -Allowed values are **Internal** or **Private**. -You can convert an internal or private virtual switch to an external virtual switch, by including either the **NetAdapterInterfaceDescription** or **NetAdapterName** parameter in the command. -If you do this, the external virtual switch is configured to allow the management operating system to share access to the physical network adapter. -To override this behavior, include AllowManagementOs $false in the command. - -```yaml -Type: VMSwitchType -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch to be configured. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NetAdapterInterfaceDescription -Specifies the interface description of the physical network adapter to which an external virtual switch should be bound. -If you specify this parameter to convert a virtual switch, the external virtual switch is configured to allow the management operating system to share access to the physical network adapter. -To override this behavior, include AllowManagementOs $false in the command - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetAdapterName -Specifies the name of the physical network adapter to which an external virtual switch should be bound. -If you specify this parameter to convert a virtual switch, the external virtual switch is configured to allow the management operating system to share access to the physical network adapter. -To override this behavior, include AllowManagementOs $false in the command - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_6 -Aliases: InterfaceAlias - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.EthernetSwitch -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMSwitchExtensionPortFeature.md b/docset/winserver2012-ps/hyper-v/Set-VMSwitchExtensionPortFeature.md deleted file mode 100644 index dcdeeb6893..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMSwitchExtensionPortFeature.md +++ /dev/null @@ -1,262 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmswitchextensionportfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMSwitchExtensionPortFeature - -## SYNOPSIS -Configures a feature on a virtual network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMSwitchExtensionPortFeature [-VMName] [-ComputerName ] [-Passthru] - [-VMNetworkAdapterName ] -VMSwitchExtensionFeature [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMSwitchExtensionPortFeature [-SwitchName] [-ComputerName ] [-Passthru] [-ExternalPort] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-VMSwitchExtensionPortFeature [-ComputerName ] [-Passthru] [-VMNetworkAdapterName ] - [-ManagementOS] -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-VMSwitchExtensionPortFeature [-VM] [-Passthru] [-VMNetworkAdapterName ] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Set-VMSwitchExtensionPortFeature [-VMNetworkAdapter] [-Passthru] - -VMSwitchExtensionFeature [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-VMSwitchExtensionPortFeature** cmdlet configures a feature on a virtual network adapter. -The feature must have been configured previously on the virtual network adapter. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$ModifiedFeature = Get-VMSwitchExtensionPortFeature -VMName VM2 -FeatureName "Ethernet Switch Port Security Settings" -PS C:\>$ModifiedFeature.SettingData.EnableDhcpGuard = $false -PS C:\>Set-VMSwitchExtensionPortFeature -VMName VM2 -VMSwitchExtensionFeature $ModifiedFeature -``` - -Configures the feature on a virtual network adapter(s) on virtual machine VM2. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a feature on a virtual network adapter is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExternalPort -Specifies the virtual switch port connected to the external network interface card. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagementOS -Specifies the management (e.g. -parent, or host) operating system. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.HyperV.PowerShell.VMSwitchExtensionPortFeature** object is to be passed through to the pipeline representing the feature to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which the feature is to be configured. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which the feature is to be configured. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapter -Specifies the virtual network adapter. - -```yaml -Type: VMNetworkAdapterBase[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMNetworkAdapterName -Specifies the name of the virtual network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be configured. - -```yaml -Type: VMSwitchExtensionPortFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMSwitchExtensionPortFeature -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Set-VMSwitchExtensionSwitchFeature.md b/docset/winserver2012-ps/hyper-v/Set-VMSwitchExtensionSwitchFeature.md deleted file mode 100644 index 8b1590358e..0000000000 --- a/docset/winserver2012-ps/hyper-v/Set-VMSwitchExtensionSwitchFeature.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/set-vmswitchextensionswitchfeature?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-VMSwitchExtensionSwitchFeature - -## SYNOPSIS -Configures a feature on a virtual switch. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-VMSwitchExtensionSwitchFeature [-SwitchName] [-ComputerName ] [-Passthru] - -VMSwitchExtensionFeature -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-VMSwitchExtensionSwitchFeature [-VMSwitch] [-Passthru] - -VMSwitchExtensionFeature -``` - -## DESCRIPTION -The **Set-VMSwitchExtensionSwitchFeature** cmdlet configures a feature on a virtual switch. -The feature must have already been configured on the virtual switch. - -## EXAMPLES - -### Example 1 -``` -PS C:\>$feature = Get-VMSystemSwitchExtensionSwitchFeature -FeatureName "Ethernet Switch Bandwidth Settings" -PS C:\>$feature.SettingData.DefaultFlowReservation = 100000000 -PS C:\>Set-VMSwitchExtensionSwitchFeature External $feature -``` - -Configures the feature on virtual switch External. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which a feature is to be configured. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Passthru -Specifies that a **Microsoft.HyperV.PowerShell.VMSwitchExtensionSwitchFeature** is to be passed through to the pipeline representing the feature to be configured. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchName -Specifies the name of the virtual switch. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitch -Specifies the virtual switch. - -```yaml -Type: VMSwitch[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMSwitchExtensionFeature -Specifies the feature to be configured. - -```yaml -Type: VMSwitchExtensionSwitchFeature[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.HyperV.PowerShell.VMSwitchExtensionSwitchFeature -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Start-VM.md b/docset/winserver2012-ps/hyper-v/Start-VM.md deleted file mode 100644 index e821d1176c..0000000000 --- a/docset/winserver2012-ps/hyper-v/Start-VM.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/start-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-VM - -## SYNOPSIS -Starts a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Start-VM [-Name] [-AsJob] [-ComputerName ] [-Passthru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Start-VM [-VM] [-AsJob] [-Passthru] -``` - -## DESCRIPTION -The **Start-VM** cmdlet starts a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Start-VM -Name TestVM -``` - -Starts virtual machine TestVM. - -### Example 2 -``` -PS C:\>Start-VM -Name Test* -``` - -Starts all virtual machines whose names start with "Test." - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual machine is to be started. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be started. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VirtualMachine** object is to be passed through to the pipeline representing the virtual machine to be started. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be started. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Start-VMFailover.md b/docset/winserver2012-ps/hyper-v/Start-VMFailover.md deleted file mode 100644 index 69c316598a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Start-VMFailover.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/start-vmfailover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-VMFailover - -## SYNOPSIS -Starts failover on a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Start-VMFailover [-VMName] [-AsJob] [-ComputerName ] [-PassThru] [-Prepare] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Start-VMFailover [-VM] [-AsJob] [-PassThru] [-AsTest] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Start-VMFailover [-VMRecoverySnapshot] [-AsJob] [-PassThru] [-AsTest] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Start-VMFailover [-VMName] [-AsJob] [-ComputerName ] [-PassThru] [-AsTest] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Start-VMFailover [-VM] [-AsJob] [-PassThru] [-Prepare] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Start-VMFailover [-VMRecoverySnapshot] [-AsJob] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-VMFailover** cmdlet can be used for the following tasks: - -Fail over a Replica virtual machine to a chosen recovery point. - -Start a planned failover on a primary virtual machine. - -Create a test virtual machine on a Replica virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-VMSnapshot VM01 -Name Snapshot01 | Start-Failover -``` - -This example starts failover of a virtual machine named VM01 with recovery point Snapshot01. - -Note: Recovery points are stored as snapshots. -To get a list of all snapshots, use the Get-VMSnapshot cmdlet. - -### Example 2 -``` -PS C:\>Start-VMFailover VM01 -AsTest -``` - -This example starts a test failover of a virtual machine named VM01. - -### Example 3 -``` -PS C:\>Get-VMSnapshot VM01 -Name Snapshot01 | Start-Failover -AsTest -``` - -Starts a test failover of a virtual machine named VM01 with recovery point Snapshot01. - -### Example 4 -``` -PS C:\>Start-VMFailover -Prepare -VMName VM01 -computername MyPrimary.contoso.com PS C:\>Start-VMFailover -VMName VM01 -computername MyReplica.contoso.com PS C:\>Set-VMReplication -Reverse -VMName VM01 -computername MyReplica.contoso.com PS C:\>Start-VM -VMName VM01 -computername MyReplica.contoso.com -``` - -This example shows the cmdlets you use to perform a planned failover. -The first command prepares for the planned failover of a primary virtual machine named VM01 by replicating any pending changes. -The second command fails over the Replica virtual machine. -The second command fails over the Replica virtual machine. -The third command switches the Replica virtual machine to a primary virtual machine. -The third command starts the virtual machine that has been switched from a Replica virtual machine to a primary virtual machine. - -## PARAMETERS - -### -AsJob -Runs the command as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsTest -Creates a test virtual machine using the chosen recovery point. -You can use a test virtual machine to validate a Replica virtual machine. -To stop a test failover, use the Stop-VMFailover cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which failover is to be started. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a virtual machine object is to be passed through to the pipeline representing the virtual machine on which failover is to be started. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Prepare -Starts the planned failover on the primary virtual machine and replicates any pending changes. -To complete the planned failover, use the Set-VMReplication and Start-VM cmdlets as shown in Example 4. - -Note: The primary virtual machine must be shut down to prepare it for failover. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine for which failover is to be started. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine for which failover is to be started. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMRecoverySnapshot -Specifies the recovery snapshot to use during a failover. -(This parameter is not required for a planned failover.) - -```yaml -Type: VMSnapshot -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Start-VMInitialReplication.md b/docset/winserver2012-ps/hyper-v/Start-VMInitialReplication.md deleted file mode 100644 index 8dd6abb809..0000000000 --- a/docset/winserver2012-ps/hyper-v/Start-VMInitialReplication.md +++ /dev/null @@ -1,261 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/start-vminitialreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-VMInitialReplication - -## SYNOPSIS -Starts replication of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Start-VMInitialReplication [-VMName] [-AsJob] [-ComputerName ] [-DestinationPath ] - [-InitialReplicationStartTime ] [-PassThru] [-UseBackup] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Start-VMInitialReplication [-VM] [-AsJob] [-DestinationPath ] - [-InitialReplicationStartTime ] [-PassThru] [-UseBackup] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Start-VMInitialReplication [-VMReplication] [-AsJob] [-DestinationPath ] - [-InitialReplicationStartTime ] [-PassThru] [-UseBackup] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Start-VMInitialReplication** cmdlet starts replication of a virtual machine using the method you select. -You also can schedule replication to start up to 7 days later. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Start-VMInitialReplication VM01 -``` - -This example starts initial replication of virtual machine VM01 over the network. - -### Example 2 -``` -PS C:\>Start-VMInitialReplication * -``` - -This example starts initial replication over the network for all the virtual machines on the local Hyper-V host for which initial replication is pending. - -### Example 3 -``` -PS C:\>Start-VMInitialReplication * -DestinationPath R:\IRLoc -``` - -This example exports the initial replication of all virtual machines on the local Hyper-V host for which initial replication is pending, to the location R:\IRLoc. -This example assumes that the location is an external drive, which would be shipped to the Replica site so that the initial replication can be completed. - -### Example 4 -``` -PS C:\>Enable-VMReplication VM01 -AsReplica -computername MyReplica.contoso.com PS C:\>Enable-VMReplication VMO1 -ReplicaServerName ReplicaServer01 -ReplicaServerPort 80 -AuthenticationType Kerberos -computername MyPrimary.contoso.comPS PS C:\>Start-VMInitialReplication VM01 -usebackup -computername MyPrimary.contoso.com -``` - -This example uses several consecutive commands to start initial replication from backup. -First, it enables a restored copy of virtual machine VM01 on the Replica server as a Replica virtual machine. -Then, it enables replication for VM01 from the primary server. -Finally, it starts the initial replication to use the restored copy of VM01 on Replica server as the basis of the initial replication. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which replication of a virtual machine is to be started. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DestinationPath -Specifies the path to use when copying the files for initial replication; assumes use of external media as the method for initial replication. -External media is typically a removable drive that is shipped to the location of the Replica server. -When the external media arrives at the Replica site, use the Import-InitialVMReplication on the Replica virtual machine to copy the files. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitialReplicationStartTime -Specifies the time to start the initial replication, when scheduling initial replication to occur later. -You can specify a time up to 7 days later. -When this parameter is not specified, initial replication occurs immediately. - -```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a VM object is to be passed through to the pipeline representing the virtual machine on which replication is to be started. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine on which replication is to be started. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine on which replication is to be started. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies an object that represents the replication to be started. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -UseBackup -Indicates that you want to use a copy of this virtual machine on the Replica server as the basis for the initial replication. -Specify this option only if it was specified when replication was enabled on the primary virtual machine. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Stop-VM.md b/docset/winserver2012-ps/hyper-v/Stop-VM.md deleted file mode 100644 index c6bc09ed91..0000000000 --- a/docset/winserver2012-ps/hyper-v/Stop-VM.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/stop-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-VM - -## SYNOPSIS -Shuts down, turns off, or saves a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-VM [-Name] [-AsJob] [-ComputerName ] [-Force] [-Passthru] [-Save] [-TurnOff] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-VM [-VM] [-AsJob] [-Force] [-Passthru] [-Save] [-TurnOff] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-VM** cmdlet shuts down, turns off, or saves a virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-VM -Name TestVM -``` - -Shuts down virtual machine TestVM through the guest operating system. - -### Example 2 -``` -PS C:\>Stop-VM -Name VM1 -Force -``` - -Shuts down virtual machine TestVM through the guest operating system, regardless of any unsaved application data. -Hyper-V gives the guest five minutes to save data, then forces a shutdown. -This shutdown can result in loss of unsaved data. - -### Example 3 -``` -PS C:\>Stop-VM -Name TestVM -TurnOff -``` - -Turns off virtual machine TestVM. -This operation is equivalent to disconnecting the power from the virtual machine, and can result in loss of unsaved data. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual machine is to be shut down. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Specifies that the shutdown of the virtual machine is to be forced. -If the virtual machine has applications with unsaved data, the virtual machine has five minutes to save data and shut down. -If the virtual machine is locked, it is shut down immediately. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be shut down. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VirtualMachine** object is to be passed through to the pipeline representing the virtual machine to be shut down. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Save -Specifies that the virtual machine is to be saved. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TurnOff -Specifies that the virtual machine is to be turned off. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be shut down. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Stop-VMFailover.md b/docset/winserver2012-ps/hyper-v/Stop-VMFailover.md deleted file mode 100644 index b25b7ab348..0000000000 --- a/docset/winserver2012-ps/hyper-v/Stop-VMFailover.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/stop-vmfailover?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-VMFailover - -## SYNOPSIS -Stops failover of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-VMFailover [-VMName] [-AsJob] [-ComputerName ] [-PassThru] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-VMFailover [-VM] [-AsJob] [-PassThru] -``` - -## DESCRIPTION -The **Stop-VMFailover** cmdlet stops failover of a virtual machine. -If the virtual machine is running, this cmdlet turns the virtual machine off and cancels failover. -For a test failover, this cmdlet stops the test failover and deletes the test virtual machine. -For a planned failover that has been started on a primary virtual machine, this cmdlet cancels that action and restarts replication, which allows you to start the primary virtual machine. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-VMFailover VM01 -``` - -This example stops failover for a virtual machine named VM01. - -### Example 2 -``` -PS C:\> Stop-VMFailover * -``` - -This example stops all running failovers for all the virtual machines on the local Hyper-V host. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more hosts on which to cancel the failover of a virtual machine. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a VM object is to be passed through to the pipeline representing the virtual machine on which failover is to be stopped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose failover you want to cancel. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose you want to cancel. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Stop-VMInitialReplication.md b/docset/winserver2012-ps/hyper-v/Stop-VMInitialReplication.md deleted file mode 100644 index a1eef75c5a..0000000000 --- a/docset/winserver2012-ps/hyper-v/Stop-VMInitialReplication.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/stop-vminitialreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-VMInitialReplication - -## SYNOPSIS -Stops an ongoing initial replication. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-VMInitialReplication [-VMName] [-ComputerName ] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-VMInitialReplication [-VM] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Stop-VMInitialReplication [-VMReplication] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-VMInitialReplication** cmdlet stops an ongoing initial replication that uses either a virtual machine restored from backup or the network. -It does not stop an initial replication that uses external media. -For an initial replication that uses external media, you can use this cmdlet to stop the export, which returns the virtual machine to a pending state. -After an export is finished, the initial replication cannot be stopped. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Stop-VMInitialReplication VM01 -``` - -This example stops initial replication of a virtual machine named VM01. - -### Example 2 -``` -PS C:\>Stop-VMInitialReplication * -``` - -This example stops initial replication of all virtual machines whose initial replication is in progress on the local Replica server. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which an ongoing initial replication is to be stopped. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that an object is to be passed through to the pipeline representing the virtual machine whose initial replication is to be stopped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose initial replication is to be stopped. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose initial replication is to be stopped. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies the virtual machine replication to be stopped. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Stop-VMReplication.md b/docset/winserver2012-ps/hyper-v/Stop-VMReplication.md deleted file mode 100644 index 143aef4c60..0000000000 --- a/docset/winserver2012-ps/hyper-v/Stop-VMReplication.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/stop-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-VMReplication - -## SYNOPSIS -Cancels an ongoing virtual machine resynchronization. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-VMReplication [-VMName] [-ComputerName ] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-VMReplication [-VM] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Stop-VMReplication [-VMReplication] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-VMReplication** cmdlet cancels an ongoing virtual machine resynchronization. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Stop-VMReplication * -``` - -Stops all ongoing replications of virtual machines on the local Hyper-V server. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the ongoing virtual machine resynchronization is to be stopped. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that an object is to be passed through to the pipeline representing the virtual machine on which the ongoing virtual machine resynchronization is to be stopped. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose resynchronization is to be stopped. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose resynchronization is to be stopped. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies the resynchronization to be stopped. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Suspend-VM.md b/docset/winserver2012-ps/hyper-v/Suspend-VM.md deleted file mode 100644 index 1f28088d49..0000000000 --- a/docset/winserver2012-ps/hyper-v/Suspend-VM.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/suspend-vm?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-VM - -## SYNOPSIS -Suspends, or pauses, a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Suspend-VM [-Name] [-AsJob] [-ComputerName ] [-Passthru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Suspend-VM [-VM] [-AsJob] [-Passthru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Suspend-VM** cmdlet suspends a virtual machine. -To return a suspended virtual machine to a running state, use the Resume-VM cmdlet. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Suspend-VM -Name TestVM -``` - -This example suspends a virtual machine named TestVM. - -### Example 2 -``` -PS C:\>Suspend-VM -Name Test* -``` - -This example suspends all virtual machines whose names starts with Test. - -## PARAMETERS - -### -AsJob -Specifies that the cmdlet is to be run as a background job. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts on which a virtual machine is to be suspended. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the virtual machine to be suspended. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -Passthru -Specifies that a **Microsoft.Virtualization.Powershell.VirtualMachine** object is to be passed through to the pipeline representing the virtual machine to be suspended. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine to be suspended. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### Microsoft.Virtualization.Powershell.VirtualMachine -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Suspend-VMReplication.md b/docset/winserver2012-ps/hyper-v/Suspend-VMReplication.md deleted file mode 100644 index b566b4ff07..0000000000 --- a/docset/winserver2012-ps/hyper-v/Suspend-VMReplication.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/suspend-vmreplication?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-VMReplication - -## SYNOPSIS -Suspends replication of a virtual machine. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Suspend-VMReplication [-VMName] [-ComputerName ] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Suspend-VMReplication [-VM] [-PassThru] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Suspend-VMReplication [-VMReplication] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Suspend-VMReplication** cmdlet suspends, or pauses, replication of a virtual machine. -To resume replication, use the Resume-VMReplication cmdlet to resume replication. -When replication is resumed, all changes made since replication was suspended will be replicated. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Suspend-VMReplication VM01 -``` - -Suspends replication of virtual machine VM01. - -### Example 2 -``` -PS C:\>Suspend-VMReplication * -``` - -Suspends replication of all virtual machines on the local Hyper-V host. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which replication of a virtual machine is to be suspended. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Specifies that a **VMReplication** object is to be passed through to the pipeline representing the replication to be suspended. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VM -Specifies the virtual machine whose replication is to be suspended. - -```yaml -Type: VirtualMachine[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -VMName -Specifies the name of the virtual machine whose replication is to be suspended. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: True -``` - -### -VMReplication -Specifies the virtual machine replication to be suspended. - -```yaml -Type: VMReplication[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### None -Default - -### VMReplication -If **-PassThru** is specified. - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Test-VHD.md b/docset/winserver2012-ps/hyper-v/Test-VHD.md deleted file mode 100644 index 5594f86cfb..0000000000 --- a/docset/winserver2012-ps/hyper-v/Test-VHD.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/test-vhd?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-VHD - -## SYNOPSIS -Tests a virtual hard disk for any problems that would make it unusable. - -## SYNTAX - -``` -Test-VHD [-Path] [-ComputerName ] -``` - -## DESCRIPTION -The **Test-VHD** cmdlet tests a virtual hard disk for any problems that would make it unusable. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Test-VHD -Path Diff2.vhdx -``` - -Tests whether the virtual hard disk chain is in a usable state that starts with the virtual hard disk associated with Diff2.vhdx. - -## PARAMETERS - -### -ComputerName -Specifies one or more Hyper-V hosts on which the virtual hard disk is to be tested. -NetBIOS names, IP addresses, and fully-qualified domain names are allowable. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: . -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path to the virtual hard disk file of the virtual hard disk to be tested. -If a filename or relative path is specified, the new virtual hard disk path is calculated relative to the current working directory. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: True -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - - - diff --git a/docset/winserver2012-ps/hyper-v/Test-VMReplicationConnection.md b/docset/winserver2012-ps/hyper-v/Test-VMReplicationConnection.md deleted file mode 100644 index adec3d27de..0000000000 --- a/docset/winserver2012-ps/hyper-v/Test-VMReplicationConnection.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -external help file: Hyper-V_Cmdlets.xml -Module Name: Hyper-V -online version: https://learn.microsoft.com/powershell/module/hyper-v/test-vmreplicationconnection?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-VMReplicationConnection - -## SYNOPSIS -Tests the connection between a primary server and a Replica server. - -## SYNTAX - -``` -Test-VMReplicationConnection [-ReplicaServerName] [-ReplicaServerPort] - [-AuthenticationType] [[-CertificateThumbprint] ] - [-BypassProxyServer ] [-ComputerName ] -``` - -## DESCRIPTION -The Test-VMReplicationConnection cmdlet tests the connection between a primary server and a Replica server to determine whether replication can be enabled for virtual machines on the primary server to the specified Replica server. - -## EXAMPLES - -### Example 1 -``` -PS C:\> Test-VMReplicationConnection server01.domain01.contoso.com 80 Kerberos -``` - -This example tests the connection between the local host and a Replica server named server01.domain01.contoso.com, using port 80 and Kerberos authentication. - -## PARAMETERS - -### -AuthenticationType -Specifies the authentication type to use to test the connection, either "Kerberos" or "Certificate". -The specified Replica server must support the chosen authentication type. -Run the Get-VMReplicationServer cmdlet to verify the authentication configured for the specified Replica server, or contact the administrator of the specified Replica server. - -```yaml -Type: ReplicationAuthenticationType -Parameter Sets: (All) -Aliases: AuthType - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BypassProxyServer -Specifies whether to bypass a proxy server when testing the connectivity. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CertificateThumbprint -Specifies the certificate to use for mutual authentication of the replication data. -This parameter is required only when "Certificate" is the specified as the type of authentication. -Specify the thumbprint of a valid computer certificate from the Personal store. - -The certificate must have all of the following properties to be valid: - -It must not be expired. - -It must include both client and server authentication extensions for extended key usage (EKU), and an associated private key. - -It must terminate at a valid root certificate. - -The requirement for the subject common name (CN) differs depending on whether the virtual machine belongs to a cluster. -For virtual machines that do not belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) should contain, the FQDN of the host. -For virtual machines that belong to a cluster, the subject common name (CN) must be equal to, or subject alternative name (DNS Name) must contain, the FQDN of the Hyper-V Replica Broker. - -To display a list certificates in the computer's My store and the thumbprint of each certificate, type the following: - -`PS C:\\\> cd cert:\LocalMachine\My` - -`PS C:\\\> dir | format-list` - -For more information about certificate stores, see http://technet.microsoft.com//library/cc757138.aspxhttp://technet.microsoft.com//library/cc757138.aspx. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Thumbprint - -Required: False -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ComputerName -Specifies one or more Hyper-V hosts that have the virtual machines for which you want to test the connection for replication. -NetBIOS names, IP addresses, and fully-qualified domain names (FQDN) are allowed. -The default is the local computer - use "localhost" or a dot (".") to specify the local computer explicitly. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaServerName -Specifies the name of the Replica server to test for connectivity with the virtual machine to be replicated. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ReplicaServer - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplicaServerPort -Specifies the port on the Replica server to use to test connectivity. -Make sure you specify a port that is configured on the Replica server to support the same authentication type you specify using the AuthenticationType parameter in this cmdlet. -Run the Get-VMReplicationServer cmdlet on the Replica server to check the configuration of the port, or contact the administrator of the specified Replica server. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ReplicaPort - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### -None. - -## OUTPUTS - -### -None. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Get-WinAcceptLanguageFromLanguageListOptOut.md b/docset/winserver2012-ps/international/Get-WinAcceptLanguageFromLanguageListOptOut.md deleted file mode 100644 index 91b2a8b4f9..0000000000 --- a/docset/winserver2012-ps/international/Get-WinAcceptLanguageFromLanguageListOptOut.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winacceptlanguagefromlanguagelistoptout?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinAcceptLanguageFromLanguageListOptOut - -## SYNOPSIS -Gets the HTTP Accept Language from the Language List opt-out setting for the current user account. - -## SYNTAX - -``` -Get-WinAcceptLanguageFromLanguageListOptOut [] -``` - -## DESCRIPTION -The **Get-WinAcceptLanguageFromLanguageListOptOut** cmdlet gets the **HTTP Accept Language from Language List opt-out** setting for the current user account. -By default, the **HTTP Accept Language List** is automatically generated from the current user account's language list. - -When set to $True, this setting deletes the current content of the HTTP Accept Language registry key and prevents changes to the language list from reestablishing the key. -When set to $False, this setting reestablishes the **HTTP Accept Language List** that is based on the language list for the current user account. - -## EXAMPLES - -### Example 1: Get the HTTP Accept Language from Language List opt-out setting -``` -PS C:\>Get-WinAcceptLanguageFromLanguageListOptOut -TRUE -``` - -This command returns the status of the **HTTP Accept Language from Language List opt-out** setting for the current user account. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Boolean -A Boolean value that reports the status of the **HTTP Accept Language from Language List opt-out** setting for the current user account. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Get-WinCultureFromLanguageListOptOut.md b/docset/winserver2012-ps/international/Get-WinCultureFromLanguageListOptOut.md deleted file mode 100644 index 672aa5c82e..0000000000 --- a/docset/winserver2012-ps/international/Get-WinCultureFromLanguageListOptOut.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winculturefromlanguagelistoptout?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinCultureFromLanguageListOptOut - -## SYNOPSIS -Gets the Culture (User Locale) from the language list opt-out setting for the current user account. - -## SYNTAX - -``` -Get-WinCultureFromLanguageListOptOut [] -``` - -## DESCRIPTION -The **Get-WinCultureFromLanguageListOptOut** cmdlet gets the Culture (User Locale) override setting for the current user account. -When set to $True, the Culture setting is not updated by changes to the Windows display language. -When set the $False, the Culture setting can be reassigned to match the display language changes any time that the display language changes. -The default setting is $False. - -## EXAMPLES - -### Example 1: Get the Culture (User Locale) for the current user -``` -PS C:\>Get-WinCultureFromLanguageListOptOut -``` - -This command gets the Culture (User Locale) for the current user. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### Boolean -A Boolean value that reports the status of this setting. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Get-WinDefaultInputMethodOverride.md b/docset/winserver2012-ps/international/Get-WinDefaultInputMethodOverride.md deleted file mode 100644 index 349c6f8f28..0000000000 --- a/docset/winserver2012-ps/international/Get-WinDefaultInputMethodOverride.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-windefaultinputmethodoverride?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinDefaultInputMethodOverride - -## SYNOPSIS -Gets the default input method override setting for the current user account. - -## SYNTAX - -``` -Get-WinDefaultInputMethodOverride [] -``` - -## DESCRIPTION -The **Get-WinDefaultInputMethodOverride** cmdlet retrieves the default input method override setting, which specifies a default input method for the current user account. -If no override setting is used, the input method is dynamically determined from the current user account's language list (see Get-WinUserLanguageList and Set-WinUserLanguageList). - -## EXAMPLES - -### Example 1: Get the default input method override setting for the current user account -``` -PS C:\>Get-WinDefaultInputMethodOverride -InputMethodTip Keyboard name - ---------------- ------------- - -0409:00000409 English (United States) - US -``` - -This command returns and displays the default input method for the current user account. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### WinKeyboardObject -The Tablet Input Panel (TIP) string for the default input method override setting. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Get-WinHomeLocation.md b/docset/winserver2012-ps/international/Get-WinHomeLocation.md deleted file mode 100644 index 8cf18fbc64..0000000000 --- a/docset/winserver2012-ps/international/Get-WinHomeLocation.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winhomelocation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinHomeLocation - -## SYNOPSIS -Gets the Windows GeoID home location setting for the current user account. - -## SYNTAX - -``` -Get-WinHomeLocation [] -``` - -## DESCRIPTION -The **Get-WinHomeLocation** cmdlet gets the value of the user GeoID setting and returns a .NET GeoID object. -The Windows GeoID setting is a user setting that describes the home location (that is, the country or region) of the current user account. -Applications that require the current user account's home location, such as a driver for a television tuner application, can use this setting. - -A table of GeoIDs is available at Table of Geographical Locationshttp://go.microsoft.com/fwlink/?LinkID=242308 (http://go.microsoft.com/fwlink/?LinkID=242308). - -## EXAMPLES - -### Example 1: Get the GeoID setting -``` -PS C:\>Get-WinHomeLocation -HomeLocation Description - ----- ----------- - -244 United States -``` - -This command returns the GeoID setting and its display name for the current user account. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### GeoID -A 32-bit signed number that uniquely identifies a geographical location. - -## NOTES - -## RELATED LINKS - -[RegionInfo.GeoId Property](https://go.microsoft.com/fwlink/?LinkID=242310) - diff --git a/docset/winserver2012-ps/international/Get-WinLanguageBarOption.md b/docset/winserver2012-ps/international/Get-WinLanguageBarOption.md deleted file mode 100644 index 1e05884b05..0000000000 --- a/docset/winserver2012-ps/international/Get-WinLanguageBarOption.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winlanguagebaroption?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinLanguageBarOption - -## SYNOPSIS -Gets the language bar mode and language bar type for the current user account. - -## SYNTAX - -``` -Get-WinLanguageBarOption [] -``` - -## DESCRIPTION -The **Get-WinLanguageBarOption** cmdlet gets the language bar type and mode by using a LanguageBar object. -The values for the type and mode settings can be either true or false. -The default value for each setting is false. - -## EXAMPLES - -### Example 1: Get the language bar options for the current user -``` -PS C:\>Get-WinLanguageBarOption -IsLegacyLanguageBar IsLegacySwitchingMode - -------------------- --------------------- - -False False -``` - -This command returns the settings for the language bar options for the current user account. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### LanguageBar -A string that reports the language bar mode and type. -Possible values are the following: - -- IsLegacyLanguageBar. When this setting is set to true, the desktop language bar is used (where available). When this setting is set to false, the modem input switcher is used (recommended). -- IsLegacySwitchingMode. When this setting is set to $True, the current input method (keyboard layout or input method editor (IME)) is selected for the current application only. When new applications start, the default input method is selected (see Get-WinDefaultInputMethodOverride). When this setting is set to $False, the input method is selected for all applications and changes only when the user actively switches input methods (recommended). - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Get-WinSystemLocale.md b/docset/winserver2012-ps/international/Get-WinSystemLocale.md deleted file mode 100644 index 892eccdf05..0000000000 --- a/docset/winserver2012-ps/international/Get-WinSystemLocale.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winsystemlocale?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinSystemLocale - -## SYNOPSIS -Gets the system-locale setting (that is, the language for non-Unicode programs) for the current computer. - -## SYNTAX - -``` -Get-WinSystemLocale [] -``` - -## DESCRIPTION -The **Get-WinSystemLocale** cmdlet returns the current value of the system-locale setting. -The system-locale setting determines which code pages (ANSI, DOS, and Macintosh) the system uses by default. - -## EXAMPLES - -### Example 1: Get the system-locale setting for the current computer -``` -PS C:\>Get-WinSystemLocale -LCID Name DisplayName ----- ---- ----------- -1033 en-US English (United States) -``` - -This command gets and displays the system-locale setting for the current computer. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### CultureInfo -An object that identifies the current computer's system locale. -For more information about the CultureInfo object, see CultureInfo Classhttp://go.microsoft.com/fwlink/?LinkID=242306. - -## NOTES - -## RELATED LINKS - -[Manage the input and display language settings in Windows 10](https://support.microsoft.com/help/4496404/windows-10-manage-the-input-and-display-language#input_language) - diff --git a/docset/winserver2012-ps/international/Get-WinUILanguageOverride.md b/docset/winserver2012-ps/international/Get-WinUILanguageOverride.md deleted file mode 100644 index bf0eda8eb3..0000000000 --- a/docset/winserver2012-ps/international/Get-WinUILanguageOverride.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winuilanguageoverride?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinUILanguageOverride - -## SYNOPSIS -Gets the Windows user interface (UI) language override setting for the current user account. - -## SYNTAX - -``` -Get-WinUILanguageOverride [] -``` - -## DESCRIPTION -The **Get-WinUILanguageOverride** cmdlet specifies that a user-preferred display language should be used for the Windows UI. -If no override setting is used, the display language is dynamically determined from the user's language list (see Get-WinUserLanguageList and Set-WinUserLanguageList). - -## EXAMPLES - -### Example 1: Get the Windows UI language override setting for the current user -``` -PS C:\>Get-WinUILanguageOverride -LCID Name DisplayName - ----- ---- ----------- - -1033 en-US English (United States) -``` - -This command gets and displays the UI language override setting for the current user account. -If the Windows UI language override is not set for the current user account, this command returns a null value. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### CultureInfo -An object that contains the Windows UI language override for the current user account. -For more information about the CultureInfo object, see CultureInfo Classhttp://go.microsoft.com/fwlink/?LinkID=242306. - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Get-WinUserLanguageList.md b/docset/winserver2012-ps/international/Get-WinUserLanguageList.md deleted file mode 100644 index 0fb3a69f5b..0000000000 --- a/docset/winserver2012-ps/international/Get-WinUserLanguageList.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/get-winuserlanguagelist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-WinUserLanguageList - -## SYNOPSIS -Gets the language list for the current user account. - -## SYNTAX - -``` -Get-WinUserLanguageList [] -``` - -## DESCRIPTION -The **Get-WinUserLanguageList** cmdlet returns the current user language settings. -These settings include input method, spelling setting, text prediction setting, and handwriting input mode. -For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/?LinkID=242306) and [Manage the input and display language settings in Windows 10](https://support.microsoft.com/help/4496404/windows-10-manage-the-input-and-display-language#input_language). - -## EXAMPLES - -### Example 1: Get the language list for the current user -``` -PS C:\>Get-WinUserLanguageList -LanguageTag : en-US - -Autonym : English (United States) - -EnglishName : English (United States) - -LocalizedName : English (United States) - -ScriptName : Latin - -InputMethodTip : {0409:00000409} - -Handwriting : False - -LanguageTag : fr-FR - -Autonym : fran §ais (France) - -EnglishName : French (France) - -LocalizedName : French (France) - -ScriptName : Latin - -InputMethodTip : {040c:0000040c} - -Handwriting : False -``` - -This command returns the current user account's language list together with BCP-47 tags and the corresponding display name. - -### Example 2: Get the currently enabled input methods -``` -PS C:\>(Get-WinUserLanguageList)[0].InputMethodTip -0409:00000409 - -0409:00010409 -``` - -This command returns the list of currently enabled input methods as a TIP string. - -### Example 3: Get the autonym property for a user -``` -PS C:\>(Get-WinUserLanguageList)[0].autonym -English (United States) -``` - -This command returns the autonym property of the first item in the user's language list. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Collections.Generic.List -This cmdlet returns a list of **WinUserLanguage** objects that contain one or more languages and associated properties from the current user account's language list. -For information about the **Generic.List** object, see [List(Of T) Class](https://go.microsoft.com/fwlink/?LinkID=243342). - -The generic list object supports the following methods: - -- Add("`LanguageTag`") -- Insert(index, "`LanguageTag`") -- Remove(Index) - -The output language object contains the following properties: - -- **LanguageTag** (READ). -A standard BCP-47 language tag that is used to identify languages. -For more information, see the [Internet Engineering Task Force (IETF) BCP 47 RFC](https://go.microsoft.com/fwlink/?LinkID=242207). -- **Autonym** (LP database) (READ). -The name of the language in the language itself. -- **EnglishName** (LP database) (READ). -The name of the language in English. -- **LocalizedName** (LP database) (READ). -The name of the language in the current Windows display language. -- **ScriptName** (LP database) (READ). -The writing system of the language. -- **InputMethodTips** (READ/WRITE). -A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. -The enabled Input methods are listed in the format `Language ID: Keyboard layout ID`. -- **Handwriting** (READ/WRITE). -This value is either 0 (freehand) or 1 (write each character separately). - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/international/International.md b/docset/winserver2012-ps/international/International.md deleted file mode 100644 index a909d04caf..0000000000 --- a/docset/winserver2012-ps/international/International.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 4.0 -Locale: en-US -Module Guid: 561544e6-3a83-4d24-b140-78ad771eaf10 -Module Name: International ---- - -# International Module -## Description -You can use the International Settings cmdlets to control the language that is used for various elements of the user interface (UI). - -This reference provides cmdlet descriptions and syntax for all International Settings-specific cmdlets. It lists the cmdlets in alphabetical order. - -## International Cmdlets -### [Get-WinAcceptLanguageFromLanguageListOptOut](./Get-WinAcceptLanguageFromLanguageListOptOut.md) -Gets the HTTP Accept Language from the Language List opt-out setting for the current user account. - -### [Get-WinCultureFromLanguageListOptOut](./Get-WinCultureFromLanguageListOptOut.md) -Gets the Culture (User Locale) from the language list opt-out setting for the current user account. - -### [Get-WinDefaultInputMethodOverride](./Get-WinDefaultInputMethodOverride.md) -Gets the default input method override setting for the current user account. - -### [Get-WinHomeLocation](./Get-WinHomeLocation.md) -Gets the Windows GeoID home location setting for the current user account. - -### [Get-WinLanguageBarOption](./Get-WinLanguageBarOption.md) -Gets the language bar mode and language bar type for the current user account. - -### [Get-WinSystemLocale](./Get-WinSystemLocale.md) -Gets the system-locale setting (that is, the language for non-Unicode programs) for the current computer. - -### [Get-WinUILanguageOverride](./Get-WinUILanguageOverride.md) -Gets the Windows user interface (UI) language override setting for the current user account. - -### [Get-WinUserLanguageList](./Get-WinUserLanguageList.md) -Gets the language list for the current user account. - -### [New-WinUserLanguageList](./New-WinUserLanguageList.md) -Instantiates a new language list object. - -### [Set-Culture](./Set-Culture.md) -Sets the user culture for the current user account. - -### [Set-WinAcceptLanguageFromLanguageListOptOut](./Set-WinAcceptLanguageFromLanguageListOptOut.md) -Sets the HTTP Accept Language from the Language List opt-out setting for the current user account. - -### [Set-WinCultureFromLanguageListOptOut](./Set-WinCultureFromLanguageListOptOut.md) -Sets the Culture (User Locale) from language list opt-out setting for the current user account. - -### [Set-WinDefaultInputMethodOverride](./Set-WinDefaultInputMethodOverride.md) -Sets the default input method override for the current user account. - -### [Set-WinHomeLocation](./Set-WinHomeLocation.md) -Sets the home location setting for the current user account. - -### [Set-WinLanguageBarOption](./Set-WinLanguageBarOption.md) -Sets the language bar type and mode for the current user account. - -### [Set-WinSystemLocale](./Set-WinSystemLocale.md) -Sets the system locale (the language for non-Unicode programs) for the current computer. - -### [Set-WinUILanguageOverride](./Set-WinUILanguageOverride.md) -Sets the Windows UI language override setting for the current user account. - -### [Set-WinUserLanguageList](./Set-WinUserLanguageList.md) -Sets the language list and associated properties for the current user account. - diff --git a/docset/winserver2012-ps/international/New-WinUserLanguageList.md b/docset/winserver2012-ps/international/New-WinUserLanguageList.md deleted file mode 100644 index 598caf0a2a..0000000000 --- a/docset/winserver2012-ps/international/New-WinUserLanguageList.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/new-winuserlanguagelist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-WinUserLanguageList - -## SYNOPSIS -Instantiates a new language list object. - -## SYNTAX - -``` -New-WinUserLanguageList [-Language] [] -``` - -## DESCRIPTION -The **New-WinUserLanguageList** cmdlet creates a new user language list object. -The object settings include input method, spelling setting, text prediction setting, and handwriting input mode. -For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/?LinkID=242306) and [Manage the input and display language settings in Windows 10](https://support.microsoft.com/help/4496404/windows-10-manage-the-input-and-display-language#input_language). - -## EXAMPLES - -### Example 1: Create a language list -``` -PS C:\> $1 = New-WinUserLanguageList -Language "en-US" -PS C:\> $1.Add("fr-FR") -PS C:\> Set-WinUserLanguageList $1 -``` - -This command creates and sets a new user language list that contains English (United States) and French (France). - -## PARAMETERS - -### -Language -Specifies a language. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -### System.Collections.Generic.List -A list of **WinUserLanguage** objects that contain one or more languages and associated properties from the current user account's language list. -For more information about the *Generic.List* object, see System.Collections.Generic.List Classhttp://go.microsoft.com/fwlink/?LinkID=243342. - -The generic list object supports the following methods: - -- Add("BCP-47") -- Insert(index, "BCP-47") -- Remove(Index) - -The *LanguageList* is a list of language objects in the current user account's list. -The language list object contains the following methods: - -- Add("BCP-47") -- Insert(BCP-47, index) -- Remove(BCP-47) -- Remove(Index) - -The language list object contains the following properties: - -- BCP-47 (READ). A standard language tag that is used to identify languages. For more information, see the Internet Engineering Task Force (IETF) BCP 47 RFChttp://go.microsoft.com/fwlink/?LinkID=242207. -- Autonym (LP database) (READ). The name of the language in the language itself. -- English name (LP database) (READ). The name of the language in English. -- Localized name (LP database) (READ). The name of the language in the current Windows display language. -- Script (LP database) (READ). The writing system of the language. -- Input methods (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format Language ID: Keyboard layout ID. -- Handwriting recognition input mode (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/international/Set-Culture.md b/docset/winserver2012-ps/international/Set-Culture.md deleted file mode 100644 index 7229f6c991..0000000000 --- a/docset/winserver2012-ps/international/Set-Culture.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-culture?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-Culture - -## SYNOPSIS -Sets the user culture for the current user account. - -## SYNTAX - -``` -Set-Culture [-CultureInfo] [] -``` - -## DESCRIPTION -The **Set-Culture** cmdlet sets a specific culture (also known as a locale for unmanaged code development) for the current user account. -The information includes the names for the culture, the writing system, the calendar, and formatting for dates and sort strings. -For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/?LinkID=242306) and [Manage the input and display language settings in Windows 10](https://support.microsoft.com/help/4496404/windows-10-manage-the-input-and-display-language#input_language). - -## EXAMPLES - -### Example 1: Set the culture for the current user -```powershell -PS C:\>Set-Culture -CultureInfo de-DE -``` - -This command sets the culture for the current user account to German (Germany). - -## PARAMETERS - -### -CultureInfo -Specifies the culture. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES -Changes made by the use of this cmdlet will take effect on subsequent PowerShell sessions. -## RELATED LINKS - -[GetCulture Class](https://go.microsoft.com/fwlink/?LinkID=243343) diff --git a/docset/winserver2012-ps/international/Set-WinAcceptLanguageFromLanguageListOptOut.md b/docset/winserver2012-ps/international/Set-WinAcceptLanguageFromLanguageListOptOut.md deleted file mode 100644 index cea4f92bd0..0000000000 --- a/docset/winserver2012-ps/international/Set-WinAcceptLanguageFromLanguageListOptOut.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winacceptlanguagefromlanguagelistoptout?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinAcceptLanguageFromLanguageListOptOut - -## SYNOPSIS -Sets the HTTP Accept Language from the Language List opt-out setting for the current user account. - -## SYNTAX - -``` -Set-WinAcceptLanguageFromLanguageListOptOut [-OptOut] [] -``` - -## DESCRIPTION -The **Set-WinAcceptLanguageFromLanguageListOptOut** cmdlet sets the HTTP Accept Language from the Language List opt-out setting for the current user account. -By default, the HTTP Accept Language List is automatically generated from the current user account's language list. -You can use the **Set-WinAcceptLanguageFromLanguageListOptOut** cmdlet to set the **HTTP Accept Language from Language List opt-out** value. -When set to $True, this setting deletes the current content of the HTTP Accept Language registry key and prevents changes to the language list from reestablishing the key. -When set to $False, this setting reestablishes the HTTP Accept Language List based on the language list for the current user account. - -## EXAMPLES - -### Example 1: Set the HTTP Accept Language registry key -``` -PS C:\> Set-WinAcceptLanguageFromLanguageListOptOut -OptOut 1 -``` - -This cmdlet deletes the current content of the HTTP Accept Language registry key and blocks updates to the key based on changes to the user's language list. - -## PARAMETERS - -### -OptOut -Indicates whether to opt out from the Language List. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Set-WinCultureFromLanguageListOptOut.md b/docset/winserver2012-ps/international/Set-WinCultureFromLanguageListOptOut.md deleted file mode 100644 index b7919bb11d..0000000000 --- a/docset/winserver2012-ps/international/Set-WinCultureFromLanguageListOptOut.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winculturefromlanguagelistoptout?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinCultureFromLanguageListOptOut - -## SYNOPSIS -Sets the Culture (User Locale) from language list opt-out setting for the current user account. - -## SYNTAX - -``` -Set-WinCultureFromLanguageListOptOut [-OptOut] [] -``` - -## DESCRIPTION -The **Set-WinCultureFromLanguageListOptOut** cmdlet sets the Culture (User Locale) opt-out setting for the current user account. -Setting this option to $True disables the action of dynamically setting the Culture (User Locale) for the current user based on changes to the Windows display language. -Setting this option to $False activates the dynamic setting behavior. -The default setting is $False. - -## EXAMPLES - -### Example 1: Opt out of the culture from language list behavior -``` -PS C:\>Set-WinCultureFromLanguageListOptOut -OptOut $True -``` - -This cmdlet blocks the dynamic setting behavior. - -## PARAMETERS - -### -OptOut -Indicates whether to opt out of the culture from language list behavior. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Set-WinDefaultInputMethodOverride.md b/docset/winserver2012-ps/international/Set-WinDefaultInputMethodOverride.md deleted file mode 100644 index 11f14c2db3..0000000000 --- a/docset/winserver2012-ps/international/Set-WinDefaultInputMethodOverride.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-windefaultinputmethodoverride?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinDefaultInputMethodOverride - -## SYNOPSIS -Sets the default input method override for the current user account. - -## SYNTAX - -``` -Set-WinDefaultInputMethodOverride [[-InputTip] ] [] -``` - -## DESCRIPTION -The **Set-WinDefaultInputMethodOverride** cmdlet gets the default input method override setting, which specifies a default input method for the current user account. -If no override setting is used, the input method is dynamically determined from the current user account's language list (see Get-WinUserLanguageList and Set-WinUserLanguageList). - -## EXAMPLES - -### Example 1: Set the default input method override -``` -PS C:\>Set-WinDefaultInputMethodOverride -InputTip "0409:00000409" -``` - -This command sets the default input method override to English (United States) - US. - -## PARAMETERS - -### -InputTip -Specifies a locale ID and a keyboard language ID (KLID). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### InputTip -A string that consists of a locale ID and a keyboard language ID (KLID). - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Set-WinHomeLocation.md b/docset/winserver2012-ps/international/Set-WinHomeLocation.md deleted file mode 100644 index db26e61d58..0000000000 --- a/docset/winserver2012-ps/international/Set-WinHomeLocation.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winhomelocation?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinHomeLocation - -## SYNOPSIS -Sets the home location setting for the current user account. - -## SYNTAX - -``` -Set-WinHomeLocation [-GeoId] [] -``` - -## DESCRIPTION -The **Set-WinHomeLocation** cmdlet sets the value of the user GeoID object. -The Windows GeoID setting is a user setting that describes the home location (that is, the country or region) of the current user account. -Applications that require the current user account's home location, such as a driver for a television tuner application, can use this setting. - -A table of GeoIDs is available at Table of Geographical Locationshttp://go.microsoft.com/fwlink/?LinkID=242308. - -## EXAMPLES - -### Example 1: Set the home location for the current user -``` -PS C:\>Set-WinHomeLocation -GeoID 0xF4 -``` - -This command sets the home location for the current user account to 0xF4 (hex) (United States). - -## PARAMETERS - -### -GeoId -Specifies a 32-bit signed number that uniquely identifies a geographical location. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[RegionInfo.GeoId Property](https://go.microsoft.com/fwlink/?LinkID=242310) - diff --git a/docset/winserver2012-ps/international/Set-WinLanguageBarOption.md b/docset/winserver2012-ps/international/Set-WinLanguageBarOption.md deleted file mode 100644 index 82a924c604..0000000000 --- a/docset/winserver2012-ps/international/Set-WinLanguageBarOption.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winlanguagebaroption?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinLanguageBarOption - -## SYNOPSIS -Sets the language bar type and mode for the current user account. - -## SYNTAX - -``` -Set-WinLanguageBarOption [-UseLegacySwitchMode] [-UseLegacyLanguageBar] [] -``` - -## DESCRIPTION -The **Set-WinLanguageBarOption** cmdlet sets the language bar type and mode by using a LanguageBar object. -The values for the type and mode settings can be either $True or $False. -The default value for each setting is $False. - -## EXAMPLES - -### Example 1: Set the language bar mode and language bar type -``` -PS C:\>Set-WinLanguageBarOptions -UseLegacySwitchMode -UseLegacyLanguageBar -``` - -This command sets the language bar mode to the legacy setting and the language bar type to the per-thread setting. - -### Example 2: Set the language bar mode and language bar type to default values -``` -PS C:\>Set-WinLanguageBarOptions -``` - -This command sets the language bar mode and the language bar type to the default setting. - -## PARAMETERS - -### -UseLegacyLanguageBar -Indicates that this operation sets the language bar mode to the legacy setting. -If you do not specify this parameter, the language bar mode is set to its default. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseLegacySwitchMode -Indicates that this operation sets the language bar switch mode to the legacy or per-thread setting. -If you do not specify this parameter, the language bar switch mode is set to the default or per-user setting. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Set-WinSystemLocale.md b/docset/winserver2012-ps/international/Set-WinSystemLocale.md deleted file mode 100644 index 185f6c5e3e..0000000000 --- a/docset/winserver2012-ps/international/Set-WinSystemLocale.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winsystemlocale?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinSystemLocale - -## SYNOPSIS - -Sets the system locale (the language for non-Unicode programs) for the current computer. - -## SYNTAX - -```powershell -Set-WinSystemLocale [-SystemLocale] [] -``` - -## DESCRIPTION - -The **Set-WinSystemLocale** cmdlet sets the code pages (ANSI, DOS, and Macintosh) that the system uses by default. -If you change the system-locale setting, the necessary bitmap font files are installed to support legacy applications in the selected language. - -Note that because this is a system setting, this can only be changed by a user with Administrator permissions, and changes do not take effect until the computer is restarted. - -## EXAMPLES - -### Example 1: Set the system locale - -```powershell -PS C:\> Set-WinSystemLocale -SystemLocale ja-JP -``` - -This command sets the system locale to Japanese (Japan). - -## PARAMETERS - -### -SystemLocale - -Specifies the system locale. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### CultureInfo - -An object that contains a BCP-47 tag to specify the system locale for the current computer. -For more information about the CultureInfo object, see [CultureInfo Class](https://go.microsoft.com/fwlink/?LinkID=242306). - -## OUTPUTS - -## NOTES -Please note that the System Locale setting on the computer is primarily used for legacy code page selection and font fallback. This setting is primarily used by applications that do not support Unicode. It should not be viewed from the sense of a traditional locale or culture info, and should not be confused with the user locale (Regional Format) setting. - -When changing the System Locale setting it is highly recommended to also change the Windows Display Language or UI language setting for the computer so that it matches the System Locale. In some cases, the UI language may depend on the code page and/or the font to render properly. Failure to do so can result in configurations where non-Unicode applications don't work as intended. - -## RELATED LINKS - -[Manage the input and display language settings in Windows 10](https://support.microsoft.com/help/4496404/windows-10-manage-the-input-and-display-language#input_language) - diff --git a/docset/winserver2012-ps/international/Set-WinUILanguageOverride.md b/docset/winserver2012-ps/international/Set-WinUILanguageOverride.md deleted file mode 100644 index bd8e873ffc..0000000000 --- a/docset/winserver2012-ps/international/Set-WinUILanguageOverride.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winuilanguageoverride?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinUILanguageOverride - -## SYNOPSIS -Sets the Windows UI language override setting for the current user account. - -## SYNTAX - -``` -Set-WinUILanguageOverride [[-Language] ] [] -``` - -## DESCRIPTION -The **Set-WINUILanguageOverride** cmdlet sets a user-preferred display language to use for the Windows user interface (UI). -If no override setting is specified, the display language is dynamically determined from the user's language list (see Get-WinUserLanguageList and Set-WinUserLanguageList). - -## EXAMPLES - -### Example 1: Set the Windows UI language override -``` -PS C:\>Set-WinUILanguageOverride -Language de-DE -``` - -This command sets the Windows UI language override to German (Germany) for the current user account. - -### Example 2: Set the Windows UI language override to $Null -``` -PS C:\>Set-WinUILanguageOverride -``` - -This command sets the Windows UI language override to $Null for the current user account. - -## PARAMETERS - -### -Language -Specifies a **CultureInfo** object. - -```yaml -Type: CultureInfo -Parameter Sets: (All) -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### CultureInfo -An object that contains the Windows UI language override for the current user account. -For more information about the CultureInfo object, see CultureInfo Classhttp://go.microsoft.com/fwlink/?LinkID=242306. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/international/Set-WinUserLanguageList.md b/docset/winserver2012-ps/international/Set-WinUserLanguageList.md deleted file mode 100644 index 7fc62816c3..0000000000 --- a/docset/winserver2012-ps/international/Set-WinUserLanguageList.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.InternationalSettings.Commands.dll-Help.xml -Module Name: International -online version: https://learn.microsoft.com/powershell/module/international/set-winuserlanguagelist?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-WinUserLanguageList - -## SYNOPSIS -Sets the language list and associated properties for the current user account. - -## SYNTAX - -``` -Set-WinUserLanguageList - [-LanguageList] - [-Force] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Set-WinUserLanguageList** cmdlet sets the current user language settings. -These settings include input method, spelling setting, text prediction setting, and handwriting input mode. -For more information, see [CultureInfo Class](https://go.microsoft.com/fwlink/?LinkID=242306) and [Manage the input and display language settings in Windows 10](https://support.microsoft.com/help/4496404/windows-10-manage-the-input-and-display-language#input_language). - -## EXAMPLES - -### Example 1: Add a language to a user's language list -``` -PS C:\> $OldList = Get-WinUserLanguageList -PS C:\> $OldList.Add("fr-FR") -PS C:\> Set-WinUserLanguageList $OldList -``` - -This command adds the language French (France) to the user's language list. - -### Example 2: Change a setting for a language -``` -PS C:\>$1 = New-WinUserLanguageList -Language "en-US" -PS C:\>$1[0].Handwriting = 1 -PS C:\> Set-WinUserLanguageList -LanguageList $1 -``` - -This command changes the handwriting setting for the language English (United States) in the user's language list to ON (write each character separately). - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LanguageList -Specifies a list of **WinUserLanguage** objects. - -```yaml -Type: System.Collections.Generic.List`1[Microsoft.InternationalSettings.Commands.WinUserLanguage] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### System.Collections.Generic.List -A list of **WinUserLanguage** objects that contain one or more languages and associated properties from the current user account's language list. -The language object contains the following properties: - -- BCP-47 (READ). A standard language tag that is used to identify languages. For more information, see the [Internet Engineering Task Force (IETF) BCP 47 RFC](https://go.microsoft.com/fwlink/?LinkID=242207). -- Autonym (LP database) (READ). The name of the language in the language itself. -- English name (LP database) (READ). The name of the language in English. -- Localized name (LP database) (READ). The name of the language in the current Windows display language. -- Script (LP database) (READ). The writing system of the language. -- Input methods (READ/WRITE). A list of input method Tablet Input Panel (TIP) strings that are enabled for this language. The enabled input methods are listed in the format `Language ID:Keyboard layout ID`. See [Default input profiles (input locales) in Windows](/windows-hardware/manufacture/desktop/default-input-locales-for-windows-language-packs). -- Handwriting recognition input mode (READ/WRITE). This value is either 0 (freehand) or 1 (write each character separately). - -## OUTPUTS - -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2012-ps/ipamserver/Add-IpamCustomField.md b/docset/winserver2012-ps/ipamserver/Add-IpamCustomField.md deleted file mode 100644 index 473d6abcff..0000000000 --- a/docset/winserver2012-ps/ipamserver/Add-IpamCustomField.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/add-ipamcustomfield?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-IpamCustomField - -## SYNOPSIS -Adds a new free form or multi-valued custom field to the computer running the IP Address Management (IPAM) server. - -## SYNTAX - -``` -Add-IpamCustomField [-Name] [-Multivalue] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-IpamCustomField** cmdlet adds a new custom field name to the computer running the IP Address Management (IPAM) server. -The user can indicate if the newly added custom field is free form or multi-valued. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-IpamCustomField -Name MyField -PassThru -Name Category Multivalue CustomValue ---------------------------------------------------------------------------------- -MyField UserDefined False -``` - -This example adds an IPAM custom field named MyField and returns the object associated with it. - -### EXAMPLE 2 -``` -PS C:\>Add-IpamCustomField -Name MyMultiValueField -Multivalue -PassThru -Name Category Multivalue CustomValue ---------------------------------------------------------------------------------- -MyMultiValueField UserDefined True -``` - -This example adds a multi-valued, IPAM custom field named MyMultiValueField and returns the object associated with it. - -## PARAMETERS - -### -Multivalue -Adds the specified custom field as a multi-valued field. -If this parameter is not specified, then the custom field is added as a free-form field. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new custom field being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamCustomField -This object contains an IPAM custom field. - -## NOTES - -## RELATED LINKS - -[Add-IpamCustomValue](./Add-IpamCustomValue.md) - -[Get-IpamCustomField](./Get-IpamCustomField.md) - diff --git a/docset/winserver2012-ps/ipamserver/Add-IpamCustomValue.md b/docset/winserver2012-ps/ipamserver/Add-IpamCustomValue.md deleted file mode 100644 index a97118a12e..0000000000 --- a/docset/winserver2012-ps/ipamserver/Add-IpamCustomValue.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/add-ipamcustomvalue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-IpamCustomValue - -## SYNOPSIS -Adds a new custom value to a multi-valued, custom field in IP Address Management (IPAM). - -## SYNTAX - -``` -Add-IpamCustomValue [-Name] [-Value] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Add-IpamCustomValue** cmdlet adds a new custom value to the specified multi-valued custom field name in IP Address Management (IPAM). -The multi-valued custom field can either be built-in or user-defined. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Add-IpamCustomValue -Name MyField -Value MyValue -``` - -This example adds an IPAM custom value named MyValue to the user defined custom field MyField. - -### EXAMPLE 2 -``` -PS C:\>Add-IpamCustomValue -Name MyField -Value MyValue -PassThru -Value Category CustomField ------------------------------------------------------------- -MyValue UserDefined MyField -``` - -This example adds an IPAM custom value named MyValue to the user defined custom field MyField, and returns the object associated with the custom value. - -### EXAMPLE 3 -``` -PS C:\>Add-IpamCustomValue -Name ServiceInstance -Value MyValue -PassThru -Value Category CustomField ------------------------------------------------------------- -MyValue UserDefined ServiceInstance -``` - -This example adds an IPAM custom value named MyValue to the in-built custom field ServiceInstance, and returns the object associated with the custom value. - -## PARAMETERS - -### -Name -Specifies the name of the custom field against which the new value needs is being added. -The cmdlet accepts both the localized server name as well as the English name of the built-in, multi-valued, custom fields. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies the name of the new custom field value being added. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamCustomValue -This object contains an IPAM custom value. - -## NOTES - -## RELATED LINKS - -[Add-IpamCustomField](./Add-IpamCustomField.md) - -[Get-IpamCustomField](./Get-IpamCustomField.md) - diff --git a/docset/winserver2012-ps/ipamserver/Export-IpamAddress.md b/docset/winserver2012-ps/ipamserver/Export-IpamAddress.md deleted file mode 100644 index d1648969c3..0000000000 --- a/docset/winserver2012-ps/ipamserver/Export-IpamAddress.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/export-ipamaddress?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-IpamAddress - -## SYNOPSIS -Exports all of the IP addresses of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated value (.csv) file or as an array of Windows PowerShell® objects or both. - -## SYNTAX - -``` -Export-IpamAddress [-AddressFamily] [-Force] [-PassThru] [-Path ] -``` - -## DESCRIPTION -The **Export-IpamAddress** cmdlet exports all of the IP addresses of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated value (.csv) file or as an array of Windows PowerShell® objects or both. - -Either the **Path** or **PassThru** parameter must be specified with the cmdlet. -The object array returned using **PassThru** parameter can be pipelined for further filtering, if required. -The **Force** parameter can be used with the cmdlet, to overwrite an existing .csv file with the same name as specified in the **Path** parameter, during export. - -Unlike the localized object export from computer running the IPAM client user interface (UI), the field header names and the enum value names of IP address objects exported by Windows PowerShell have English names and are not be localized in the language used by the server. -The field header names follow the Windows PowerShell property naming conventions. - -Note: The format of date and time values of the exported objects are in the localized format of the computer running the IPAm server and not in UTC. - -The IPAM client UI and IPAM Windows PowerShell support interoperability between import and export functionality of English and localized .csv files, provided that the language and locale of the computers running the IPAM server and associated UI that are importing and exporting are the same. -In other words a localized .csv file exported from the computer running the IPAM client UI can be imported using IPAM Windows PowerShell and an English .csv file exported from IPAM Windows PowerShell can be imported from computer running the IPAM client UI provided the language and locale of the computers running the IPAM client and IPAM server are the same. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Export-IpamAddress -AddressFamily IPv4 -Path "C:\addresses_v4.csv" -``` - -This example outputs all of the **IPv4** addresses in the file C:\addresses_v4.csv. - -### EXAMPLE 2 -``` -PS C:\> Export-IpamAddress -AddressFamily IPv6 -Path "C:\addresses_v6.csv" -Force -``` - -This example outputs all of the IPv6 addresses in the file C:\addresses_v6.csv, and overwrites the file if it already exists. - -### EXAMPLE 3 -``` -PS C:\> Export-IpamAddress -AddressFamily IPv4 -PassThru -IPAddress IPAddressState AssignmentType ManagedByService ServiceInstance ---------- -------------- -------------- ---------------- --------------- -2.2.2.15 In-Use Static IPAM Localhost -10.10.0.10 In-Use Static IPAM Localhost -12.13.14.15 Reserved Dynamic MS DHCP s2-infra.contoso.com -5.5.0.1 Reserved Dynamic MS DHCP s2-infra.contoso.com -``` - -This example outputs all of the IPv4 address objects. - -### EXAMPLE 4 -``` -PS C:\> Export-IpamAddress -AddressFamily IPv4 -PassThru | Where-Object -FilterScript { $_.ExpiryStatus -Eq "Expired" } -IPAddress IPAddressState AssignmentType ManagedByService ServiceInstance ---------- -------------- -------------- ---------------- --------------- -2.2.2.15 In-Use Static IPAM Localhost -``` - -This example filters all of the expired IPv4 address objects. - -### EXAMPLE 5 -``` -PS C:\> Export-IpamAddress -AddressFamily IPv4 -PassThru | Where-Object -FilterScript { $_.ExpiryStatus -Eq "Expired" } | Export-Csv -Path "C:\expired.csv" -``` - -This example filters all of the expired IPv4 address objects and exports those objects into the file C:\expired.csv. - -### EXAMPLE 6 -``` -PS C:\> Export-IpamAddress -AddressFamily IPv4 -Path C:\addresses.csv -PassThru -IPAddress IPAddressState AssignmentType ManagedByService ServiceInstance ---------- -------------- -------------- ---------------- --------------- -2.2.2.15 In-Use Static IPAM Localhost -10.10.0.10 In-Use Static IPAM Localhost -12.13.14.15 Reserved Dynamic MS DHCP s2-infra.contoso.com -5.5.0.1 Reserved Dynamic MS DHCP s2-infra.contoso.com -``` - -This example outputs all of the IPv4 addresses in the file C:\addresses.csv and also displays the exported addresses. - -## PARAMETERS - -### -AddressFamily -Specifies the address family of the IP address objects being exported. -The acceptable values for this parameter are: IPv4 or IPv6. - - -This parameter specifies if IPv4 or IPv6 records need to be exported. -Only one address family at a time can be specified with this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Specifies that the new .csv file generated by export must overwrite the existing .csv file (if present), as specified in the **Path** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the literal path and name of the .csv file which are created during export. - - -This parameter is used to export all IP address objects in a .csv file format. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamIPAddressPSObject[] -This array of objects contains IPAM IP addresses. - -## NOTES - -## RELATED LINKS - -[Export-Csv](https://go.microsoft.com/fwlink/p/?LinkId=113299) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkId=113423) - -[Import-IpamAddress](./Import-IpamAddress.md) - diff --git a/docset/winserver2012-ps/ipamserver/Export-IpamRange.md b/docset/winserver2012-ps/ipamserver/Export-IpamRange.md deleted file mode 100644 index e5c45969f5..0000000000 --- a/docset/winserver2012-ps/ipamserver/Export-IpamRange.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/export-ipamrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-IpamRange - -## SYNOPSIS -Exports all of the IP address ranges of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated values (.csv) file or as an array of Windows PowerShell® objects or both. - -## SYNTAX - -``` -Export-IpamRange [-AddressFamily] [-Force] [-PassThru] [-Path ] -``` - -## DESCRIPTION -The **Export-IpamRange** cmdlet exports all of the IP address ranges of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated values (.csv) file or as an array of Windows PowerShell® objects or both. - -At least one of the **Path** or **PassThru** parameters must be specified with the cmdlet. -The object array returned using the **PassThru** parameter can be pipelined for further filtering, if required. - -Unlike localized object export from IPAM client user interface (UI), the field header names and the enumeration value names of IP address range objects exported by Windows PowerShell have English names and are not be localized in the language used by the computer running the IPAM server. -The field header names must follow the Windows PowerShell property naming conventions. - -Note: The format of date and time values of the exported objects are in localized format of the computer running the IPAM server and not in UTC. - -The IPAM client UI and IPAM Windows PowerShell support interoperability between import and export functionality of English and localized .csv files, provided that the language and locale of importing and exporting computers running the IPAM servers and associated UI is the same. -In other words a localized .csv file exported from IPAM client UI can be imported using IPAM Windows PowerShell and an English .csv file exported from IPAM Windows PowerShell can be imported from IPAM client UI provided the language and locale of the computers running the IPAM client and IPAM server are the same. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Export-IpamRange -AddressFamily IPv4 -Path "C:\ranges_v4.csv" -``` - -This example outputs all of the IPv4 address ranges in the file C:\ranges_v4.csv. - -### EXAMPLE 2 -``` -PS C:\> Export-IpamRange -AddressFamily IPv6 -Path "C:\ranges_v6.csv" -Force -``` - -This example outputs all of the IPv6 address ranges in the file C:\ranges_v6.csv, and overwrites the file if it already exists. - -### EXAMPLE 3 -``` -PS C:\> Export-IpamRange -AddressFamily IPv4 -PassThru -NetworkId StartIPAddress EndIPAddress PercentageUtilized ManagedByService ServiceInstance ---------- -------------- ------------ ------------------ ---------------- --------------- -2.2.2.0/24 2.2.2.1 2.2.2.254 20.00 IPAM Localhost -10.10.0.0/24 10.10.0.1 10.10.0.254 0.00 IPAM Localhost -12.13.14.0/24 12.13.14.1 12.13.14.254 85.00 MS DHCP s2-infra.contoso.com -5.5.0.0/16 5.5.0.1 5.5.255.254 48.75 MS DHCP s2-infra.contoso.com -``` - -This example outputs all of the IPv4 address range objects. - -### EXAMPLE 4 -``` -PS C:\> Export-IpamRange -AddressFamily IPv4 -PassThru | Where-Object -FilterScript { $_.Utilization -Eq "Over" } -NetworkId StartIPAddress EndIPAddress PercentageUtilized ManagedByService ServiceInstance ---------- -------------- ------------ ------------------ ---------------- --------------- -12.13.14.0/24 12.13.14.1 12.13.14.254 85.00 MS DHCP s2-infra.contoso.com -``` - -This example filters all of the over-utilized IPv4 address range objects. - -### EXAMPLE 5 -``` -PS C:\> Export-IpamRange -AddressFamily IPv4 -PassThru | Where-Object -FilterScript { $_.Utilization -Eq "Over" } | Export-Csv -Path "C:\overutilized.csv" -``` - -This example filters all of the over utilized IPv4 address range objects and exports the objects in a file C:\overutilized.csv. - -### EXAMPLE 6 -``` -PS C:\> Export-IpamRange -AddressFamily IPv4 -Path C:\ranges.csv -PassThru -NetworkId StartIPAddress EndIPAddress PercentageUtilized ManagedByService ServiceInstance ---------- -------------- ------------ ------------------ ---------------- --------------- -2.2.2.0/24 2.2.2.1 2.2.2.254 20.00 IPAM Localhost -10.10.0.0/24 10.10.0.1 10.10.0.254 0.00 IPAM Localhost -12.13.14.0/24 12.13.14.1 12.13.14.254 85.00 MS DHCP s2-infra.contoso.com -5.5.0.0/16 5.5.0.1 5.5.255.254 48.75 MS DHCP s2-infra.contoso.com -``` - -This example outputs all of the IPv4 address ranges in the file **C:\ranges.csv** and also displays the exported ranges. - -## PARAMETERS - -### -AddressFamily -Specifies the address family of IP address range objects being exported. -The acceptable values for this parameter are: IPv4 or IPv6. - - -This parameter specifies whether the IPv4 or IPv6 records need to be exported. -Only one address family at a time can be specified with this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Specifies that new .csv file generated by export must overwrite the existing .csv file (if present), as specified in the **Path** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the literal path and name of the .csv file which are created during export. - - -This parameter is used to export all of the IP address range objects in a .csv file format. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamIPRangePSObject[] -This array of objects contains an IPAM IP address range. - -## NOTES - -## RELATED LINKS - -[Export-Csv](https://go.microsoft.com/fwlink/p/?LinkId=113299) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkId=113423) - -[Import-IpamRange](./Import-IpamRange.md) - diff --git a/docset/winserver2012-ps/ipamserver/Get-IpamConfiguration.md b/docset/winserver2012-ps/ipamserver/Get-IpamConfiguration.md deleted file mode 100644 index 4c54bcbcfa..0000000000 --- a/docset/winserver2012-ps/ipamserver/Get-IpamConfiguration.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/get-ipamconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IpamConfiguration - -## SYNOPSIS -Gets the configuration for the computer running the IP Address Management (IPAM) server. - -## SYNTAX - -``` -Get-IpamConfiguration -``` - -## DESCRIPTION -The **Get-IpamConfiguration** cmdlet gets the configuration for the computer running the IP Address Management (IPAM) server, including the software version number and the TCP port number over which the computer running the IPAM Remote Server Administration Tools (RSAT) client connects and communicates with the computer running the IPAM server. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-IpamServerConfiguration -Version : 1.3 -Port : 48885 -``` - -This example gets the configuration for the computer running the IPAM server, including the software version number and the TCP port number over which the computer running the IPAM RSAT client connects and communicates with the computer running the IPAM server. - -## PARAMETERS - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamConfiguration -This object contains an IPAM configuration. - -## NOTES - -## RELATED LINKS - -[Set-IpamConfiguration](./Set-IpamConfiguration.md) - diff --git a/docset/winserver2012-ps/ipamserver/Get-IpamCustomField.md b/docset/winserver2012-ps/ipamserver/Get-IpamCustomField.md deleted file mode 100644 index ced8f669e7..0000000000 --- a/docset/winserver2012-ps/ipamserver/Get-IpamCustomField.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/get-ipamcustomfield?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IpamCustomField - -## SYNOPSIS -Gets the IP Address Management (IPAM) custom field information. - -## SYNTAX - -``` -Get-IpamCustomField [[-Name] ] -``` - -## DESCRIPTION -The **Get-IpamCustomField** cmdlet gets the IP Address Management (IPAM) custom field information. -The custom field and associated custom values can be fetched from IPAM using this cmdlet. -If the custom field name is not specified, then this cmdlet returns all of the IPAM custom fields and associated values. -For multi-valued fields the custom field objects returned by this cmdlet contains the collection of corresponding custom value objects. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-IpamCustomField -Name Category Multivalue CustomValue ----------------------------------------------------------------------------------------------------------------------------- -AdSite BuiltIn False -CountryOrRegion BuiltIn True {Afghanistan, Alfand Islands,...} -..... -..... -``` - -This example gets the custom field information for all the built-in and user defined fields of IPAM. -For multi-valued fields, the corresponding custom value information is also returned - -### EXAMPLE 2 -``` -PS C:\>Get-IpamCustomField -Name ManagedByService -Name Category Multivalue CustomValue ----------------------------------------------------------------------------------------------------------------------------- -ManagedByService BuiltIn True {IPAM,MS DHCP,Non-MS DHCP...} -``` - -This example gets the custom field information and the corresponding custom value information for the specified field named ManagedByService. - -## PARAMETERS - -### -Name -Specifies the name of the custom field that is retrieved. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamCustomField -This object contains an IPAM custom field. - -## NOTES - -## RELATED LINKS - -[Add-IpamCustomField](./Add-IpamCustomField.md) - -[Add-IpamCustomValue](./Add-IpamCustomValue.md) - diff --git a/docset/winserver2012-ps/ipamserver/Import-IpamAddress.md b/docset/winserver2012-ps/ipamserver/Import-IpamAddress.md deleted file mode 100644 index 357cec3649..0000000000 --- a/docset/winserver2012-ps/ipamserver/Import-IpamAddress.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/import-ipamaddress?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-IpamAddress - -## SYNOPSIS -Imports one or more IP address objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Import-IpamAddress [-Path] [-AddressFamily] [-ErrorPath ] [-Force] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Import-IpamAddress [-Path] [-AddressFamily] [-ManagedByService] - [-ServiceInstance] [-NetworkId] [-EndIPAddress ] [-ErrorPath ] [-Force] - [-StartIPAddress ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Import-IpamAddress** cmdlet imports one or more IP address objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server. -Any objects that fail being imported during the operation are logged in the appropriate error log file for further analysis. - -The cmdlet supports two parameter sets. -The default invocation of the cmdlet adds new IP address objects from the .csv file into the computer running the IPAM server and edits the existing address objects with updated information specified in the .csv file. - -The second parameter set can be used to periodically import and update all of the IP address objects that belong ,or map, to the IP address range identified by the unique combination of the **NetworkId**, **ManagedByService**, **ServiceInstance**, **StartIPAddress**, and **EndIPAddress** parameters, in the computer running the IPAM server. -Along with adding new addresses and editing existing addresses, this operation also deletes those addresses from the computer running the IPAM server which map to the specified IP address range, but are not present in the .csv file being imported. -If not specified, then the computer running the IPAM server auto calculates the **StartIPAddress** and **EndIPAddress** parameter values, at the default address boundaries of the range as specified by the **NetworkId** parameter. -If explicitly specified, then both the **StartIpAddress** and **EndIpAddress** parameter values must be provided together. -The import and update operation of IP addresses for the IP address range succeeds only if the range is already present in the computer running the IPAM server at the time of import. - -The only mandatory field required to be present in the .csv file being imported for IPAM addresses is the IP address itself. -Any other address specific basic field or custom field can be specified in any order in the .csv file for import. -Sample format of the import .csv file, can be generated using IPAM export functionality from IPAM UI (localized format) or IPAM Windows PowerShell® (English format). - -Note: The IPAM Windows PowerShell import supports both the English as well as the server localized .csv file. -The computer running the IPAM server uses the presence of the field name `IPAddress` (without spaces) in the .csv file to determine that the file must be processed in English format. -Otherwise the .csv file is processed in the server localized format for the various field names and enumeration values. -The format of date and time values of the imported objects are always interpreted in the localized format of the computer running the IPAM server and not in UTC. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Import-IpamAddress -AddressFamily IPv4 -Path "C:\addressv4.csv" -Force -``` - -This example imports the IPv4 addresses from the file C:\addressv4.csv into the computer running the IPAM server. -The new addresses are added and existing addresses are edited. -The errors, if any, are recorded in the Documents folder of the user in .csv file format. -The default confirmation text is suppressed in this example. - -### EXAMPLE 2 -``` -PS C:\>Import-IpamAddress -AddressFamily IPv4 -Path "C:\addressv4.csv" -ErrorPath "C:\" -Force -``` - -This example imports IPv4 addresses from the file C:\addressv4.csv into the computer running the IPAM server. -The new addresses are added and existing addresses are edited. -The errors, if any, are recorded in .csv file format at the path C:\. -The default confirmation text is suppressed in this example. - -### EXAMPLE 3 -``` -PS C:\>Import-IpamAddress -AddressFamily IPv4 -Path "C:\addressupdatev4.csv" -ManagedByService "IPAM" -ServiceInstance "localhost" -NetworkId 10.10.10.0/24 -Confirm - -Imports a csv file as an update of all IP address records that belong to the specified IP address range. Along with adding new addresses and editing existing addresses, this operation also deletes addresses belonging to the specified IP address range from IPAM database, that are not present in the csv file update being imported. - - -Continue with this operation? - -[Y] Yes [N] No [?] Help :Y -``` - -This example imports and updates all of the IPv4 addresses belonging to the range specified by the network ID 10.10.10.0/24, the managing service IPAM, and the service instance Localhost, from the file C:\addressupdatev4.csv into the computer running the IPAM server. -The starting IP address and ending IP address of the range are automatically calculated as 10.10.10.1 and 10.10.10.254 respectively since the values are not explicitly specified. -The new addresses are added, existing addresses are edited, and addresses belonging to the specified range, which are not in the .csv file, are deleted from the computer running the IPAM server. -The errors, if any, are recorded in the documents folder of the user in .csv file format. -Note: By default, host IDs that contain all zeros (0) and all ones (1) are skipped for IPv4 address ranges while calculating the starting and ending IP address. - -### EXAMPLE 4 -``` -PS C:\>Import-IpamAddress -AddressFamily IPv4 -Path "C:\addressupdatev4.csv" -ManagedByService "IPAM" -ServiceInstance "localhost" -NetworkId 10.10.10.0/24 -StartIpAddress 10.10.10.1 -EndIpAddress 10.10.10.50 -Force -``` - -This example imports and updates all of the IPv4 addresses belonging to the range specified by the network ID 10.10.10.0/24, the starting IP address 10.10.10.1, the ending IP address 10.10.10.50, the managing service IPAM, and the service instance Localhost, from the file C:\addressupdatev4.csv into the computer running the IPAM server. -The new addresses are added, existing addresses are edited, and addresses belonging to the specified range, which are not in the .csv file, are deleted from the computer running the IPAM server. -The errors, if any, are recorded in the Documents folder of the user in .csv file format. -The default confirmation text is suppressed in this example. - -## PARAMETERS - -### -AddressFamily -Specifies the address family of the records being imported. -The acceptable values for this parameter are: IPv4 or IPv6. -Only one address family at a time can be specified with this cmdlet and the records in the .csv file should match the address family specified by this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EndIPAddress -Specifies the ending IP address of the IP address range for which the addresses are being imported. -This parameter uniquely identifies a range along with the values of the **ManagedByService**, **ServiceInstance**, **NetworkId**, and **StartIpAddress** parameters. -The default value of this parameter aligns to the end of the address range as specified by the **NetworkId** parameter; but for IPv4 networks, a host ID of all ones (`1`) is not used while calculating the default starting IP address. -An example with a default starting IP address for an IPv4 network auto-calculates the value for this parameter to be `220.0.0.254` for the **NetworkId** parameter value of `220.0.0.0/24`. -Both the **StartIpAddress** parameter and this parameter must be explicitly specified together. -This parameter must fall within the subnet specified by the **NetworkId** parameter. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: End address of the valid address range specified by NetworkId -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ErrorPath -Specifies the literal path, and not the name, of the error .csv file which are created if one or more records fail to get imported. - - -The file name is generated automatically by the computer running the IPAM server by pre-pending `Error_` and appending the timestamp of the operation to the file name specified in the **Path** parameter. -The default value of this parameter is the Documents folder of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 'Documents' folder of the user -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Suppresses the default confirmation text. -This parameter can be used with this cmdlet, to suppress the default confirmation text for the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedByService -Specifies the value of the managing service of the IP address range for which the addresses are being imported and updated. -This parameter uniquely identifies a range along with the values of the **ServiceInstance**, **NetworkId**, **StartIpAddress**, and **EndIpAddress** parameters. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkId -Specifies the IP subnet of the IP address range for which addresses are being imported in the format: `\/\` such as `220.0.0.0/24`. -This parameter uniquely identifies a range along with the values of the **ManagedByService**, **ServiceInstance**, **StartIpAddress**, and **EndIpAddress** parameters. -This parameter is used to determine the default values of the **StartIpAddress** and **EndIpAddress** parameters unless explicitly specified. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 6 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the literal path and name of the .csv file to import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceInstance -Specifies the value of the service instance of the IP address range for which the addresses are being imported and updated. -This parameter uniquely identifies a range along with the values of the **ManagedByService**, **NetworkId**, **StartIpAddress**, and **EndIpAddress** parameters. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -StartIPAddress -Specifies the starting IP address of the IP address range for which the addresses are being imported. -This parameter uniquely identifies a range along with the value of the **ManagedByService**, **ServiceInstance**, **NetworkId**, and **EndIpAddress** parameters. -The default value of this parameter aligns to the start of the address range as specified by the **NetworkId** parameter; but for IPv4 networks, a host ID of all zeros (0) is not used while calculating the default start IP address. -An example with a default starting IP address for an IPv4 network auto-calculates the value for this parameter to be `220.0.0.1` for the **NetworkId** parameter value of `220.0.0.0/24`. -Both the **StartIpAddress** and **EndIpAddress** parameters must be explicitly specified together. -This parameter must fall within the subnet specified by the **NetworkId** parameter. - -```yaml -Type: IPAddress -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: Start address of the valid address range specified by NetworkId -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.String -A detailed summary of the steps performed by this cmdlet. -The message can be one of the following: -`Import of \ objects is complete. -\ out of \ objects successfully imported.\\\` - - -OR -`Import of \ objects is complete. -\ out of \ objects successfully imported. -\ out of \ objects failed to get imported. -Failures recorded in the file: \\\\\\\` - -## NOTES - -## RELATED LINKS - -[Export-IpamAddress](./Export-IpamAddress.md) - diff --git a/docset/winserver2012-ps/ipamserver/Import-IpamRange.md b/docset/winserver2012-ps/ipamserver/Import-IpamRange.md deleted file mode 100644 index 5fc776ce21..0000000000 --- a/docset/winserver2012-ps/ipamserver/Import-IpamRange.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/import-ipamrange?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-IpamRange - -## SYNOPSIS -Imports one or more IP address range objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Import-IpamRange [-Path] [-AddressFamily] [-ErrorPath ] [-Force] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Import-IpamRange [-Path] [-AddressFamily] [-ManagedByService] - [-ServiceInstance] [-AddManagedByService] [-AddServiceInstance] [-DeleteMappedAddresses] - [-ErrorPath ] [-Force] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Import-IpamRange** cmdlet imports IP address range objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server. -The computer running the IPAM server does not support import of IP address ranges that have the **ServiceInstance** parameter value of `MS DHCP`, since this is reserved for DHCP scopes automatically discovered by the computer running the IPAM server from the managed computers running Microsoft DHCP server services. -Any objects that fail being imported during the operation are logged in the appropriate error log file for further analysis. - -This cmdlet supports two parameter sets. -The default invocation of the cmdlet adds new IP address range objects from the .csv file into the computer running the IPAM server and edits the existing address ranges with updated information specified in the .csv file. - -The second parameter set can be used to periodically import and update all IP address range objects that belong to the specified unique combination of the **ManagedByService** and **ServiceInstance** parameters, in the computer running the IPAM server. -Along with adding new ranges and editing existing ranges, this import operation also deletes those ranges from the computer running the IPAM server which have the same value as the **ManagedByService** and **ServiceInstance** parameters but are not present in the .csv file being imported. -This parameter set further provides the option of deleting the IP addresses mapping to the IP address ranges that are deleted during import by using the **DeleteMappedAddresses** parameter. - -The import and update of IP address ranges for the specified **ManagedByService** and **ServiceInstance** parameter values succeeds if these values are present in the computer running the IPAM server at the time of import. -The **AddManagedByService** and **AddServiceInstance** can be used to create the specified **ManagedByService** and **ServiceInstance** parameter values within the computer running the IPAM server at run-time before the import operation, if required. - -The only mandatory field required to be present in the .csv file being imported for IPAM ranges is the network identifier (ID) itself. -Any other range specific basic field or custom field can be specified in any order in the .csv file for import. -Sample format of import .csv file, can be generated using IPAM export functionality from IPAM UI (localized format) or IPAM Windows PowerShell® (English format). - -Note: The IPAM Windows PowerShell import supports both English as well as server localized .csv file. -The computer running the IPAM server uses presence of the field named `NetworkId` (without spaces) in the .csv file to ascertain that the file must be processed in English format. -Otherwise the file is processed in the server localized format for the various field names and enumeration values. -The format of date and time values of the imported objects are always interpreted in the localized format of the computer running the IPAM server and not in UTC. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Import-IpamRange -AddressFamily IPv4 -Path "C:\rangev4.csv" -Force -``` - -This example imports IPv4 address ranges from the file C:\rangev4.csv into the computer running the IPAM server. -The new ranges are added and existing ranges are edited. -The errors, if any, are recorded in the Documents folder of the user in .csv file format. -This example suppresses the default confirmation message. - -### EXAMPLE 2 -``` -PS C:\>Import-IpamRange -AddressFamily IPv4 -Path "C:\rangev4.csv" -ErrorPath "C:\" -Force -``` - -This example imports IPv4 address ranges from the file C:\rangev4.csv into the computer running the IPAM server. -The new ranges are added and existing ranges are edited. -The errors, if any, are recorded in .csv file format at the path C:\. -This example suppresses the default confirmation message. - -### EXAMPLE 3 -``` -PS C:\>Import-IpamRange -AddressFamily IPv4 -Path "C:\rangeupdatev4.csv" -ManagedByService "IPAM" -ServiceInstance "localhost" -Confirm - -Imports a csv file as an update of all IP address ranges that belong to the specified combination of ManagedByService and ServiceInstance values. Along with adding new ranges and editing existing ranges, this operation also deletes ranges belonging to the specified combination of ManagedByService and ServiceInstance from IPAM database, that are not present in the csv file being imported. -Continue with this operation? - -[Y] Yes [N] No [?] Help :Y -``` - -This example imports and updates all of the IPv4 address ranges managed by the service IPAM and service instance Localhost, from the file C:\rangeupdatev4.csv into IPAM. -The new ranges are added, existing ranges are edited, and ranges belonging to the specified combination of the **ManagedByService** and **ServiceInstance** parameters, which are not in the .csv file, are deleted from the computer running the IPAM server. -The errors, if any, are recorded in the Documents folder of the user in .csv file format. - -### EXAMPLE 4 -``` -PS C:\>Import-IpamRange -AddressFamily IPv4 -Path "C:\rangeupdatev4.csv" -ManagedByService "IPAM" -ServiceInstance "localhost" -ErrorPath "C:\" -Force -``` - -This example imports and updates all of the IPv4 address ranges with managing service IPAM and service instance Localhost, from the file C:\rangeupdatev4.csv into the computer running the IPAM server. -The new ranges are added, existing ranges are edited, and ranges belonging to the specified combination of the **ManagedByService** and **ServiceInstance** parameters, which are not in the .csv file, are deleted from the computer running the IPAM server. -The errors, if any, are recorded in .csv file format at the path C:\. -This example suppresses the default confirmation message. - -### EXAMPLE 5 -``` -PS C:\>Import-IpamRange -AddressFamily IPv4 -Path "C:\rangeupdatev4.csv" -ManagedByService "Others" -ServiceInstance "DHCPServer1" -AddServiceInstance -Force -``` - -This example adds DHCPServer1 as a new value of the custom field ServiceInstance, if this value is not already present in the computer running the IPAM server. -This cmdlet imports and updates all of the IPv4 address ranges with managing service Others and service instance DHCPServer1, from the file C:\rangeupdatev4.csv into the computer running the IPAM server. -The new ranges are added, existing ranges are edited, and ranges belonging to the specified combination of the **ManagedByService** and **ServiceInstance** parameters, which are not in the .csv file, are deleted from the computer running the IPAM server. -The errors, if any are recorded in the Documents folder of the user in .csv file format. -This example suppresses the default confirmation message. - -### EXAMPLE 6 -``` -PS C:\>Import-IpamRange -AddressFamily IPv4 -Path "C:\rangeupdatev4.csv" -ManagedByService "MyDHCPType" -ServiceInstance "DHCPServer1" -AddServiceInstance -AddManagedByService -Force -``` - -This example adds DHCPServer1 as a new value of the custom field ServiceInstance, if this value is not already present in the computer running the IPAM server. -This cmdlet also adds MyDHCPType as a new value of the custom field ManagedByService, if this value is not already present in the computer running the IPAM server. -This cmdlet imports and updates all of the IPv4 address ranges with managing service MyDHCPType and service instance DHCPServer1, from the file C:\rangeupdatev4.csv into the computer running the IPAM server. -The new ranges are added, existing ranges are edited, and ranges belonging to the specified combination of the **ManagedByService** and **ServiceInstance** parameters, which are not in the .csv file, are deleted from the computer running the IPAM server. -The errors, if any, are recorded in the Documents folder of the user in .csv file format. -This example suppresses the default confirmation message. - -## PARAMETERS - -### -AddManagedByService -Adds the specified **ManagedByService** parameter value to the custom field that matches this parameter name, if not already present. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AddressFamily -Specifies the address family of records being imported. -The acceptable values for this parameter are: IPv4 or IPv6. -Only one address family at a time can be specified with this cmdlet and the records in the .csv file should match the specified address. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 3 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AddServiceInstance -Adds the specified **ServiceInstance** parameter value to the custom field that matches this parameter name, if not already present. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeleteMappedAddresses -Specifies that all of the IP addresses that belong, or map, to the IP address ranges being deleted during the import and update operation, are also deleted. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ErrorPath -Specifies the literal path, and not the name, of the error .csv file which are created if one or more records fail to get imported. - - -The file name is generated automatically by the computer running the IPAM server by pre-pending `Error_` and appending the timestamp of the operation to the file name specified in the **Path** parameter. -The default value of this parameter is the Documents folder of the user. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 'Documents' folder of the user -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Force -Suppresses the default confirmation text. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ManagedByService -Specifies the value of the managing service of the IP address ranges being imported and updated. -Import of `MS DHCP` ranges is not supported by IPAM. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the literal path and name of the .csv file to import. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ServiceInstance -Specifies the value of the service instance of the IP address ranges being imported and updated. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 5 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### System.String -A detailed summary of the steps performed by this command. -Message can be one of the following: - - -"`Import of \ objects is complete. -\ out of \ objects successfully imported.\\\`" - - -OR - - -"`Import of \ objects is complete. -\ out of \ objects successfully imported. -\ out of \ objects failed to get imported. -Failures recorded in the file: \\\\\\\`" - -## NOTES - -## RELATED LINKS - -[Export-IpamRange](./Export-IpamRange.md) - diff --git a/docset/winserver2012-ps/ipamserver/Invoke-IpamGpoProvisioning.md b/docset/winserver2012-ps/ipamserver/Invoke-IpamGpoProvisioning.md deleted file mode 100644 index 51392d2660..0000000000 --- a/docset/winserver2012-ps/ipamserver/Invoke-IpamGpoProvisioning.md +++ /dev/null @@ -1,316 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/invoke-ipamgpoprovisioning?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Invoke-IpamGpoProvisioning - -## SYNOPSIS -Creates and links group policies in the specified domain for provisioning required access settings on the servers managed by the computer running the IP Address Management (IPAM) server. - -## SYNTAX - -``` -Invoke-IpamGpoProvisioning [-Domain] [-GpoPrefixName] [-DelegatedGpoGroup ] - [-DelegatedGpoUser ] [-DomainController ] [-Force] [-IpamServerFqdn ] [-PassThru] -``` - -## DESCRIPTION -The **Invoke-IpamGpoProvisioning** cmdlet creates and links three group policies specified in the **Domain** parameter for provisioning required access settings on the server roles managed by the computer running the IP Address Management (IPAM) server. -The **GpoPrefixName** parameter specified should be the same as the prefix configured in the IPAM provisioning wizard. -The three Group Policy Objects (GPOs) are created with the suffixes `_DHCP`, `_DNS`, and `_DC_NPS` appended to the **GpoPrefixName** parameter value. -These suffixes signify the three different types of access settings that are propagated by them depending on the type of server role managed by the computer running the IPAM server. - -The access settings propagated by the created GPOs are required by the periodic IPAM data collection tasks which run under the Network Service account by default. -Access settings are propagated for the computer account of the computer running the IPAM server, since that is the credential presented by Network Service to access remote resources. -If required the administrator can explicitly specify the fully qualified domain name (FQDN) of the computer running the IPAM server by using the **IpamServerFqdn** parameter By default the localhost name is used as the IpamServerFqdn value, if not specified. -The cmdlet creates a universal group named IPAMUG in the domain specified by the **Domain** parameter. -If the universal group is already present, then the creation step is skipped. -This cmdlet then adds the computer account specified by the **IpamServerFqdn** to the universal group named IPAMUG. -Any access setting propagation by IPAM GPOs is done for the universal group named IPAMUG. -The cmdlet also modifies the domain wide DNS ACL to enable DNS RPC access for the universal group named IPAMUG. - -By default the GPO creation is done on the PDC emulator for the specified domain. -The Domain Controller on which the GPO creation is done may be explicitly selected using the **DomainController** parameter. -The GPOs created by this cmdlet can be returned using the **PassThru** parameter. - -At the time of creation of GPOs, the security filter list of IPAM GPOs is empty. -When the manageability status of a server is edited by the user in IPAM server inventory view, the computer running the IPAM server automatically adds or deletes the server into the appropriate GPO security filter list, as appropriate. -Managed servers are added to the GPO security filtering and unmanaged servers are deleted from the list. - -NOTE: The cmdlet requires domain administrator privileges in order to create the GPOs. -Subsequent IPAM GPO editing privileges can be delegated to IPAM administrators who are not domain or enterprise administrators, using the **DelegatedGpoUser** and **DelegatedGpoGroup** parameters. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Invoke-IpamGpoProvisioning -Domain child.contoso.com -GpoPrefixName IPAM1 -Force -``` - -This example creates the universal group IPAMUG in the domain child.contoso,com, if not already present, and adds the computer account of the local computer running the IPAM server to the group. -This cmdlet creates and links the following IPAM GPOs: IPAM1_DHCP, IPAM1_DNS, and IPAM1_DC_NPS in the domain child.contoso.com to enable access for the group IPAMUG. -This cmdlet also enables DNS read access for IPAMUG using domain wide DNS ACL. -Since the domain controller is not explicitly specified, this cmdlet contacts the PDC emulator to complete the GPO operations. -This cmdlet suppresses the default confirmation text. - -### EXAMPLE 2 -``` -PS C:\>Invoke-IpamGpoProvisioning -Domain child.contoso.com -GpoPrefixName IPAM1 -DomainController dc1.child.contoso.com -Force -``` - -This example creates the universal group IPAMUG in the domain child.contoso.com, if not already present, and adds the computer account of the local computer running the IPAM server to the group. -This cmdlet also creates and links the following IPAM GPOs: IPAM1_DHCP, IPAM1_DNS, and IPAM1_DC_NPS in the domain child.contoso.com to enable access for the group IPAMUG. -This cmdlet enables DNS read access for IPAMUG using domain-wide DNS ACL. -This cmdlet uses the dc1.child.contoso.com as the DC to complete the GPO operations. -This cmdlet suppresses the default confirmation text. - -### EXAMPLE 3 -``` -PS C:\>Invoke-IpamGpoProvisioning -Domain child.contoso.com -GpoPrefixName IPAM2 -IpamServerFqdn ipam2.contoso.com -Force -``` - -This example creates the universal group named IPAMUG, if not already present, and adds the computer account of the specified computer running the IPAM server named ipam2.contoso.com to the group. -This cmdlet creates and links the following IPAM GPOs: IPAM2_DHCP, IPAM2_DNS, and IPAM2_DC_NPS in the domain child.contoso.com to enable access for the universal group named IPAMUG. -This cmdlet enables DNS read access for the universal group named IPAMUG using domain-wide DNS ACL. -This cmdlet suppresses the default confirmation text. - -### EXAMPLE 4 -``` -PS C:\>Invoke-IpamGpoProvisioning -Domain child.contoso.com -GpoPrefixName IPAM1 -DelegatedGpoUser NetworkAdmin1,NetworkAdmin2 -Force -``` - -This example creates the universal group named IPAMUG in domain child.contoso.com, if not already present, and adds the computer account of the local computer running the IPAM server to the group. -This cmdlet creates and links the following IPAM GPOs: IPAM1_DHCP, IPAM1_DNS, and IPAM1_DC_NPS in the domain child.contoso.com to enable access for the universal group named IPAMUG. -This cmdlet delegates GPO edit privileges to users NetworkAdmin1 and NetworkAdmin2. -This cmdlet enables DNS read access for the universal group named IPAMUG using domain-wide DNS ACL. -This cmdlet suppresses the default confirmation text. - -### EXAMPLE 5 -``` -PS C:\>Invoke-IpamGpoProvisioning -Domain child.contoso.com -GpoPrefixName IPAM1 -DelegatedGpoGroup IPAMAdmins -Force -``` - -This example creates the universal group named IPAMUG in domain child.contoso.com, if not already present, and adds the computer account of the local computer running the IPAM server to the group. -This cmdlet creates and links the following IPAM GPOs: IPAM1_DHCP, IPAM1_DNS, and IPAM1_DC_NPS in the domain child.contoso.com to enable access for the universal group named IPAMUG. -This cmdlet delegates GPO edit privileges to the group IPAMAdmins. -This cmdlet enables DNS read access for the universal group named IPAMUG using domain-wide DNS ACL. -This cmdlet suppresses the default confirmation text. - -### EXAMPLE 6 -``` -PS C:\>Invoke-IpamGpoProvisioning -Domain ds2-infra.contoso.com -GpoPrefixName IPAM1 -PassThru -Force -DisplayName : IPAM1_DNS -DomainName : ds2-infra.contoso.com -Owner : DS2-INFRA\Domain Admins -Id : ac9dcf5e-8581-442d-ba12-ae7569985313 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/7/2012 1:04:18 AM -ModificationTime : 2/7/2012 1:04:28 AM -UserVersion : AD Version: 1, SysVol Version: 1 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : - -DisplayName : IPAM1_DC_NPS -DomainName : ds2-infra.contoso.com -Owner : DS2-INFRA\Domain Admins -Id : 5aaf16d7-9818-47c4-ade9-3860bc00c292 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/7/2012 1:04:19 AM -ModificationTime : 2/7/2012 1:04:28 AM -UserVersion : AD Version: 1, SysVol Version: 1 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : - -DisplayName : IPAM1_DHCP -DomainName : ds2-infra.contoso.com -Owner : DS2-INFRA\Domain Admins -Id : 51fb3dee-0032-4d9a-8b92-84af318dcb51 -GpoStatus : AllSettingsEnabled -Description : -CreationTime : 2/7/2012 1:04:20 AM -ModificationTime : 2/7/2012 1:04:28 AM -UserVersion : AD Version: 1, SysVol Version: 1 -ComputerVersion : AD Version: 1, SysVol Version: 1 -WmiFilter : -``` - -This example creates the universal group named IPAMUG in domain child.contoso.com, if not already present, and adds the computer account of the local computer running the IPAM server to the group. -This cmdlet creates and links the following IPAM GPOs: IPAM1_DHCP, IPAM1_DNS, and IPAM1_DC_NPS in the domain ds2-infra.contoso.com to enable access for the universal group named IPAMUG. -This cmdlet enables DNS read access for the universal group named IPAMUG using a domain-wide DNS ACL. -This cmdlet suppresses the default confirmation text. -This cmdlet outputs the GPOs created during this operation. - -## PARAMETERS - -### -DelegatedGpoGroup -Specifies the comma separated list of domain groups which are delegated edit permissions on the three IPAM GPOs created by this cmdlet. -The standard GPO delegation privilege of `Edit settings, Delete, Modify Security` is enabled for these groups. -Delegation for users or groups without domain administrator privileges can also be enabled from GPMC or GPO cmdlets for the existing IPAM GPOs. -This delegation is leveraged by the computer running the IPAM server to automatically edit the GPO filter list in security context of the logged in user who is modifying the server manageability status from the IPAM server inventory view. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DelegatedGpoUser -Specifies the comma separated list of domain users which are delegated edit permissions on the three IPAM GPOs created by this cmdlet. -The standard GPO delegation privilege of `Edit settings, Delete, Modify Security` is enabled for these users. -Delegation for users or groups without domain administrator privileges can also be enabled from GPMC or GPO cmdlets for the existing IPAM GPOs. -This delegation is leveraged by the computer running the IPAM server to automatically edit the GPO filter list in security context of the logged in user who is modifying the server manageability status from the IPAM server inventory view. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Domain -Specifies the FQDN of the domain for which the IPAM GPOs are created and linked, for example `sales.contoso.com`. -At a time only one domain name should be specified. -This cmdlet needs to be invoked one by one for each domain in the Active Directory (AD) forest that needs to be managed by the computer running IPAM server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Specifies the name of the domain controller that is contacted to complete the GPO operation. -Either the FQDN or simply the host name of the domain controller can be specified, such as `dc1.sales.contoso.com` or `dc1`. -A valid domain controller name for the specified domain must be provided. -By default the computer running the IPAM server contacts the PDC emulator of the specified domain unless this parameter is explicitly provided. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: PDC emulator for specified Domain -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Forces the command to run without asking for user confirmation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GpoPrefixName -Specifies the unique GPO prefix name used while creating the group policy. -The GPO prefix name, such as IPAMGPO_ServerX, specified here must be same as the one specified in the IPAM provisioning wizard while selecting Group Policy based provisioning method. -The three IPAM GPOs are created with the suffixes `_DHCP`, `_DNS`, and `_DC_NPS` appended to this parameter value, such as IPAMGPO_ServerX_DHCP, IPAMGPO_ServerX_DNS, and IPAMGPO_ServerX_DC_NPS. -These suffixes signify the three different types of access settings that are propagated by them depending on the type of server role managed by the computer running the IPAM server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IpamServerFqdn -Specifies the FQDN format name of the computer running the IPAM server for which the GPOs enables access settings, such as `ipam1.contoso.com`. -By default IPAM uses the FQDN of the computer running the IPAM server from where the cmdlet is running to enable access settings. -The specified computer account is added to the universal group named IPAMUG created by this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.GroupPolicy.Gpo[] - -## NOTES - -## RELATED LINKS - -[Add-IpamCustomField](./Add-IpamCustomField.md) - -[Add-IpamCustomValue](./Add-IpamCustomValue.md) - -[Export-IpamAddress](./Export-IpamAddress.md) - -[Export-IpamRange](./Export-IpamRange.md) - -[Get-IpamConfiguration](./Get-IpamConfiguration.md) - -[Get-IpamCustomField](./Get-IpamCustomField.md) - -[Import-IpamAddress](./Import-IpamAddress.md) - -[Import-IpamRange](./Import-IpamRange.md) - -[Set-IpamConfiguration](./Set-IpamConfiguration.md) - diff --git a/docset/winserver2012-ps/ipamserver/IpamServer.md b/docset/winserver2012-ps/ipamserver/IpamServer.md deleted file mode 100644 index 19f6a6bb65..0000000000 --- a/docset/winserver2012-ps/ipamserver/IpamServer.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 69775f93-9317-4234-a558-13b6655fc41b -Module Name: IpamServer ---- - -# IpamServer Module -## Description -This reference provides cmdlet descriptions and syntax for all IP Address Management (IPAM) Server-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## IpamServer Cmdlets -### [Add-IpamCustomField](./Add-IpamCustomField.md) -Adds a new free form or multi-valued custom field to the computer running the IP Address Management (IPAM) server. - -### [Add-IpamCustomValue](./Add-IpamCustomValue.md) -Adds a new custom value to a multi-valued, custom field in IP Address Management (IPAM). - -### [Export-IpamAddress](./Export-IpamAddress.md) -Exports all of the IP addresses of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated value (.csv) file or as an array of Windows PowerShell® objects or both. - -### [Export-IpamRange](./Export-IpamRange.md) -Exports all of the IP address ranges of the specified address family from the computer running the IP Address Management (IPAM) server as a comma-separated values (.csv) file or as an array of Windows PowerShell® objects or both. - -### [Get-IpamConfiguration](./Get-IpamConfiguration.md) -Gets the configuration for the computer running the IP Address Management (IPAM) server. - -### [Get-IpamCustomField](./Get-IpamCustomField.md) -Gets the IP Address Management (IPAM) custom field information. - -### [Import-IpamAddress](./Import-IpamAddress.md) -Imports one or more IP address objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server. - -### [Import-IpamRange](./Import-IpamRange.md) -Imports one or more IP address range objects from the specified comma-separated values (.csv) file into the computer running the IP Address Management (IPAM) server. - -### [Invoke-IpamGpoProvisioning](./Invoke-IpamGpoProvisioning.md) -Creates and links group policies in the specified domain for provisioning required access settings on the servers managed by the computer running the IP Address Management (IPAM) server. - -### [Set-IpamConfiguration](./Set-IpamConfiguration.md) -Sets the configuration for the computer running the IP Address Management (IPAM) server, including the TCP port number over which the computer running the IPAM Remote Server Administration Tools (RSAT) client connects with the computer running the IPAM server. - diff --git a/docset/winserver2012-ps/ipamserver/Set-IpamConfiguration.md b/docset/winserver2012-ps/ipamserver/Set-IpamConfiguration.md deleted file mode 100644 index d884bc2a54..0000000000 --- a/docset/winserver2012-ps/ipamserver/Set-IpamConfiguration.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: IpamServer_Cmdlets.xml -Module Name: IpamServer -online version: https://learn.microsoft.com/powershell/module/ipamserver/set-ipamconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-IpamConfiguration - -## SYNOPSIS -Sets the configuration for the computer running the IP Address Management (IPAM) server, including the TCP port number over which the computer running the IPAM Remote Server Administration Tools (RSAT) client connects with the computer running the IPAM server. - -## SYNTAX - -``` -Set-IpamConfiguration [-Port] [-Force] [-PassThru] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-IpamConfiguration** cmdlet sets the IP Address Management (IPAM) server configuration, including the TCP port over which the computer running the IPAM Remote Server Administration Tools (RSAT) client connects and communicates with the computer running the IPAM server. -This cmdlet can be leveraged to specify an alternate firewall port number for remotely managing the computer running the IPAM server, in the event of a port conflict. -The default port number used by IPAM is `48885`. -The cmdlet configures appropriate custom IPAM server firewall rules for the specified new port, enables appropriate custom IPAM server firewall rules for the specified new port, and restarts the IPAM application pool to listen on the specified new port. -This cmdlet must be run from an elevated Windows PowerShell® prompt with administrator privileges on the computer running the IPAM server. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-IpamServerConfiguration -Port 45000 -PassThru -Force -Version : 1.3 - -Port : 45000 -``` - -This example changes the IPAM server management port to 45000 and suppresses the default confirmation text and returns the modified IPAM server configuration object. - -## PARAMETERS - -### -Force -Suppresses the default confirmation text. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the TCP port number being configured for communication between computers running the IPAM RSAT client and IPAM server. -The required firewall rules are also set up for this port. -Although IPAM allows any port number from `1` through `65535` to be configured for communication between computers running the IPAM client and server; it is recommended, to avoid port conflicts with well-known ports, that a port from the unassigned port range `48620` through `49150` is selected. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Windows.Ipam.Commands.IpamConfiguration -This object contains an IPAM configuration. - -## NOTES - -## RELATED LINKS - -[Get-IpamConfiguration](./Get-IpamConfiguration.md) - diff --git a/docset/winserver2012-ps/iscsi/Connect-IscsiTarget.md b/docset/winserver2012-ps/iscsi/Connect-IscsiTarget.md deleted file mode 100644 index 9e41b754ae..0000000000 --- a/docset/winserver2012-ps/iscsi/Connect-IscsiTarget.md +++ /dev/null @@ -1,360 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/connect-iscsitarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Connect-IscsiTarget - -## SYNOPSIS -Establishes a connection between the local iSCSI initiator, and the specified iSCSI target device. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Connect-IscsiTarget [-AsJob] [-AuthenticationType ] [-ChapSecret ] [-ChapUsername ] - [-CimSession ] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] - [-IsDataDigest ] [-IsHeaderDigest ] [-IsMultipathEnabled ] - [-IsPersistent ] [-ReportToPnP ] [-TargetPortalAddress ] - [-TargetPortalPortNumber ] [-ThrottleLimit ] -NodeAddress -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Connect-IscsiTarget [-AsJob] [-AuthenticationType ] [-ChapSecret ] [-ChapUsername ] - [-CimSession ] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] - [-IsDataDigest ] [-IsHeaderDigest ] [-IsMultipathEnabled ] [-ReportToPnP ] - [-TargetPortalAddress ] [-TargetPortalPortNumber ] [-ThrottleLimit ] - -InputObject -``` - -## DESCRIPTION -The **Connect-IscsiTarget** cmdlet initiates a connection to the specified iSCSI target device. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-IscsiTarget -IsConnected NodeAddress ------------ ----------- -True iqn.1991-05.com.contoso:testiscsi-deepcore-target - - -PS C:\>$Tar = Get-IscsiTarget - - - -PS C:\>Disconnect-IscsiTarget -NodeAddress $Tar.NodeAddress -Confirm -Are you sure you want to perform this action? -Performing operation '' on Target ''. - - -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):Y - - - -PS C:\>Connect-IscsiTarget -NodeAddress $Tar.NodeAddress -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370000 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-400001370000000b -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0100 -``` - -This example connects an iSCSI target, collects information about the target, and stores it in a variable, disconnects, and then connects using this cmdlet - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the type of authentication to use when logging into the target. -Valid values are **None**, **OneWayCHAP**, and **MutualCHAP**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapSecret -Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapUsername -Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorInstanceName -Specifies the name of the initiator via which the **SendTargets** operation is performed. -If not specified, then the initiator used is selected by the iSCSI initiator service. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorPortalAddress -Specifies the IP address or DNS name associated with the portal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the pipeline as input. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsDataDigest -Enables data digest when the initiator logs into the target portal. -By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsHeaderDigest -Enables header digest when the initiator logs into the target portal. -By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMultipathEnabled -Indicates that the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsPersistent -Specifies that the session is to be automatically connected after each restart. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NodeAddress -Represents the IQN of the discovered target. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReportToPnP -Specifies that the operation is reported to PNP. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPortalAddress -Represents the IP address or DNS name of the target portal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TA - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPortalPortNumber -Specifies the TCP/IP port number for the target portal. -By default, the port number is `3260`. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) diff --git a/docset/winserver2012-ps/iscsi/Disconnect-IscsiTarget.md b/docset/winserver2012-ps/iscsi/Disconnect-IscsiTarget.md deleted file mode 100644 index 93aa7ff48e..0000000000 --- a/docset/winserver2012-ps/iscsi/Disconnect-IscsiTarget.md +++ /dev/null @@ -1,217 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/disconnect-iscsitarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disconnect-IscsiTarget - -## SYNOPSIS -Disconnects sessions to the specified iSCSI target object. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disconnect-IscsiTarget [-AsJob] [-CimSession ] [-NodeAddress ] [-PassThru] - [-SessionIdentifier ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disconnect-IscsiTarget [-AsJob] [-CimSession ] [-PassThru] [-SessionIdentifier ] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disconnect-IscsiTarget** cmdlet disconnects a connected iSCSI target. -To view connected iSCSI targets, use the Get-iSCSITarget cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-IscsiTarget -IsConnected NodeAddress ------------ ----------- -True iqn.1991-05.com.contoso:testiscsi-deepcore-target - - -PS C:\>$Tar = Get-IscsiTarget - - - -PS C:\>Disconnect-IscsiTarget -NodeAddress $Tar.NodeAddress -Confirm -Are you sure you want to perform this action? -Performing operation '' on Target ''. - - -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):Y -``` - -This example collects information about a connected iSCSI target, and then using that information to run this cmdlet. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the pipeline as input. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NodeAddress -Represents the IQN of the discovered target. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionIdentifier -Specifies the session identifier. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-iSCSITarget](./Get-IscsiTarget.md) diff --git a/docset/winserver2012-ps/iscsi/Get-IscsiConnection.md b/docset/winserver2012-ps/iscsi/Get-IscsiConnection.md deleted file mode 100644 index 5eab811f9b..0000000000 --- a/docset/winserver2012-ps/iscsi/Get-IscsiConnection.md +++ /dev/null @@ -1,351 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/get-iscsiconnection?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiConnection - -## SYNOPSIS -Gets information about connected iSCSI initiator connections. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-ConnectionIdentifier ] - [-InitiatorPortalPortNumber ] [-InititorIPAdressListNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPort ] - [-InitiatorPortalPortNumber ] [-InititorIPAdressListNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPortalPortNumber ] - [-InititorIPAdressListNumber ] [-iSCSITargetPortal ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-Disk ] - [-InitiatorPortalPortNumber ] [-InititorIPAdressListNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPortalPortNumber ] - [-InititorIPAdressListNumber ] [-IscsiSession ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPortalAddress ] - [-InitiatorPortalPortNumber ] [-InititorIPAdressListNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_7 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPortalPortNumber ] - [-InitiatorSideIdentifier ] [-InititorIPAdressListNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_8 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPortalPortNumber ] - [-InititorIPAdressListNumber ] [-IscsiTarget ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_9 -``` -Get-IscsiConnection [-AsJob] [-CimSession ] [-InitiatorPortalPortNumber ] - [-InititorIPAdressListNumber ] [-TargetSideIdentifier ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-IscsiConnection** cmdlet returns information about active iSCSI initiator connections. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-IscsiConnection -ConnectionIdentifier : fffffa8005313020-2 -InitiatorNodeAddress : 0.0.0.0 -InitiatorPortNumber : 41458 -TargetNodeAddress : 10.121.235.126 -TargetPortNumber : 3260 -``` - -The example shows information returned by this cmdlet from a connected iSCSI target. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ConnectionIdentifier -Specifies the connection identifier for an iSCSI session. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Disk -Accepts a MSFT disk object as an input. -The MSFT disk object is output from the Get-Disk cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InitiatorPort -Accepts a MSFT initiator port object as an input. -The MSFT initiator port object is output from the Get-InitiatorPort cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InitiatorPortalAddress -Represents the IP address or DNS name associated with the portal. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorPortalPortNumber -Specifies the TCP/IP port number for the initiator portal. - -```yaml -Type: UInt16[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorSideIdentifier -Specifies the initiator side identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InititorIPAdressListNumber -Represents the index to the initiator IP address list. - -```yaml -Type: UInt16[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IscsiSession -Accepts a MSFT iSCSI session object as an input. -The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiTarget -Accepts a MSFT iSCSI target object as an input. -The MSFT iSCSI target object is output from the Get-IscsiTarget cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TargetSideIdentifier -Specifies the target side identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_9 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -iSCSITargetPortal -Allows passing a MSFT iSCSI target portal CIM object as an input. -The MSFT iSCSI target portal CIM object is output from the Get-IscsiTargetPortal cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### System.String - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DISK -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_InitiatorPort -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTarget -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_iSCSIConnection -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-IscsiSession](./Get-IscsiSession.md) - -[Get-IscsiTarget](./Get-IscsiTarget.md) - -[Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) - -[Get-Disk](../storage/Get-Disk.md) - -[Get-InitiatorPort](../storage/Get-InitiatorPort.md) diff --git a/docset/winserver2012-ps/iscsi/Get-IscsiSession.md b/docset/winserver2012-ps/iscsi/Get-IscsiSession.md deleted file mode 100644 index 90e30a607d..0000000000 --- a/docset/winserver2012-ps/iscsi/Get-IscsiSession.md +++ /dev/null @@ -1,352 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/get-iscsisession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiSession - -## SYNOPSIS -Retrieves information about established iSCSI sessions. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-IscsiTargetPortal ] - [-NumberOfConnections ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-NumberOfConnections ] - [-SessionIdentifier ] [-TargetSideIdentifier ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-IscsiTarget ] - [-NumberOfConnections ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-InitiatorSideIdentifier ] - [-NumberOfConnections ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-InitiatorPort ] - [-NumberOfConnections ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-Disk ] [-NumberOfConnections ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_7 -``` -Get-IscsiSession [-AsJob] [-CimSession ] [-IscsiConnection ] - [-NumberOfConnections ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-IscsiSession** cmdlet returns information about iSCSI sessions. - -Note: There is an association between the iSCSI session and the disk object, so it is possible to return all disks connected via a specific iSCSI session by running the following cmdlet. - - - - `Get-iSCSISession | Get-Disk` - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-IscsiSession -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.microsoft:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370001 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-4000013700000001 -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0200 - -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370004 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-4000013700000002 -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0100 - -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370002 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-4000013700000003 -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0300 -``` - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disk -Accepts a MSFT disk object as an input. -The MSFT disk object is output from the Get-Disk cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InitiatorPort -Accepts a MSFT initiator port object as an input. -The MSFT initiator port object is output from the Get-InitiatorPort cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InitiatorSideIdentifier -Specifies the initiator side identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IscsiConnection -Accepts a MSFT iSCSI connection object as an input. -The MSFT iSCSI connection object is output from the Get-IscsiConnection cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiTarget -Accepts a MSFT iSCSI target object as an input. -The MSFT iSCSI target object is output from the Get-IscsiTarget cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiTargetPortal -Accepts a MSFT iSCSI target portal object as an input. -The MSFT iSCSI target portal object is output from the Get-IscsiTargetPortal cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NumberOfConnections -Specifies the number of connections. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SessionIdentifier -Specifies the session identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetSideIdentifier -Specifies the target side identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_DISK -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_InitiatorPort -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiConnection -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTarget -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-IscsiConnection](./Get-IscsiConnection.md) - -[Get-IscsiTarget](./Get-IscsiTarget.md) - -[Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) - -[Get-Disk](../storage/Get-Disk.md) - -[Get-InitiatorPort](../storage/Get-InitiatorPort.md) diff --git a/docset/winserver2012-ps/iscsi/Get-IscsiTarget.md b/docset/winserver2012-ps/iscsi/Get-IscsiTarget.md deleted file mode 100644 index aee9f4048d..0000000000 --- a/docset/winserver2012-ps/iscsi/Get-IscsiTarget.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/get-iscsitarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiTarget - -## SYNOPSIS -Returns an iSCSI target object for each iSCSI target that is registered with the iSCSI initiator. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-IscsiTarget [-AsJob] [-CimSession ] [-NodeAddress ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-IscsiTarget [-AsJob] [-CimSession ] [-InitiatorPort ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-IscsiTarget [-AsJob] [-CimSession ] [-IscsiTargetPortal ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-IscsiTarget [-AsJob] [-CimSession ] [-IscsiSession ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-IscsiTarget [-AsJob] [-CimSession ] [-IscsiConnection ] [-ThrottleLimit ] -``` - -## DESCRIPTION -This **Get-IscsiTarget** cmdlet returns information about connected iSCSI targets. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-IscsiTarget -IsConnected NodeAddress ------------ ----------- -True iqn.1991-05.com.contoso:testiscsi-deepcore-target -``` - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorPort -Accepts a MSFT initiator port object as an input. -The MSFT initiator port object is output from the Get-InitiatorPort cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiConnection -Accepts a MSFT iSCSI connection object as an input. -The MSFT iSCSI connection object is output from the Get-IscsiConnection cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiSession -Accepts a MSFT iSCSI session object as an input. -The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiTargetPortal -Accepts a MSFT iSCSI target portal object as an input. -The MSFT iSCSI target portal object is output from the Get-IscsiTargetPortal cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NodeAddress -Represents the IQN of the discovered target. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_InitiatorPort -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiConnection -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTarget -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-IscsiConnection](./Get-IscsiConnection.md) - -[Get-IscsiSession](./Get-IscsiSession.md) - -[Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) - -[Get-InitiatorPort](../storage/Get-InitiatorPort.md) diff --git a/docset/winserver2012-ps/iscsi/Get-IscsiTargetPortal.md b/docset/winserver2012-ps/iscsi/Get-IscsiTargetPortal.md deleted file mode 100644 index e1e07ea0e8..0000000000 --- a/docset/winserver2012-ps/iscsi/Get-IscsiTargetPortal.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/get-iscsitargetportal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiTargetPortal - -## SYNOPSIS -Gives the list of target portals which have been set for discovery. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-IscsiTargetPortal [[-TargetPortalAddress] ] [-AsJob] [-CimSession ] - [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-IsDataDigest ] - [-IsHeaderDigest ] [-TargetPortalPortNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-IscsiTargetPortal [-AsJob] [-CimSession ] [-iSCSITarget ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-IscsiTargetPortal [-AsJob] [-CimSession ] [-iSCSISession ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-IscsiTargetPortal [-AsJob] [-CimSession ] [-iSCSIConnection ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-IscsiTargetPortal** cmdlet gets information about iSCSI target portals. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-IscsiTargetPortal -TargetPortalAddress testIscsi -InitiatorInstanceName : -InitiatorNodeAddress : -InitiatorPortalAddress : -InititorIPAdressListNumber : 4294967295 -IsDataDigest : False -IsHeaderDigest : False -TargetPortalAddress : testIscsi -TargetPortalPortNumber : 3260 -``` - -This example adds a new iSCSI target portal with the name testiSCSI to perform discovery. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorInstanceName - - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorPortalAddress -Represents the IP address or DNS name associated with the portal. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsDataDigest -Enables data digest when the initiator logs into the target portal. -By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver. - -```yaml -Type: Boolean[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsHeaderDigest -Enables header digest when the initiator logs into the target portal. -By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver. - -```yaml -Type: Boolean[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPortalAddress -Represents the IP address or DNS name of the target portal. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPortalPortNumber -Specifies the TCP/IP port number for the target portal. -By default, the port number is `3260`. - -```yaml -Type: UInt16[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -iSCSIConnection -Accepts a MSFT iSCSI connection object as an input. -The MSFT iSCSI connection object is output from the Get-IscsiConnection cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -iSCSISession -Accepts a MSFT iSCSI session object as an input. -The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -iSCSITarget -Accepts a MSFT iSCSI target object as an input. -The MSFT iSCSI target object is output from the Get-IscsiTarget cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiConnection -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTarget -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-IscsiConnection](./Get-IscsiConnection.md) - -[Get-IscsiSession](./Get-IscsiSession.md) - -[Get-IscsiTarget](./Get-IscsiTarget.md) diff --git a/docset/winserver2012-ps/iscsi/New-IscsiTargetPortal.md b/docset/winserver2012-ps/iscsi/New-IscsiTargetPortal.md deleted file mode 100644 index 0b66036222..0000000000 --- a/docset/winserver2012-ps/iscsi/New-IscsiTargetPortal.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/new-iscsitargetportal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-IscsiTargetPortal - -## SYNOPSIS -Configures an iSCSI target portal. - -## SYNTAX - -``` -New-IscsiTargetPortal [-AsJob] [-AuthenticationType ] [-ChapSecret ] [-ChapUsername ] - [-CimSession ] [-InitiatorInstanceName ] [-InitiatorPortalAddress ] - [-IsDataDigest ] [-IsHeaderDigest ] [-TargetPortalPortNumber ] - [-ThrottleLimit ] -TargetPortalAddress -``` - -## DESCRIPTION -The **New-IscsiTargetPortal** cmdlet connects a new iSCSI target portal. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>New-IscsiTargetPortal -TargetPortalAddress testIscsi -InitiatorInstanceName : -InitiatorNodeAddress : -InitiatorPortalAddress : -InititorIPAdressListNumber : 4294967295 -IsDataDigest : False -IsHeaderDigest : False -TargetPortalAddress : testIscsi -TargetPortalPortNumber : 3260 -``` - -This example adds a new iSCSI target portal with the name testIscsi to perform discovery - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AuthenticationType -Specifies the type of authentication to use when logging into the target. -Valid values are **None**, **OneWayCHAP**, and **MutualCHAP**. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapSecret -Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapUsername -Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorInstanceName -The name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. -If no instance name is specified, the iSCSI initiator service chooses the initiator instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorPortalAddress -Specifies the IP address or DNS name associated with the portal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: IA - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsDataDigest -Enables data digest when the initiator logs into the target portal. -By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsHeaderDigest -Enables header digest when the initiator logs into the target portal. -By not specifying this parameter, the digest setting is determined by the initiator kernel mode driver. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPortalAddress -Specifies the IP address or DNS name of the target portal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: TA - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPortalPortNumber -Specifies the TCP/IP port number for the target portal. -By default, the port number is `3260`. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) diff --git a/docset/winserver2012-ps/iscsi/Register-IscsiSession.md b/docset/winserver2012-ps/iscsi/Register-IscsiSession.md deleted file mode 100644 index cbb0bce671..0000000000 --- a/docset/winserver2012-ps/iscsi/Register-IscsiSession.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/register-iscsisession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Register-IscsiSession - -## SYNOPSIS -Registers an active iSCSI session to be persistent using the session identifier as input. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Register-IscsiSession [-AsJob] [-ChapSecret ] [-ChapUsername ] [-CimSession ] - [-IsMultipathEnabled ] [-PassThru] [-ThrottleLimit ] -SessionIdentifier -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Register-IscsiSession [-AsJob] [-ChapSecret ] [-ChapUsername ] [-CimSession ] - [-IsMultipathEnabled ] [-PassThru] [-ThrottleLimit ] -InputObject -``` - -## DESCRIPTION -The **Register-IscsiSession** cmdlet registers an existing iSCSI session to make it persistent. -Once an iSCSI session is registered, it will automatically attempt to reconnect on reboot. - -Note: Registering a connection multiple times will automatically re-establish multiple sessions for use with Multipath I/O (MPIO). - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Register-IscsiSession -SessionIdentifier fffffa800d008430-4000013700000001 -``` - -This example registers the iSCSI session with the session ID fffffa800d008430-4000013700000001 to be persistent across reboots. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapSecret -Specifies the CHAP secret to use when establishing a connection authenticated by using CHAP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapUsername -Specifies the user name to use when establishing a connection authenticated by using Mutual CHAP. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the pipeline as input. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IsMultipathEnabled -Indicates that the initiator has enabled Multipath I/O (MPIO) and it will be used when logging into the target portal. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionIdentifier -Specifies the session identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) diff --git a/docset/winserver2012-ps/iscsi/Remove-IscsiTargetPortal.md b/docset/winserver2012-ps/iscsi/Remove-IscsiTargetPortal.md deleted file mode 100644 index fc62638276..0000000000 --- a/docset/winserver2012-ps/iscsi/Remove-IscsiTargetPortal.md +++ /dev/null @@ -1,242 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/remove-iscsitargetportal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-IscsiTargetPortal - -## SYNOPSIS -Removes the specified iSCSI target portal. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-IscsiTargetPortal [-AsJob] [-CimSession ] [-InitiatorInstanceName ] - [-InitiatorPortalAddress ] [-PassThru] [-TargetPortalPortNumber ] [-ThrottleLimit ] - -TargetPortalAddress [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-IscsiTargetPortal [-AsJob] [-CimSession ] [-InitiatorInstanceName ] - [-InitiatorPortalAddress ] [-PassThru] [-TargetPortalPortNumber ] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-IscsiTargetPortal** cmdlet removes an existing iSCSI target portal connection. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-IscsiTargetPortal -InitiatorInstanceName : -InitiatorNodeAddress : -InitiatorPortalAddress : -InititorIPAdressListNumber : 4294967295 -IsDataDigest : False -IsHeaderDigest : False -TargetPortalAddress : testIscsi -TargetPortalPortNumber : 3260 - - -PS C:\>Remove-IscsiTargetPortal -TargetPortalAddress testIscsi -``` - -This example removes the target portal specified - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorInstanceName -Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. -If no instance name is specified, the iSCSI initiator service chooses the initiator instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorPortalAddress -Specifies the IP address or DNS name associated with the initiator portal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the pipeline as input. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPortalAddress -Specifies the IP address or DNS name of the target portal. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPortalPortNumber -Specifies the TCP/IP port number for the target portal. -By default, the port number `3260`. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 3260 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) diff --git a/docset/winserver2012-ps/iscsi/Set-IscsiChapSecret.md b/docset/winserver2012-ps/iscsi/Set-IscsiChapSecret.md deleted file mode 100644 index 4602564acd..0000000000 --- a/docset/winserver2012-ps/iscsi/Set-IscsiChapSecret.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/set-iscsichapsecret?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-IscsiChapSecret - -## SYNOPSIS -Sets a CHAP secret key for use with iSCSI initiator connections. - -## SYNTAX - -``` -Set-IscsiChapSecret [-AsJob] [-ChapSecret ] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Set-IscsiChapSecret** cmdlet sets a CHAP secret key for use with iSCSI initiator connections. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-IscsiChapSecret -ChapSecret 12345678912345 -``` - -This example sets the Chap secret key to "12345678912345" - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ChapSecret -Sets the CHAP secret key for use with the iSCSI initiator connections. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.String - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) diff --git a/docset/winserver2012-ps/iscsi/Unregister-IscsiSession.md b/docset/winserver2012-ps/iscsi/Unregister-IscsiSession.md deleted file mode 100644 index 0ea39320b7..0000000000 --- a/docset/winserver2012-ps/iscsi/Unregister-IscsiSession.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/unregister-iscsisession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Unregister-IscsiSession - -## SYNOPSIS -Removes an active iSCSI session from being persistent using the session identifier as input. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Unregister-IscsiSession [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -SessionIdentifier -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Unregister-IscsiSession [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject -``` - -## DESCRIPTION -The **Unregister-IscsiSession** cmdlet removes a registered iSCSI session to prevent it from automatically reconnection on reboot. - -## EXAMPLES - -### Example 1 -``` -This information shows the output from the Get-iSCSISession. Since no additional switches or filters were used, this returns information about all iSCSI sessions across all iSCSI connections. -PS C:\>Get-IscsiSession -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370001 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-4000013700000001 -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0200 - -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370004 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-4000013700000002 -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0100 - -AuthenticationType : NONE -InitiatorInstanceName : ROOT\ISCSIPRT\0000_0 -InitiatorNodeAddress : iqn.1991-05.com.contoso:deepcore.contoso.com -InitiatorPortalAddress : -InitiatorSideIdentifier : 400001370002 -IsConnected : True -IsDataDigest : False -IsDiscovered : True -IsHeaderDigest : False -IsMultipathEnabled : False -IsPersistent : True -NumberOfConnections : 1 -SessionIdentifier : fffffa800d008430-4000013700000003 -TargetNodeAddress : iqn.1991-05.com.contoso:testiscsi-deepcore-target -TargetSideIdentifier : 0300 - - -PS C:\>Unregister-IscsiSession -SessionIdentifier fffffa800d008430-4000013700000001 -``` - -This example gets a list of sessions, and then uses this cmdlet to remove the session. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the pipeline as input. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SessionIdentifier -Specifies the session identifier. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-iSCSISession](./Get-IscsiSession.md) diff --git a/docset/winserver2012-ps/iscsi/Update-IscsiTarget.md b/docset/winserver2012-ps/iscsi/Update-IscsiTarget.md deleted file mode 100644 index c95d429a55..0000000000 --- a/docset/winserver2012-ps/iscsi/Update-IscsiTarget.md +++ /dev/null @@ -1,260 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/update-iscsitarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-IscsiTarget - -## SYNOPSIS -Refreshes the information about connected iSCSI target objects. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Update-IscsiTarget [-AsJob] [-CimSession ] [-NodeAddress ] [-PassThru] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Update-IscsiTarget [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Update-IscsiTarget [-AsJob] [-CimSession ] [-IscsiSession ] [-PassThru] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Update-IscsiTarget [-AsJob] [-CimSession ] [-IscsiConnection ] [-PassThru] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Update-IscsiTarget [-AsJob] [-CimSession ] [-InitiatorPort ] [-PassThru] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Update-IscsiTarget [-AsJob] [-CimSession ] [-IscsiTargetPortal ] [-PassThru] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Update-IscsiTarget** cmdlet refreshes the cached information about an existing connection to an iSCSI target. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Update-IscsiTarget -``` - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorPort -Accepts a MSFT initiator port object as an input. -The MSFT initiator port object is output from the Get-InitiatorPort cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the pipeline as input. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiConnection -Accepts a MSFT iSCSI connection object as an input. -The MSFT iSCSI connection object is output from the Get-IscsiConnection cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiSession -Accepts a MSFT iSCSI session object as an input. -The MSFT iSCSI session object is output from the Get-IscsiSession cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -IscsiTargetPortal -Accepts a MSFT iSCSI target portal object as an input. -The MSFT iSCSI target portal object is output from the Get-IscsiTargetPortal cmdlet. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -NodeAddress -Represents the IQN of the discovered target. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Sends items from the interactive window down the pipeline as input to other cmdlets. -By default, this cmdlet does not generate any output. - - -To send items from the interactive window down the pipeline, click to select the items and then click OK. -Shift-click and Ctrl-click are supported. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_InitiatorPort -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiConnection -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiSession -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[iSCSI Target Server Overview](/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/hh848272(v=ws.11)) - -[Get-IscsiConnection](./Get-IscsiConnection.md) - -[Get-IscsiSession](./Get-IscsiSession.md) - -[Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) - -[Get-InitiatorPort](../storage/Get-InitiatorPort.md) diff --git a/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md b/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md deleted file mode 100644 index ddc700e21b..0000000000 --- a/docset/winserver2012-ps/iscsi/Update-IscsiTargetPortal.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: Iscsi_Cmdlets.xml -Module Name: iSCSI -online version: https://learn.microsoft.com/powershell/module/iscsi/update-iscsitargetportal?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-IscsiTargetPortal - -## SYNOPSIS -Updates information about the specified iSCSI target portal. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Update-IscsiTargetPortal [-TargetPortalAddress] [-AsJob] [-CimSession ] - [-InitiatorInstanceName ] [-InitiatorPortalAddress ] [-PassThru] - [-TargetPortalPortNumber ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Update-IscsiTargetPortal [-AsJob] [-CimSession ] [-InitiatorInstanceName ] - [-InitiatorPortalAddress ] [-PassThru] [-TargetPortalPortNumber ] [-ThrottleLimit ] - -InputObject -``` - -## DESCRIPTION - -The `Update-IscsiTargetPortal` cmdlet refreshes cached information about an iSCSI target portal. - -## EXAMPLES - -### Example 1: Update information about an iSCSI target portal - -This command updates information about the specified iSCSI target portal. -The first command displays target portals by using the **Get-IscsiTargetPortal** cmdlet. - -```powershell -Get-IscsiTargetPortal -``` - -```Output -InitiatorInstanceName : -InitiatorNodeAddress : -InitiatorPortalAddress : -InititorIPAdressListNumber : 4294967295 -IsDataDigest : False -IsHeaderDigest : False -TargetPortalAddress : testiSCSI-deepcore -TargetPortalPortNumber : 3260 -``` - -```powershell -Get-IscsiTargetPortal | Update-IscsiTargetPortal -``` -The second command passes the same target portals to the current cmdlet to update them. - -## PARAMETERS - -### -AsJob - -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession - -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) -or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorInstanceName - -Specifies the name of the initiator instance that the iSCSI initiator service uses to send **SendTargets** requests to the target portal. -If no instance name is specified, the iSCSI initiator service chooses the initiator instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InitiatorPortalAddress - -Specifies the IP address or DNS name that is associated with the portal. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject - -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru - -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetPortalAddress - -Specifies the IP address or DNS name of the target portal. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetPortalPortNumber - -Specifies the TCP/IP port number for the target portal. -By default, the port number is `3260`. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit - -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an -optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters - -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MSFT_IscsiTargetPortal - -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[iSCSI on TechNet](/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/ee338476(v=ws.10)) - -[Storage on TechNet](https://go.microsoft.com/fwlink/?linkid=191356) - -[Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) diff --git a/docset/winserver2012-ps/iscsi/iSCSI.md b/docset/winserver2012-ps/iscsi/iSCSI.md deleted file mode 100644 index 1cffc932d2..0000000000 --- a/docset/winserver2012-ps/iscsi/iSCSI.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.3.0.0 -Locale: en-US -Module Guid: 53e1c251-4283-4b07-ab02-fc492c7ab8c5 -Module Name: iSCSI ---- - -# iSCSI Module -## Description -This reference provides cmdlet descriptions and syntax for all iSCSI Initiator-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## iSCSI Cmdlets -### [Connect-IscsiTarget](./Connect-IscsiTarget.md) -Establishes a connection between the local iSCSI initiator, and the specified iSCSI target device. - -### [Disconnect-IscsiTarget](./Disconnect-IscsiTarget.md) -Disconnects sessions to the specified iSCSI target object. - -### [Get-IscsiConnection](./Get-IscsiConnection.md) -Gets information about connected iSCSI initiator connections. - -### [Get-IscsiSession](./Get-IscsiSession.md) -Retrieves information about established iSCSI sessions. - -### [Get-IscsiTarget](./Get-IscsiTarget.md) -Returns an iSCSI target object for each iSCSI target that is registered with the iSCSI initiator. - -### [Get-IscsiTargetPortal](./Get-IscsiTargetPortal.md) -Gives the list of target portals which have been set for discovery. - -### [New-IscsiTargetPortal](./New-IscsiTargetPortal.md) -Configures an iSCSI target portal. - -### [Register-IscsiSession](./Register-IscsiSession.md) -Registers an active iSCSI session to be persistent using the session identifier as input. - -### [Remove-IscsiTargetPortal](./Remove-IscsiTargetPortal.md) -Removes the specified iSCSI target portal. - -### [Set-IscsiChapSecret](./Set-IscsiChapSecret.md) -Sets a CHAP secret key for use with iSCSI initiator connections. - -### [Unregister-IscsiSession](./Unregister-IscsiSession.md) -Removes an active iSCSI session from being persistent using the session identifier as input. - -### [Update-IscsiTarget](./Update-IscsiTarget.md) -Refreshes the information about connected iSCSI target objects. - -### [Update-IscsiTargetPortal](./Update-IscsiTargetPortal.md) -Updates information about the specified iSCSI target portal. - diff --git a/docset/winserver2012-ps/iscsitarget/Add-IscsiVirtualDiskTargetMapping.md b/docset/winserver2012-ps/iscsitarget/Add-IscsiVirtualDiskTargetMapping.md deleted file mode 100644 index 1783d62586..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Add-IscsiVirtualDiskTargetMapping.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/add-iscsivirtualdisktargetmapping?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-IscsiVirtualDiskTargetMapping - -## SYNOPSIS -Assigns a virtual disk to an iSCSI target. - -## SYNTAX - -``` -Add-IscsiVirtualDiskTargetMapping [-TargetName] [-Path] [-Lun ] - [-ComputerName ] [-Credential ] [] -``` - -## DESCRIPTION -The **Add-IscsiVirtualDiskTargetMapping** cmdlet assigns a virtual disk to an iSCSI target. -Once a virtual disk has been assigned to a target, and after the iSCSi initiator connects to that target, the iSCSI initiator can access the virtual disk. -All of the virtual disks assigned to the same iSCSI target will be accessible by the connected iSCSI initiator. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Add-IscsiVirtualDiskTargetMapping -TargetName "TargetOne" -DevicePath "E:\Temp\vhd1.vhd" -``` - -This example associates the VHD with the path E:\Temp\vhd1.vhd to the target named TargetOne. - -### EXAMPLE 2 -``` -PS C:\> Add-IscsiVirtualDiskTargetMapping -TargetName "TargetOne" -DevicePath "E:\Temp\vhd1.vhd" -Lun 0 -``` - -This example associates the VHD with the path E:\Temp\vhd1.vhd to the target named TargetOne, and sets the LUN to 0. -It is important that theLUN number for a given target is unique. - -### EXAMPLE 3 -``` -PS C:\>Add-IscsiVirtualDiskTargetMapping -TargetName TestTarget -Path ramdisk:test -``` - -This example assigns the ramdisk called test to the target object named TestTarget. -When the initiator connects to the TestTarget, it will be able to access the RAMdisk. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Lun -Specifies the logical unit number (LUN) associated with the virtual disk. -By default, the lowest available LUN number will be assigned. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DevicePath - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Remove-IscsiVirtualDiskTargetMapping](./Remove-IscsiVirtualDiskTargetMapping.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Checkpoint-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Checkpoint-IscsiVirtualDisk.md deleted file mode 100644 index fa9d31d385..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Checkpoint-IscsiVirtualDisk.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/checkpoint-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Checkpoint-IscsiVirtualDisk - -## SYNOPSIS -Creates a virtual disk snapshot. - -## SYNTAX - -``` -Checkpoint-IscsiVirtualDisk [-Description ] [-OriginalPath] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Checkpoint-IscsiVirtualDisk** cmdlet creates a snapshot. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Checkpoint-IscsiVirtualDisk -OriginalPath "D:\VHDs\DB.vhd" -``` - -This example creates a snapshot of the VHD with the path D:\VHDs\DB.vhd. - -### EXAMPLE 2 -``` -PS C:\> Checkpoint-IscsiVirtualDisk -OriginalPath "D:\VHDs\DB.vhd" -Description "Before database merge" -ComputerName "fssvr.contoso.com" -``` - -This example creates a snapshot of the VHD with the path D:\VHDs\DB.vhd, and gives a description of the snapshot. -The operation will take place on a remote computer with the name fssvr.contoso.com. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the iSCSI virtual disk snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OriginalPath -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk to which the snapshot belongs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: Path - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Convert-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Convert-IscsiVirtualDisk.md deleted file mode 100644 index 9b5a1a535b..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Convert-IscsiVirtualDisk.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/convert-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Convert-IscsiVirtualDisk - -## SYNOPSIS -Converts an iSCSI virtual disk to a Generation one Advanced Format-aligned (4K sector technology) virtual disk. - -## SYNTAX - -``` -Convert-IscsiVirtualDisk [-Path] [-DestinationPath] [] -``` - -## DESCRIPTION -The **Convert-IscsiVirtualDisk** cmdlet converts an iSCSI virtual disk to a Generation one Advanced Format-aligned (4K sector technology) virtual disk. -If an attempt is made to load a VHD created by the previous version of the iSCSI Target in Windows Server® 2012, then the VHD must be converted by running this cmdlet. -This cmdlet performs copy and conversion at the same time. -A remote file share or local path for both source and destination path can be specified. - -Note: Use this cmdlet if iSCSI Target 3.3 differencing virtual disks are migrated to Windows Server 2012 differencing virtual disks. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Convert-IscsiVirtualDisk -Path \\zamfirsvr\VHDs\test.vhd -DestinationPath \\win8svr\VHDs\test.vhd -``` - -This example copies and converts the VHD namedtest.vhd from \\\\zamfirsvr\VHDs\ to \\\\win8svr\VHDs. -The VHD named test.vhd can be loaded after the conversion. - -## PARAMETERS - -### -DestinationPath -Specifies the destination path of the iSCSI virtual disk path to which to be copied and converted. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DevicePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Dismount-IscsiVirtualDiskSnapshot.md b/docset/winserver2012-ps/iscsitarget/Dismount-IscsiVirtualDiskSnapshot.md deleted file mode 100644 index 7b97aae565..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Dismount-IscsiVirtualDiskSnapshot.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/dismount-iscsivirtualdisksnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Dismount-IscsiVirtualDiskSnapshot - -## SYNOPSIS -Dismounts the snapshot. - -## SYNTAX - -### SnapshotId (Default) -``` -Dismount-IscsiVirtualDiskSnapshot [-SnapshotId] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Dismount-IscsiVirtualDiskSnapshot -InputObject [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Dismount-IscsiVirtualDiskSnapshot** cmdlet dismounts the snapshot. -The snapshot will not be accessible after dismount. - -## EXAMPLES - -### Example 1 -``` -PS C:\>Get-IscsiVirtualDiskSnapshot | Dismount-IscsiVirtualDiskSnapshot -``` - -This example gets all of the snapshot and dismounts them. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI virtual disk snapshot object from the input pipeline. - -```yaml -Type: IscsiVirtualDiskSnapshot -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.VirtualDiskSnapshot - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Export-IscsiVirtualDiskSnapshot](./Export-IscsiVirtualDiskSnapshot.md) - -[Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) - -[Mount-IscsiVirtualDiskSnapshot](./Mount-IscsiVirtualDiskSnapshot.md) - -[Remove-IscsiVirtualDiskSnapshot](./Remove-IscsiVirtualDiskSnapshot.md) - -[Set-IscsiVirtualDiskSnapshot](./Set-IscsiVirtualDiskSnapshot.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Expand-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Expand-IscsiVirtualDisk.md deleted file mode 100644 index 4cb6d7f36e..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Expand-IscsiVirtualDisk.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/expand-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Expand-IscsiVirtualDisk - -## SYNOPSIS -Expands an iSCSI virtual disk. - -## SYNTAX - -### Path (Default) -``` -Expand-IscsiVirtualDisk [-Path] [-Size] [-PassThru] [-ComputerName ] - [-Credential ] [] -``` - -### InputObject -``` -Expand-IscsiVirtualDisk -InputObject [-Size] [-PassThru] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Expand-IscsiVirtualDisk** cmdlet expands a virtual disk. -When the operation is online, the initiator can still access the virtual disk even while it is expanding. - -However, the initiator will not automatically see the expanded virtual disk. -To get access to the larger virtual disk, the initiator will need to use the Resize-Partition cmdlet to expand the volume hosted on the virtual disk. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Expand-IscsiVirtualDisk -Path "E:\temp\test.vhd" -Size 20GB -``` - -This example expands the virtual disk with the path E:\temp\test.vhd to 20GB. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Virtual Disk object from the input pipeline. - -```yaml -Type: IscsiVirtualDisk -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: Path -Aliases: DevicePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Size -Specifies the size of the expanded iSCSI virtual disk. -Note: This parameter takes a number and a unit as input, such as 10GB, 20MB, or 1TB. - -If this parameter is not provided, then a prompt for the input of this parameter with be displayed, as it is a required field. -At that time, the value will need to be provided in Bytes; since no unit can be entered at the prompt. - -```yaml -Type: UInt64 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## NOTES - -## RELATED LINKS - -[Resize-Partition](../storage/Resize-Partition.md) - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Export-IscsiVirtualDiskSnapshot.md b/docset/winserver2012-ps/iscsitarget/Export-IscsiVirtualDiskSnapshot.md deleted file mode 100644 index 7999d500ff..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Export-IscsiVirtualDiskSnapshot.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/export-iscsivirtualdisksnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Export-IscsiVirtualDiskSnapshot - -## SYNOPSIS -Exports an iSCSI virtual disk snapshot. - -## SYNTAX - -### SnapshotId (Default) -``` -Export-IscsiVirtualDiskSnapshot [-SnapshotId] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Export-IscsiVirtualDiskSnapshot -InputObject [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Export-IscsiVirtualDiskSnapshot** cmdlet exports a snapshot. -This cmdlet creates a Virtual Disk object and associates the snapshot with it. -Once the Virtual Disk object adds to a target, the initiator can access the snapshot. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Export-IscsiVirtualDiskSnapshot -Snapshot "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -``` - -This example exposes a snapshot with the Id {E9A5BA03-85B9-40CA-85DF-DC1695690B40} as a Virtual Disk object. -To access it, assign the virtual disk with path "\\\\?\GLOBALROOT\Device\HarddiskVolumeShadowCopy{41667F16-0FDD-11E1-BA2A-0010184F53D6}\vhd01" to a target. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline. - -```yaml -Type: IscsiVirtualDiskSnapshot -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.VirtualDiskSnapshot - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## NOTES - -## RELATED LINKS - -[Dismount-IscsiVirtualDiskSnapshot](./Dismount-IscsiVirtualDiskSnapshot.md) - -[Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) - -[Mount-IscsiVirtualDiskSnapshot](./Mount-IscsiVirtualDiskSnapshot.md) - -[Remove-IscsiVirtualDiskSnapshot](./Remove-IscsiVirtualDiskSnapshot.md) - -[Set-IscsiVirtualDiskSnapshot](./Set-IscsiVirtualDiskSnapshot.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Get-IscsiServerTarget.md b/docset/winserver2012-ps/iscsitarget/Get-IscsiServerTarget.md deleted file mode 100644 index 0bbcf285d2..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Get-IscsiServerTarget.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/get-iscsiservertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiServerTarget - -## SYNOPSIS -Obtains iSCSI targets and their associated properties. - -## SYNTAX - -### Target (Default) -``` -Get-IscsiServerTarget [-ClusterGroupName ] [[-TargetName] ] [-ComputerName ] - [-Credential ] [] -``` - -### Device -``` -Get-IscsiServerTarget [-ClusterGroupName ] [-Path ] [-ComputerName ] - [-Credential ] [] -``` - -### Initiator -``` -Get-IscsiServerTarget [-ClusterGroupName ] [-InitiatorId ] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Get-IscsiServerTarget** cmdlet obtains iSCSI targets and their associated properties from the local server or specified computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-IscsiServerTarget -``` - -This example gets the iSCSI targets on the local server. - -### EXAMPLE 2 -``` -PS C:\> Get-IscsiServerTarget -ComputerName "fs1.contoso.com" -``` - -This example gets all of the iSCSI targets on the remote server named fs1.contoso.com. - -### EXAMPLE 3 -``` -PS C:\> Get-IscsiServerTarget -ComputerName "fscluster.contoso.com" -ClusterGroupName "target1group" -``` - -This example gets all of the iSCSI targets in the resource group named target1group on the cluster named fscluster.contoso.com. - -### EXAMPLE 4 -``` -PS C:\> Get-IscsiServerTarget -Path "E:\temp\test.vhd" -``` - -This example gets the iSCSI target associated with the VHD with the path "E:\temp\test.vhd" - -### EXAMPLE 5 -``` -PS C:\> Get-IscsiServerTarget -InitiatorId "DNSName:TargetSvr.Contoso.com" -``` - -This example gets all of the iSCSI targets that have been assigned to the initiator with type DNSName, and value TargetSvr.contoso.com. - -## PARAMETERS - -### -ClusterGroupName -Specifies the name of the resource group or network within the resource group on which this cmdlet should be run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorId -Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned. - -Use this parameter to filter out the iSCSI Server Target object which can be accessed by the given iSCSI initiator. - -The format of this parameter is IdType:Value. -The acceptable values for this parameter are: DNSName, IPAddress, IPv6Address, IQN, or MACAddress. - -```yaml -Type: InitiatorId -Parameter Sets: Initiator -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Use this parameter to filter the iSCSI Target object that is associated with the virtual disks. - -```yaml -Type: String -Parameter Sets: Device -Aliases: DevicePath - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. - -Use this parameter to filter out the iSCSI Target object. - -```yaml -Type: String -Parameter Sets: Target -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiServerTarget - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiServerTarget - -## NOTES - -## RELATED LINKS - -[New-IscsiServerTarget](./New-IscsiServerTarget.md) - -[Remove-IscsiServerTarget](./Remove-IscsiServerTarget.md) - -[Set-IscsiServerTarget](./Set-IscsiServerTarget.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Get-IscsiTargetServerSetting.md b/docset/winserver2012-ps/iscsitarget/Get-IscsiTargetServerSetting.md deleted file mode 100644 index d5a2fdfc26..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Get-IscsiTargetServerSetting.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/get-iscsitargetserversetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiTargetServerSetting - -## SYNOPSIS -Gets the global settings or common configurations for an iSCSI target server. - -## SYNTAX - -``` -Get-IscsiTargetServerSetting [-ComputerName ] [-Credential ] [] -``` - -## DESCRIPTION -The **Get-IscsiTargetServerSetting** cmdlet gets the global settings or common configurations for iSCSI targets, virtual disks or snapshots. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-IscsiTargetServerSetting -ComputerName Version Portals ------------- ------- ------- -fssvr.contoso.com 6.2. {+172.21.0.1:80, ... -``` - -This example gets all of the portal entries of the local server. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Set-IscsiTargetServerSetting](./Set-IscsiTargetServerSetting.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Get-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Get-IscsiVirtualDisk.md deleted file mode 100644 index cff8aa1237..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Get-IscsiVirtualDisk.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/get-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiVirtualDisk - -## SYNOPSIS -Obtains the iSCSI virtual disks and their associated properties. - -## SYNTAX - -### Device (Default) -``` -Get-IscsiVirtualDisk [-ClusterGroupName ] [[-Path] ] [-ComputerName ] - [-Credential ] [] -``` - -### Target -``` -Get-IscsiVirtualDisk [-ClusterGroupName ] [-TargetName ] [-ComputerName ] - [-Credential ] [] -``` - -### Initiator -``` -Get-IscsiVirtualDisk [-ClusterGroupName ] [-InitiatorId ] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Get-IscsiVirtualDisk** cmdlet obtains the iSCSI virtual disks and their associated properties. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-IscsiVirtualDisk -``` - -This example gets all of the virtual disks on the local server. - -### EXAMPLE 2 -``` -PS C:\> Get-IscsiVirtualDisk -Path "E:\temp\test.vhd" -``` - -This example gets the virtual disk object with the path E:\temp\test.vhd on the local server. - -### EXAMPLE 3 -``` -PS C:\> Get-IscsiVirtualDisk -Path "E:\temp\test.vhd" -ComputerName "fscluster.contoso.com" -ClusterGroupName "target1Group" -``` - -This example gets the Virtual Disk object with the path E:\temp\test.vhd in the resource group named target1Group on cluster server named fscluster.contoso.com. - -### EXAMPLE 4 -``` -PS C:\> Get-IscsiVirtualDisk -TargetName "TargetOne" -``` - -This example gets all of the virtual disks that are associated with the target named TargetOne on the local server. - -### EXAMPLE 5 -``` -PS C:\> Get-IscsiVirtualDisk -InitiatorId "IpAddress:10.10.1.1" -``` - -This example gets all of the virtual disks on the local server that are used by the initiator with IP address 10.10.1.1. - -## PARAMETERS - -### -ClusterGroupName -Specifies the name of the resource group or network within the resource group on which this cmdlet should be run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorId -Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned. - -Use this parameter to filter out the iSCSI Virtual Disk object that can be accessed by the given iSCSI initiator. - -The format for this parameter is IdType:Value. -The acceptable values for this parameter are: DNSName, IPAddress, IPv6Address, IQN, or MACAddress. - -```yaml -Type: InitiatorId -Parameter Sets: Initiator -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: Device -Aliases: DevicePath - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. - -Use this parameter to filter out the iSCSI Virtual Disk object that are assigned to the specified iSCSI target. - -```yaml -Type: String -Parameter Sets: Target -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Get-IscsiVirtualDiskSnapshot.md b/docset/winserver2012-ps/iscsitarget/Get-IscsiVirtualDiskSnapshot.md deleted file mode 100644 index c530799720..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Get-IscsiVirtualDiskSnapshot.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/get-iscsivirtualdisksnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-IscsiVirtualDiskSnapshot - -## SYNOPSIS -Gets the properties of the iSCSI virtual disk snapshots. - -## SYNTAX - -### Device (Default) -``` -Get-IscsiVirtualDiskSnapshot [[-OriginalPath] ] [-ComputerName ] [-Credential ] - [] -``` - -### SnapshotId -``` -Get-IscsiVirtualDiskSnapshot [-SnapshotId ] [-ComputerName ] [-Credential ] - [] -``` - -## DESCRIPTION -The **Get-IscsiVirtualDiskSnapshot** cmdlet gets properties of snapshots on a iSCSI virtual disk. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-IscsiVirtualDiskSnapshot -``` - -This example gets all of the virtual disk snapshots on the local server. - -### EXAMPLE 2 -``` -PS C:\> Get-IscsiVirtualDiskSnapshot -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -``` - -This example gets all of the virtual disk snapshots with the Id {E9A5BA03-85B9-40CA-85DF-DC1695690B40} on the local server. - -### EXAMPLE 3 -``` -PS C:\> Get-IscsiVirtualDiskSnapshot -Path "E:\temp\test.vhd" -``` - -This example gets the snapshots that were taken for the virtual disk E:\temp\test.vhd. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -OriginalPath -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk to which the snapshot belongs. - -```yaml -Type: String -Parameter Sets: Device -Aliases: Path - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot - -## NOTES - -## RELATED LINKS - -[Dismount-IscsiVirtualDiskSnapshot](./Dismount-IscsiVirtualDiskSnapshot.md) - -[Export-IscsiVirtualDiskSnapshot](./Export-IscsiVirtualDiskSnapshot.md) - -[Mount-IscsiVirtualDiskSnapshot](./Mount-IscsiVirtualDiskSnapshot.md) - -[Remove-IscsiVirtualDiskSnapshot](./Remove-IscsiVirtualDiskSnapshot.md) - -[Set-IscsiVirtualDiskSnapshot](./Set-IscsiVirtualDiskSnapshot.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Import-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Import-IscsiVirtualDisk.md deleted file mode 100644 index 5e1ded39d6..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Import-IscsiVirtualDisk.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/import-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Import-IscsiVirtualDisk - -## SYNOPSIS -Adds an iSCSI Virtual Disk object using an existing virtual hard disk (VHD) file. - -## SYNTAX - -``` -Import-IscsiVirtualDisk [-Description ] [-Path] [-PassThru] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Import-IscsiVirtualDisk** cmdlet adds an iSCSI Virtual Disk object using an existing virtual hard disk (VHD) file. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Import-IscsiVirtualDisk -Path "E:\Temp\test.vhd" -Description "Migrated from fs1" -``` - -This example creates a Virtual Disk object for an existing VHD file located at E:\Temp\test.vhd and sets the Virtual Disk object description to Migrated from fs1. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the iSCSI virtual disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the VHD file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DevicePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/IscsiTarget.md b/docset/winserver2012-ps/iscsitarget/IscsiTarget.md deleted file mode 100644 index 5624122699..0000000000 --- a/docset/winserver2012-ps/iscsitarget/IscsiTarget.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: a1da990a-4dc2-4f7e-beb4-046a89b9d473 -Module Name: IscsiTarget ---- - -# IscsiTarget Module -## Description -This reference provides cmdlet descriptions and syntax for all iSCSI target service-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## IscsiTarget Cmdlets -### [Add-IscsiVirtualDiskTargetMapping](./Add-IscsiVirtualDiskTargetMapping.md) -Assigns a virtual disk to an iSCSI target. - -### [Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) -Creates a virtual disk snapshot. - -### [Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) -Converts an iSCSI virtual disk to a Generation one Advanced Format-aligned (4K sector technology) virtual disk. - -### [Dismount-IscsiVirtualDiskSnapshot](./Dismount-IscsiVirtualDiskSnapshot.md) -Dismounts the snapshot. - -### [Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) -Expands an iSCSI virtual disk. - -### [Export-IscsiVirtualDiskSnapshot](./Export-IscsiVirtualDiskSnapshot.md) -Exports an iSCSI virtual disk snapshot. - -### [Get-IscsiServerTarget](./Get-IscsiServerTarget.md) -Obtains iSCSI targets and their associated properties. - -### [Get-IscsiTargetServerSetting](./Get-IscsiTargetServerSetting.md) -Gets the global settings or common configurations for an iSCSI target server. - -### [Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) -Obtains the iSCSI virtual disks and their associated properties. - -### [Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) -Gets the properties of the iSCSI virtual disk snapshots. - -### [Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) -Adds an iSCSI Virtual Disk object using an existing virtual hard disk (VHD) file. - -### [Mount-IscsiVirtualDiskSnapshot](./Mount-IscsiVirtualDiskSnapshot.md) -Mounts an iSCSI virtual disk snapshot locally. - -### [New-IscsiServerTarget](./New-IscsiServerTarget.md) -Creates a new iSCSI Target object with the specified name. - -### [New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) -Creates an iSCSI virtual disk with the specified file path and size. - -### [Remove-IscsiServerTarget](./Remove-IscsiServerTarget.md) -Deletes the specified iSCSI target. - -### [Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) -Deletes a Virtual Disk object, without deleting the virtual hard disk (VHD) file. - -### [Remove-IscsiVirtualDiskSnapshot](./Remove-IscsiVirtualDiskSnapshot.md) -Deletes specified the iSCSI virtual disk snapshot. - -### [Remove-IscsiVirtualDiskTargetMapping](./Remove-IscsiVirtualDiskTargetMapping.md) -Removes the assignment between the specified iSCSI virtual disk and the specified iSCSI target. - -### [Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) -Restores an iSCSI virtual disk from a snapshot. - -### [Set-IscsiServerTarget](./Set-IscsiServerTarget.md) -Modifies settings for the specified iSCSI target. - -### [Set-IscsiTargetServerSetting](./Set-IscsiTargetServerSetting.md) -Sets the global settings or common configurations for an iSCSI target server. - -### [Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) -Modifies the settings for the specified iSCSI virtual disk. - -### [Set-IscsiVirtualDiskSnapshot](./Set-IscsiVirtualDiskSnapshot.md) -Sets the description for an iSCSI virtual disk snapshot. - diff --git a/docset/winserver2012-ps/iscsitarget/Mount-IscsiVirtualDiskSnapshot.md b/docset/winserver2012-ps/iscsitarget/Mount-IscsiVirtualDiskSnapshot.md deleted file mode 100644 index ba9117ff30..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Mount-IscsiVirtualDiskSnapshot.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/mount-iscsivirtualdisksnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Mount-IscsiVirtualDiskSnapshot - -## SYNOPSIS -Mounts an iSCSI virtual disk snapshot locally. - -## SYNTAX - -### SnapshotId (Default) -``` -Mount-IscsiVirtualDiskSnapshot [-SnapshotId] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Mount-IscsiVirtualDiskSnapshot -InputObject [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Mount-IscsiVirtualDiskSnapshot** cmdlet mounts a snapshot locally. - -Mounting a snapshot locally exposes the snapshot as a disk to the local computer. - -Use diskmgmt.msc or cmdlets to bring the disk online. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Mount-IscsiVirtualDiskSnapshot -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -``` - -This example mounts the snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} on the local server, which can be accessed by the backup server to perform backup. - -### EXAMPLE 2 -``` -PS C:\> Mount-IscsiVirtualDiskSnapshot -InputObject $VhdSnapshot -``` - -This example mounts the Snapshot object stored in a variable named $VhdSnapshot on the local server, which can be accessed by the backup server to perform backup. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline. - -```yaml -Type: IscsiVirtualDiskSnapshot -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.VirtualDiskSnapshot - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot - -## NOTES - -## RELATED LINKS - -[Dismount-IscsiVirtualDiskSnapshot](./Dismount-IscsiVirtualDiskSnapshot.md) - -[Export-IscsiVirtualDiskSnapshot](./Export-IscsiVirtualDiskSnapshot.md) - -[Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) - -[Remove-IscsiVirtualDiskSnapshot](./Remove-IscsiVirtualDiskSnapshot.md) - -[Set-IscsiVirtualDiskSnapshot](./Set-IscsiVirtualDiskSnapshot.md) - diff --git a/docset/winserver2012-ps/iscsitarget/New-IscsiServerTarget.md b/docset/winserver2012-ps/iscsitarget/New-IscsiServerTarget.md deleted file mode 100644 index 1ec3030089..0000000000 --- a/docset/winserver2012-ps/iscsitarget/New-IscsiServerTarget.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/new-iscsiservertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-IscsiServerTarget - -## SYNOPSIS -Creates a new iSCSI Target object with the specified name. - -## SYNTAX - -``` -New-IscsiServerTarget [-TargetName] [-InitiatorIds ] [-ClusterGroupName ] - [-ComputerName ] [-Credential ] [] -``` - -## DESCRIPTION -The **New-IscsiServerTarget** cmdlet creates a new iSCSI Target object with the specified name. -After creating a new iSCSI Target object, the target can be assigned to an iSCSI initiator, and a virtual disk can be associated with the target. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> New-IscsiServerTarget -Targetname "T1" -``` - -This example creates a target named T1 on the local server. - -### EXAMPLE 2 -``` -PS C:\> New-IscsiServerTarget -Targetname "T1" -InitiatorId IPAddress:10.10.1.1,IPAddress:10.10.1.2 -``` - -This example creates a target with the name T1 and assigns it to two initiators, with IP addresses 10.10.1.1 and 10.10.1.2. - -### EXAMPLE 3 -``` -PS C:\> New-IscsiServerTarget -Targetname "T1" -ComputerName "fscluster.contoso.com" -ClusterGroupName "Group1" -``` - -This example creates a target with the name T1 in the cluster group named Group1 on the cluster named fscluster.contoso.com. - -## PARAMETERS - -### -ClusterGroupName -Specifies the name of the resource group or network within the resource group on which this cmdlet should be run. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorIds -Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned. - -Use this parameter to filter out the iSCSI Target object that are associated with the specified initiators. - -The format of this parameter is IdType:Value. -The acceptable values for this parameter are: DNSName, IPAddress, IPv6Address, IQN, or MACAddress. - -```yaml -Type: InitiatorId[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.iSCSIServerTarget - -## NOTES - -## RELATED LINKS - -[Get-IscsiServerTarget](./Get-IscsiServerTarget.md) - -[Remove-IscsiServerTarget](./Remove-IscsiServerTarget.md) - -[Set-IscsiServerTarget](./Set-IscsiServerTarget.md) - diff --git a/docset/winserver2012-ps/iscsitarget/New-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/New-IscsiVirtualDisk.md deleted file mode 100644 index 2e3c203d10..0000000000 --- a/docset/winserver2012-ps/iscsitarget/New-IscsiVirtualDisk.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/new-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-IscsiVirtualDisk - -## SYNOPSIS -Creates an iSCSI virtual disk with the specified file path and size. - -## SYNTAX - -### Fixed (Default) -``` -New-IscsiVirtualDisk [-Description ] [-Path] [-Size] [-ComputerName ] - [-Credential ] [] -``` - -### Differencing -``` -New-IscsiVirtualDisk [-Description ] -ParentPath [-Path] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **New-IscsiVirtualDisk** cmdlet creates a new iSCSI Virtual Hard Disk (VHD) object with the specified file path and size. -After the iSCSI VHD object has been created, the virtual disk can be assigned to an iSCSI target. -Once a virtual disk has been assigned to a target, and an initiator connects to that target, the iSCSI initiator can then access the virtual disk after the initiator connects to the target. - -If the VHD file path does not exist, then a new VHD file will then be created. - -If the VHD file path exists, then the server will return an error. -Use the Import-IscsiVirtualDisk cmdlet to import existing VHDs. - -If an error is displayed during the creation of the virtual disk, please check the following conditions: - - -- An absolute file path must be specified for the **Path** and **ParentPath** parameters. - - -- The virtual disk file name must have a `.VHD` file extension. -The iSCSI software target does not support the `.VHDX` file extension in this release. - - -- The VHD file cannot be a network file, or be in a compressed, sparse, or transacted folder. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> New-IscsiVirtualDisk -Path "E:\temp\test.vhd" -Size 10GB -``` - -This example creates a fixed VHD with 10GB in size. - -### EXAMPLE 2 -``` -PS C:\> New-IscsiVirtualDisk -ParentPath "E:\temp\test.vhd" -Path "E:\temp\child\diff.vhd" -``` - -This example creates a differencing VHD, with the parent path E:\temp\test.vhd and the differencing VHD path is E:\temp\child\diff.vhd. - -### EXAMPLE 3 -``` -PS C:\> New-IscsiVirtualDisk -Path "E:\temp\test.vhd" -Size 10GB -ComputerName "iscsisvr" -``` - -This example creates a fixed VHD with the size 10GB at E:\temp\test.vhd on the computer named iscsisvr. - -### EXAMPLE 4 -``` -PS C:\>New-IscsiVirtualDisk -Path ramdisk:test -Size 20MB -``` - -This example creates a VHD with the size 20MB. -This VHD will not be saved, the VHD will be lost if the wintarget service is restarted or the system is restarted. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the iSCSI virtual disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ParentPath -Specifies the parent virtual disk path if the VHD is a differencing disk. - -```yaml -Type: String -Parameter Sets: Differencing -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the VHD file that is associated with the iSCSI virtual disk. - -If the VHD file path does not exist, then a new VHD file will then be created. - -If the VHD file path exists, then the server will return an error. -Use the Import-IscsiVirtualDisk cmdlet to import existing VHDs. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DevicePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Size -Specifies the size of the iSCSI virtual disk. -Note: This parameter takes a number and a unit as input, such as 10GB, 20MB, 1TB. - -If this parameter is not provided, then a prompt for the input of this parameter with be displayed, as it is a required field. -At that time, the value will need to be provided in Bytes; since no unit can be entered at the prompt. - -```yaml -Type: UInt64 -Parameter Sets: Fixed -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Remove-IscsiServerTarget.md b/docset/winserver2012-ps/iscsitarget/Remove-IscsiServerTarget.md deleted file mode 100644 index e96d8b6b07..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Remove-IscsiServerTarget.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/remove-iscsiservertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-IscsiServerTarget - -## SYNOPSIS -Deletes the specified iSCSI target. - -## SYNTAX - -### TargetName (Default) -``` -Remove-IscsiServerTarget [-TargetName] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Remove-IscsiServerTarget -InputObject [-ComputerName ] [-Credential ] - [] -``` - -## DESCRIPTION -The **Remove-IscsiServerTarget** cmdlet deletes an iSCSI Target object. -An iSCSI initiator cannot access the virtual disk after the target is deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-IscsiServerTarget -Targetname "TargetOne" -``` - -This example deletes the target named TargetOne on the local server. - -### EXAMPLE 2 -``` -PS C:\>$all = Get-IscsiServerTarget - - - -PS C:\>ForEach-Object -InputObject ($each in $all) -Process {Remove-IscsiServerTarget -InputObject $each} -``` - -The example deletes all of the targets on the local server. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Target object from the input pipeline. - -```yaml -Type: IscsiServerTarget -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. - -```yaml -Type: String -Parameter Sets: TargetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiServerTarget - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[ForEach-Object](https://go.microsoft.com/fwlink/p/?Linkd=113300) - -[Get-IscsiServerTarget](./Get-IscsiServerTarget.md) - -[New-IscsiServerTarget](./New-IscsiServerTarget.md) - -[Set-IscsiServerTarget](./Set-IscsiServerTarget.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDisk.md deleted file mode 100644 index 837ce38e7f..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDisk.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/remove-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-IscsiVirtualDisk - -## SYNOPSIS -Deletes a Virtual Disk object, without deleting the virtual hard disk (VHD) file. - -## SYNTAX - -### DevicePath (Default) -``` -Remove-IscsiVirtualDisk [-Path] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Remove-IscsiVirtualDisk -InputObject [-ComputerName ] [-Credential ] - [] -``` - -## DESCRIPTION -The **Remove-IscsiVirtualDisk** cmdlet deletes the iSCSI Virtual Disk object. -The virtual hard disk (VHD) file is not deleted. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-IscsiVirtualDisk -Path "E:\temp\vhd1.vhd" -``` - -This example deletes a virtual disk with the path E:\temp\vhd1.vhd. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI virtual disk object from the input pipeline. - -```yaml -Type: IscsiVirtualDisk -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the VHD file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: DevicePath -Aliases: DevicePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDiskSnapshot.md b/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDiskSnapshot.md deleted file mode 100644 index 69d5f902d3..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDiskSnapshot.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/remove-iscsivirtualdisksnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-IscsiVirtualDiskSnapshot - -## SYNOPSIS -Deletes specified the iSCSI virtual disk snapshot. - -## SYNTAX - -### SnapshotId (Default) -``` -Remove-IscsiVirtualDiskSnapshot [-SnapshotId] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Remove-IscsiVirtualDiskSnapshot -InputObject [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Remove-IscsiVirtualDiskSnapshot** cmdlet deletes the specified snapshot. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-IscsiVirtualDiskSnapshot -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -``` - -This example deletes the snapshot with the identifier (ID) {E9A5BA03-85B9-40CA-85DF-DC1695690B40}. - -### EXAMPLE 2 -``` -PS C:\> Remove-IscsiVirtualDiskSnapshot -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -ComputerName "fscluster.contoso.com" -``` - -This example deletes the snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} on the remote file server cluster named fscluster.contoso.com. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline. - -```yaml -Type: IscsiVirtualDiskSnapshot -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.VirtualDiskSnapshot - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Dismount-IscsiVirtualDiskSnapshot](./Dismount-IscsiVirtualDiskSnapshot.md) - -[Export-IscsiVirtualDiskSnapshot](./Export-IscsiVirtualDiskSnapshot.md) - -[Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) - -[Mount-IscsiVirtualDiskSnapshot](./Mount-IscsiVirtualDiskSnapshot.md) - -[Set-IscsiVirtualDiskSnapshot](./Set-IscsiVirtualDiskSnapshot.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDiskTargetMapping.md b/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDiskTargetMapping.md deleted file mode 100644 index 5f496ea765..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Remove-IscsiVirtualDiskTargetMapping.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/remove-iscsivirtualdisktargetmapping?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-IscsiVirtualDiskTargetMapping - -## SYNOPSIS -Removes the assignment between the specified iSCSI virtual disk and the specified iSCSI target. - -## SYNTAX - -``` -Remove-IscsiVirtualDiskTargetMapping [-TargetName] [-Path] [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Remove-IscsiVirtualDiskTargetMapping** cmdlet removes the assignment between a virtual disk and an iSCSI target. -The virtual disk will no longer be accessible by an iSCSI initiator once the assignment is removed. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-IscsiVirtualDiskTargetMapping -TargetName "TargetOne" -Path "E:\temp\vhd1.vhd" -``` - -This example un-assigns, or disassociates, the virtual disk at E:\temp\vhd1.vhd from the target named TargetOne. -Use Add-IscsiVirtualDiskTargetMapping to assign the virtual disk to an iSCSI target before it can be used by an iSCSI initiator. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: DevicePath - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Add-IscsiVirtualDiskTargetMapping](./Add-IscsiVirtualDiskTargetMapping.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Restore-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Restore-IscsiVirtualDisk.md deleted file mode 100644 index 4b2d822c26..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Restore-IscsiVirtualDisk.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/restore-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restore-IscsiVirtualDisk - -## SYNOPSIS -Restores an iSCSI virtual disk from a snapshot. - -## SYNTAX - -### SnapshotId (Default) -``` -Restore-IscsiVirtualDisk [-SnapshotId] [-ComputerName ] [-Credential ] - [] -``` - -### InputObject -``` -Restore-IscsiVirtualDisk -InputObject [-ComputerName ] - [-Credential ] [] -``` - -## DESCRIPTION -The **Restore-IscsiVirtualDisk** cmdlet restores an iSCSI virtual disk using its snapshot. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Restore-IscsiVirtualDisk -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -``` - -This example restores a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40}. - -### EXAMPLE 2 -``` -PS C:\> Restore-IscsiVirtualDisk -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -ComputerName "fs1.contoso.com" -``` - -This example restores a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} hosted on a computer named fs1.contoso.com. - -### EXAMPLE 3 -``` -PS C:\> Restore-IscsiVirtualDisk -InputObject $vhd1snapshot -``` - -This example uses the Get-IscsiVirtualDiskSnapshot cmdlet to retrieve a snapshot, then assigns the snapshot object to a variable named $vhd1snapshot, and finally passes it to this cmdlet to restore the virtual disk. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline. - -```yaml -Type: IscsiVirtualDiskSnapshot -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.VirtualDiskSnapshot - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Set-IscsiVirtualDisk](./Set-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Set-IscsiServerTarget.md b/docset/winserver2012-ps/iscsitarget/Set-IscsiServerTarget.md deleted file mode 100644 index 0be83ea456..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Set-IscsiServerTarget.md +++ /dev/null @@ -1,399 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/set-iscsiservertarget?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-IscsiServerTarget - -## SYNOPSIS -Modifies settings for the specified iSCSI target. - -## SYNTAX - -### TargetName (Default) -``` -Set-IscsiServerTarget [-TargetName] [-TargetIqn ] [-Description ] [-Enable ] - [-EnableChap ] [-Chap ] [-EnableReverseChap ] [-ReverseChap ] - [-MaxReceiveDataSegmentLength ] [-FirstBurstLength ] [-MaxBurstLength ] - [-ReceiveBufferCount ] [-EnforceIdleTimeoutDetection ] [-InitiatorIds ] - [-PassThru] [-ComputerName ] [-Credential ] [] -``` - -### InputObject -``` -Set-IscsiServerTarget -InputObject [-TargetIqn ] [-Description ] - [-Enable ] [-EnableChap ] [-Chap ] [-EnableReverseChap ] - [-ReverseChap ] [-MaxReceiveDataSegmentLength ] [-FirstBurstLength ] - [-MaxBurstLength ] [-ReceiveBufferCount ] [-EnforceIdleTimeoutDetection ] - [-InitiatorIds ] [-PassThru] [-ComputerName ] [-Credential ] - [] -``` - -## DESCRIPTION -The **Set-IscsiServerTarget** cmdlet modifies settings for the iSCSi target and returns the corresponding iSCSI Target object if the **PassThru** parameter is specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-IscsiServerTarget -TargetName Test -InitiatorId @() -``` - -This example removes all of the initiators that are associated with the target named Test. - -### EXAMPLE 2 -``` -PS C:\>Set-IscsiServerTarget -TargetName "TargetOne" -Description "Target for initiator Appsvr" -``` - -This example sets the description for a target named TargetOne to Target for initiator Appsvr. - -### EXAMPLE 3 -``` -PS C:\>$password = ConvertTo-SecureString -String "passwordpass" -AsPlainText -Force - - - -PS C:\>$chap = New-Object -ComObject System.Management.Automation.PSCredential("user", $password) - - - -PS C:\>Set-IscsiServerTarget -TargetName "T1" -EnableChap $true -Chap $chap -``` - -This example enables and sets the forward CHAP on a target named T1 with the credentials user and password. - -### EXAMPLE 4 -``` -PS C:\>Set-IscsiServerTarget -TargetName Test -InitiatorId "IPAddress:10.10.1.10","IPAddress:10.10.1.11" -``` - -This example assigns more IDs to the same target. - -### EXAMPLE 5 -``` -PS C:\>Set-IscsiServerTarget -TargetName Test -InitiatorId "IQN:*" -``` - -This example assigns the target to all initiators that attempt to connect to it. -Because no validation is performed the iSCSI target when an initiator makes a connection, be very cautious when using this configuration. -It is most useful when troubleshooting connection issues ─ removing the possibility of Target-Initiator assignment errors. - -## PARAMETERS - -### -Chap -Specifies the settings for CHAP user name and secret. -This parameter should be used in combination with the **EnableChap** parameter if the Chap is not enabled. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies a description for the iSCSI target. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enable -Determines whether the specified iSCSI target is enabled or disabled. - -If this parameter is set to True is specified, then the target is enabled. -If the target is already enabled, no action occurs. - -If this parameter is set to False is specified, then the target is disabled. -If the target is already disabled, no action occurs. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -EnableChap -Sets whether CHAP is enabled for the iSCSI target. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableReverseChap -Sets whether reverse CHAP is enabled for the iSCSI target. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnforceIdleTimeoutDetection -Sets whether to enforce idle timeout detection. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FirstBurstLength -Sets the length of the first burst. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InitiatorIds -Specifies the iSCSI initiator identifiers (IDs) to which the iSCSI target is assigned. - -To assign a LUN or VHD to an iSCSI initiator, an iSCSI target is first created. -After the target is assigned to the initiator, then a LUN is associated with the target. - -The format of this parameter is IdType:Value. -The acceptable values for this parameter are: DNSName, IPAddress, IPv6Address, IQN, or MACAddress. - -```yaml -Type: InitiatorId[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI target object from the input pipeline. - -```yaml -Type: IscsiServerTarget -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxBurstLength -Specifies the maximum burst length. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxReceiveDataSegmentLength -Specifies the maximum receiver data segment length. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReceiveBufferCount -Specifies the receiver buffer count. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ReverseChap -Sets the reverse CHAP user name and secret. -This parameter should be used in combination with the **EnableReverseChap** parameter if the Reverse Chap is not enabled. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetIqn -Specifies the target iSCSI Qualified Name (IQN). - -```yaml -Type: Iqn -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -TargetName -Specifies the name of the iSCSI target. -Note: The target name cannot be changed here. -This parameter can be used to filter out the iSCSI Target objects. - -```yaml -Type: String -Parameter Sets: TargetName -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiServerTarget - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiServerTarget - -## NOTES - -## RELATED LINKS - -[ConvertTo-SecureString](https://go.microsoft.com/fwlink/p/?LinkId=113291) - -[New-Object](https://go.microsoft.com/fwlink/p/?LinkId=113355) - -[Get-IscsiServerTarget](./Get-IscsiServerTarget.md) - -[New-IscsiServerTarget](./New-IscsiServerTarget.md) - -[Remove-IscsiServerTarget](./Remove-IscsiServerTarget.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Set-IscsiTargetServerSetting.md b/docset/winserver2012-ps/iscsitarget/Set-IscsiTargetServerSetting.md deleted file mode 100644 index a9358a4b62..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Set-IscsiTargetServerSetting.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/set-iscsitargetserversetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-IscsiTargetServerSetting - -## SYNOPSIS -Sets the global settings or common configurations for an iSCSI target server. - -## SYNTAX - -``` -Set-IscsiTargetServerSetting [-IP] [-Port ] [-Enable ] [-PassThru] - [-ComputerName ] [-Credential ] [] -``` - -## DESCRIPTION -The **Set-IscsiTargetServerSetting** cmdlet sets the global settings or common configurations for an iSCSI target. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-IscsiTargetServerSetting -IP 1.1.1.1 -Port 3200 -``` - -This example sets the target portal with the IP address 1.1.1.1 to use port number3200 (where the default is port number 3260). - -### EXAMPLE 2 -``` -PS C:\> Set-IscsiTargetServerSetting -IP 1.1.1.1 -Enable $false -``` - -This example disables the target portal with the IP address 1.1.1.1. - -### EXAMPLE 3 -``` -PS C:\> Set-IscsiTargetServerSetting -IP 1.1.1.1 -Port 3200 -Enable $true -``` - -This example enables the target portal with the IP address 1.1.1.1 and changes the port number to 3200. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enable -Specifies the portal state as set by the user. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IP -Specifies one or more IP addresses. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the port number to which the iSCSI target should listen. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiCommonSettings - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiTargetServerSetting - -## NOTES - -## RELATED LINKS - -[Set-IscsiTargetServerSetting](./Set-IscsiTargetServerSetting.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Set-IscsiVirtualDisk.md b/docset/winserver2012-ps/iscsitarget/Set-IscsiVirtualDisk.md deleted file mode 100644 index 6641769a53..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Set-IscsiVirtualDisk.md +++ /dev/null @@ -1,188 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/set-iscsivirtualdisk?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-IscsiVirtualDisk - -## SYNOPSIS -Modifies the settings for the specified iSCSI virtual disk. - -## SYNTAX - -### DevicePath (Default) -``` -Set-IscsiVirtualDisk [-Path] [-Description ] [-PassThru] [-Enable ] - [-ComputerName ] [-Credential ] [] -``` - -### InputObject -``` -Set-IscsiVirtualDisk -InputObject [-Description ] [-PassThru] [-Enable ] - [-ComputerName ] [-Credential ] [] -``` - -## DESCRIPTION -The **Set-IscsiVirtualDisk** cmdlet modifies the settings for a virtual disk and returns the corresponding iSCSI Virtual Disk object, if the **PassThru** parameter is specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-IscsiVirtualDisk -Path "E:\Temp\vhd1.vhd" -Description "disk for data" -``` - -This example changes the VHD description to disk for data. - -### EXAMPLE 2 -``` -PS C:\> Set-IscsiVirtualDisk -Path "E:\Temp\vhd1.vhd" -Enable $false -``` - -This example disables the VHD with the path E:\Temp\vhd1.vhd. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the iSCSI virtual disk. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Enable -Specifies that the specified iSCSI virtual disk is either enabled or disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI virtual disk object from the input pipeline. - -```yaml -Type: IscsiVirtualDisk -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the path of the virtual hard disk (VHD) file that is associated with the iSCSI virtual disk. - -Filter the iSCSI Virtual Disk object using this parameter. - -```yaml -Type: String -Parameter Sets: DevicePath -Aliases: DevicePath - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDisk - -## NOTES - -## RELATED LINKS - -[Checkpoint-IscsiVirtualDisk](./Checkpoint-IscsiVirtualDisk.md) - -[Convert-IscsiVirtualDisk](./Convert-IscsiVirtualDisk.md) - -[Expand-IscsiVirtualDisk](./Expand-IscsiVirtualDisk.md) - -[Get-IscsiVirtualDisk](./Get-IscsiVirtualDisk.md) - -[Import-IscsiVirtualDisk](./Import-IscsiVirtualDisk.md) - -[New-IscsiVirtualDisk](./New-IscsiVirtualDisk.md) - -[Remove-IscsiVirtualDisk](./Remove-IscsiVirtualDisk.md) - -[Restore-IscsiVirtualDisk](./Restore-IscsiVirtualDisk.md) - diff --git a/docset/winserver2012-ps/iscsitarget/Set-IscsiVirtualDiskSnapshot.md b/docset/winserver2012-ps/iscsitarget/Set-IscsiVirtualDiskSnapshot.md deleted file mode 100644 index 31c9cf37dd..0000000000 --- a/docset/winserver2012-ps/iscsitarget/Set-IscsiVirtualDiskSnapshot.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -external help file: Microsoft.Iscsi.Target.Commands.dll-Help.xml -Module Name: IscsiTarget -online version: https://learn.microsoft.com/powershell/module/iscsitarget/set-iscsivirtualdisksnapshot?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-IscsiVirtualDiskSnapshot - -## SYNOPSIS -Sets the description for an iSCSI virtual disk snapshot. - -## SYNTAX - -### SnapshotId (Default) -``` -Set-IscsiVirtualDiskSnapshot [-SnapshotId] [-Description ] [-PassThru] - [-ComputerName ] [-Credential ] [] -``` - -### InputObject -``` -Set-IscsiVirtualDiskSnapshot -InputObject [-Description ] [-PassThru] - [-ComputerName ] [-Credential ] [] -``` - -## DESCRIPTION -The **Set-IscsiVirtualDiskSnapshot** cmdlet sets the description for a snapshot. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Set-IscsiVirtualDiskSnapshot -SnapshotId "{E9A5BA03-85B9-40CA-85DF-DC1695690B40}" -Description "before upgrade" -``` - -This example sets a snapshot with the ID {E9A5BA03-85B9-40CA-85DF-DC1695690B40} to have the description before upgrade. - -## PARAMETERS - -### -ComputerName -Specifies the computer name, or IP address, of the remote computer, if this cmdlet is run on a remote computer. - -Specifies the cluster resource group network name, or cluster node name, if this cmdlet is run on a cluster configuration. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Credential -Specifies the credentials when connecting to a remote computer. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Description -Specifies the description for the iSCSI virtual disk snapshot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InputObject -Accepts an iSCSI Virtual Disk Snapshot object from the input pipeline. - -```yaml -Type: IscsiVirtualDiskSnapshot -Parameter Sets: InputObject -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SnapshotId -Specifies the identifier (ID) for the snapshot. - -```yaml -Type: String -Parameter Sets: SnapshotId -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Iscsi.Target.Commands.IscsiVirtualDiskSnapshot - -## NOTES - -## RELATED LINKS - -[Dismount-IscsiVirtualDiskSnapshot](./Dismount-IscsiVirtualDiskSnapshot.md) - -[Export-IscsiVirtualDiskSnapshot](./Export-IscsiVirtualDiskSnapshot.md) - -[Get-IscsiVirtualDiskSnapshot](./Get-IscsiVirtualDiskSnapshot.md) - -[Mount-IscsiVirtualDiskSnapshot](./Mount-IscsiVirtualDiskSnapshot.md) - -[Remove-IscsiVirtualDiskSnapshot](./Remove-IscsiVirtualDiskSnapshot.md) - diff --git a/docset/winserver2012-ps/kds/Add-KdsRootKey.md b/docset/winserver2012-ps/kds/Add-KdsRootKey.md deleted file mode 100644 index b14c6522ab..0000000000 --- a/docset/winserver2012-ps/kds/Add-KdsRootKey.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -external help file: Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml -Module Name: KDS -online version: https://learn.microsoft.com/powershell/module/kds/add-kdsrootkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-KdsRootKey - -## SYNOPSIS -Generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD). - -## SYNTAX - -### EffectiveTime (Default) -``` -Add-KdsRootKey [-LocalTestOnly] [[-EffectiveTime] ] [-WhatIf] [-Confirm] [] -``` - -### EffectiveImmediately -``` -Add-KdsRootKey [-LocalTestOnly] [-EffectiveImmediately] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Add-KdsRootKey** cmdlet generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD). -The Microsoft Group KdsSvc generates new group keys from the new root key. It is required to run this only once per forest. - -## EXAMPLES - -### Example 1: Generate a new root key -``` -PS C:\>Add-KdsRootKey -``` - -This example generates a new root key for the Microsoft Group KdsSvc within AD. - -### Example 2: Generate a new root key for immediate use -``` -PS C:\>Add-KdsRootKey -EffectiveImmediately -``` - -This example generates a new root key immediately and adds it to the Microsoft Group KdsSvc. - -### Example 3: Generate a new root key which takes effect on a specific date -``` -PS C:\>Add-KdsRootKey -EffectiveTime "03/06/2013" -``` - -This example generates a new root key for the Microsoft Group KdsSvc which takes effect on the specified date 03/06/2013 using the mm/dd/yyyy format. - -### Example 4: Generate a new root key on the local host only -``` -PS C:\>Add-KdsRootKey -LocalTestOnly -``` - -This example generates a new root key on the local host only. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EffectiveImmediately -Indicates that the Microsoft Group Key Distribution Service immediately uses the new root key. - -```yaml -Type: SwitchParameter -Parameter Sets: EffectiveImmediately -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EffectiveTime -Specifies the date on which the newly generated root key takes effect. -If this parameter is not specified, the default date set is 10 days after the current date. - -```yaml -Type: DateTime -Parameter Sets: EffectiveTime -Aliases: - -Required: False -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LocalTestOnly -Indicates that the new root key is generated on the local host only. -This parameter is used with the Set-KdsConfigurationSet-KdsConfiguration cmdlet to test the local server configuration. - -If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. - -If this parameter is not specified, then the cmdlet returns the identifier (ID) of the root key when the operation succeeds. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet accepts no input objects. - -## OUTPUTS - -### System.Boolean - -### System.Guid - -## NOTES - -## RELATED LINKS - -[Clear-KdsCache](./Clear-KdsCache.md) - -[Get-KdsConfiguration](./Get-KdsConfiguration.md) - -[Get-KdsRootKey](./Get-KdsRootKey.md) - -[Set-KdsConfiguration](./Set-KdsConfiguration.md) - -[Test-KdsRootKey](./Test-KdsRootKey.md) - diff --git a/docset/winserver2012-ps/kds/Clear-KdsCache.md b/docset/winserver2012-ps/kds/Clear-KdsCache.md deleted file mode 100644 index 32811c8249..0000000000 --- a/docset/winserver2012-ps/kds/Clear-KdsCache.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml -Module Name: KDS -online version: https://learn.microsoft.com/powershell/module/kds/clear-kdscache?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-KdsCache - -## SYNOPSIS -Clears the group key cache of the local computer. - -## SYNTAX - -``` -Clear-KdsCache [-CacheOwnerSid ] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Clear-KdsCache** cmdlet clears the group key cache of the local computer. - -The local computer can be either a domain controller running the Microsoft Group Key Distribution Service (KdsSvc) or a client of the Microsoft Group KdsSvc. - -## EXAMPLES - -### Example 1: Clear the group key cache -``` -PS C:\>Clear-KdsCache -``` - -This example clears the group key cache of the local computer. - -### Example 2: Clear the group key cache of a specific user -``` -PS C:\>Clear-KdsCache -CacheOwnerSid "s-1-1-0" -``` - -This example clears the group key cache of the user with SID s-1-1-0. - -## PARAMETERS - -### -CacheOwnerSid -Specifies the security identifier (SID) for the user account whose cache this cmdlet clears. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet accepts no input objects. - -## OUTPUTS - -### None -This cmdlet produces no output. - -## NOTES - -## RELATED LINKS - -[Add-KdsRootKey](./Add-KdsRootKey.md) - -[Get-KdsConfiguration](./Get-KdsConfiguration.md) - -[Get-KdsRootKey](./Get-KdsRootKey.md) - -[Set-KdsConfiguration](./Set-KdsConfiguration.md) - -[Test-KdsRootKey](./Test-KdsRootKey.md) - diff --git a/docset/winserver2012-ps/kds/Get-KdsConfiguration.md b/docset/winserver2012-ps/kds/Get-KdsConfiguration.md deleted file mode 100644 index 2b69c7b5b3..0000000000 --- a/docset/winserver2012-ps/kds/Get-KdsConfiguration.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml -Module Name: KDS -online version: https://learn.microsoft.com/powershell/module/kds/get-kdsconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-KdsConfiguration - -## SYNOPSIS -Retrieves the current configuration of the Microsoft Group Key Distribution Service (KdsSvc) from Active Directory (AD). - -## SYNTAX - -``` -Get-KdsConfiguration [] -``` - -## DESCRIPTION -The **Get-KdsConfiguration** cmdlet retrieves the current configuration of the Microsoft Group Key Distribution Service (KdsSvc) from Active Directory (AD). -The KDS configuration defines how keys are generated from the root keys. - -## EXAMPLES - -### Example 1: Retrieve the current KDS configuration -``` -PS C:\>Get-KdsConfiguration -``` - -This example retrieves the current configuration of the Microsoft Group KdsSvc from AD. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet accepts no input objects. - -## OUTPUTS - -### Microsoft.KeyDistributionService.KdsServerConfiguration -A KdsServerConfiguration object contains information such as the key derivation function (KDF) algorithm and secret agreement algorithm used in key generation. - -## NOTES - -## RELATED LINKS - -[Add-KdsRootKey](./Add-KdsRootKey.md) - -[Clear-KdsCache](./Clear-KdsCache.md) - -[Get-KdsRootKey](./Get-KdsRootKey.md) - -[Set-KdsConfiguration](./Set-KdsConfiguration.md) - -[Test-KdsRootKey](./Test-KdsRootKey.md) - diff --git a/docset/winserver2012-ps/kds/Get-KdsRootKey.md b/docset/winserver2012-ps/kds/Get-KdsRootKey.md deleted file mode 100644 index 1ea5af259e..0000000000 --- a/docset/winserver2012-ps/kds/Get-KdsRootKey.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml -Module Name: KDS -online version: https://learn.microsoft.com/powershell/module/kds/get-kdsrootkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-KdsRootKey - -## SYNOPSIS -Retrieves a list of root key values stored by the Microsoft Group Key Distribution Service (KdsSvc). - -## SYNTAX - -``` -Get-KdsRootKey [] -``` - -## DESCRIPTION -The **Get-KdsRootKey** cmdlet retrieves the following information from Active Directory (AD) for each root key: - - -- The root key identifier - - -- The root key value - - -- The Microsoft Group Key Distribution Service (KdsSvc). - -This information is required to generate the group keys distributed by the Microsoft Group KdsSvc. - -## EXAMPLES - -### Example 1: Retrieve a list of root key values -``` -PS C:\>Get-KdsRootKey -``` - -This example retrieves a list of root key values stored in AD. - -## PARAMETERS - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet accepts no input objects. - -## OUTPUTS - -### System.Collections.Generic.List`1 -A list of master root keys stored in AD. - -## NOTES - -## RELATED LINKS - -[Add-KdsRootKey](./Add-KdsRootKey.md) - -[Clear-KdsCache](./Clear-KdsCache.md) - -[Get-KdsConfiguration](./Get-KdsConfiguration.md) - -[Set-KdsConfiguration](./Set-KdsConfiguration.md) - -[Test-KdsRootKey](./Test-KdsRootKey.md) - diff --git a/docset/winserver2012-ps/kds/KDS.md b/docset/winserver2012-ps/kds/KDS.md deleted file mode 100644 index 4f46175c8d..0000000000 --- a/docset/winserver2012-ps/kds/KDS.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 176542f6-2a6b-11e0-ab18-d010e0d72085 -Module Name: KDS ---- - -# KDS Module -## Description -This reference provides cmdlet descriptions and syntax for all Key Distribution Service (KDS)-specific cmdlets. It lists the cmdlets in alphabetical order. - -## KDS Cmdlets -### [Add-KdsRootKey](./Add-KdsRootKey.md) -Generates a new root key for the Microsoft Group Key Distribution Service (KdsSvc) within Active Directory (AD). - -### [Clear-KdsCache](./Clear-KdsCache.md) -Clears the group key cache of the local computer. - -### [Get-KdsConfiguration](./Get-KdsConfiguration.md) -Retrieves the current configuration of the Microsoft Group Key Distribution Service (KdsSvc) from Active Directory (AD). - -### [Get-KdsRootKey](./Get-KdsRootKey.md) -Retrieves a list of root key values stored by the Microsoft Group Key Distribution Service (KdsSvc). - -### [Set-KdsConfiguration](./Set-KdsConfiguration.md) -Sets the configuration of Microsoft Group Key Distribution Service (KdsSvc). - -### [Test-KdsRootKey](./Test-KdsRootKey.md) -Tests the root key configuration. - diff --git a/docset/winserver2012-ps/kds/Set-KdsConfiguration.md b/docset/winserver2012-ps/kds/Set-KdsConfiguration.md deleted file mode 100644 index 4873619314..0000000000 --- a/docset/winserver2012-ps/kds/Set-KdsConfiguration.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml -Module Name: KDS -online version: https://learn.microsoft.com/powershell/module/kds/set-kdsconfiguration?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-KdsConfiguration - -## SYNOPSIS -Sets the configuration of Microsoft Group Key Distribution Service (KdsSvc). - -## SYNTAX - -### KdsConfiguration -``` -Set-KdsConfiguration [-LocalTestOnly] [-SecretAgreementPublicKeyLength ] - [-SecretAgreementPrivateKeyLength ] [-SecretAgreementParameters ] - [-SecretAgreementAlgorithm ] [-KdfParameters ] [-KdfAlgorithm ] [-WhatIf] [-Confirm] - [] -``` - -### RevertToDefault -``` -Set-KdsConfiguration [-LocalTestOnly] [-RevertToDefault] [-WhatIf] [-Confirm] [] -``` - -### InputObject -``` -Set-KdsConfiguration [-LocalTestOnly] [-InputObject] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-KdsConfiguration** cmdlet sets the configuration of Microsoft Group Key Distribution Service (KdsSvc). -This cmdlet sets the following configuration data: - - -- The key derivation function algorithm and parameters used to generate private group keys - - -- The secret agreement algorithm and parameters used to generate public group keys. - -This cmdlet also validates input by performing key derivation function tests and secret agreement tests. - -## EXAMPLES - -### Example 1: Set the configuration of Microsoft Group Key Distribution Service -``` -PS C:\>$config = Get-KdsConfiguration - - - - -PS C:\>Set-KdsConfiguration -InputObject $config -``` - -This example retrieves a server configuration object in to a variable $config using the Get-KdsConfiguration cmdlet, and passes the contents of the variable to this cmdlet. - -### Example 2: Test the configuration on the local server -``` -PS C:\>Set-KdsConfiguration -LocalTestOnly -``` - -This example tests the local server configuration. - -### Example 3: Set the key derivation function algorithm -``` -PS C:\>Set-KdsConfiguration -KdfAlgorithm "SHA-1" -``` - -This example sets the key derivation function (KDF) algorithm name to SHA-1. -This algorithm generates a private group key. - -### Example 4: Set the secret agreement algorithm -``` -PS C:\>Set-KdsConfiguration -SecretAgreementAlgorithm "ECDH" -``` - -This example sets the secret agreement algorithm name to ECDH. -This algorithm generates a public group key. - -### Example 5: Set the Group Key Distribution Service configuration to the default configuration -``` -PS C:\>Set-KdsConfiguration -RevertToDefault -``` - -This example validates that the customized group key distribution service configurations are deleted and the SID key starts to use the default configuration. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the server configuration object that contains the configuration information of the Microsoft Group KdsSvc. - -```yaml -Type: KdsServerConfiguration -Parameter Sets: InputObject -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -KdfAlgorithm -Specifies the name of the key derivation function algorithm that the key distribution server uses to generate the keys. - -```yaml -Type: String -Parameter Sets: KdsConfiguration -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -KdfParameters -Specifies the parameters for the key derivation function used to generate the group private key. -If this parameter is not specified or this parameter is set to $null, then no key derivation function parameters are needed. - -```yaml -Type: Byte[] -Parameter Sets: KdsConfiguration -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -LocalTestOnly -Indicates that the cmdlet only validates the new group key distribution service configuration on the local computer, and does not store the key in Active Directory (AD). - -If this parameter is specified, then the cmdlet returns a value that indicates whether the test passed. - -If this parameter is not specified, then the cmdlet returns the new server configuration object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RevertToDefault -Indicates that the customized service configuration is reverted to the default configuration. - -```yaml -Type: SwitchParameter -Parameter Sets: RevertToDefault -Aliases: - -Required: True -Position: Named -Default value: FALSE -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SecretAgreementAlgorithm -Specifies the name of the secret agreement algorithm used to generate a group public key. - -```yaml -Type: String -Parameter Sets: KdsConfiguration -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretAgreementParameters -Specifies the parameters for the secret agreement algorithm. -If this parameter is not specified or this parameter is set to $null, then no secret agreement algorithm parameters are needed. - -```yaml -Type: Byte[] -Parameter Sets: KdsConfiguration -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretAgreementPrivateKeyLength -Specifies the length of the private key used in the secret agreement algorithm. - -```yaml -Type: Int32 -Parameter Sets: KdsConfiguration -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SecretAgreementPublicKeyLength -Specifies the length of the public key used in the secret agreement algorithm. - -```yaml -Type: Int32 -Parameter Sets: KdsConfiguration -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### Microsoft.KeyDistributionService.KdsServerConfiguration -The KdsServerConfiguration object contains configuration information for the Microsoft Group KdsSvc. - -## OUTPUTS - -### Microsoft.KeyDistributionService.KdsServerConfiguration - -### System.Boolean - -## NOTES - -## RELATED LINKS - -[Add-KdsRootKey](./Add-KdsRootKey.md) - -[Clear-KdsCache](./Clear-KdsCache.md) - -[Get-KdsConfiguration](./Get-KdsConfiguration.md) - -[Get-KdsRootKey](./Get-KdsRootKey.md) - -[Test-KdsRootKey](./Test-KdsRootKey.md) - diff --git a/docset/winserver2012-ps/kds/Test-KdsRootKey.md b/docset/winserver2012-ps/kds/Test-KdsRootKey.md deleted file mode 100644 index 86820f8d73..0000000000 --- a/docset/winserver2012-ps/kds/Test-KdsRootKey.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -external help file: Microsoft.KeyDistributionService.Cmdlets.dll-Help.xml -Module Name: KDS -online version: https://learn.microsoft.com/powershell/module/kds/test-kdsrootkey?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-KdsRootKey - -## SYNOPSIS -Tests the root key configuration. - -## SYNTAX - -``` -Test-KdsRootKey [-KeyId] [-WhatIf] [-Confirm] [] -``` - -## DESCRIPTION -The **Test-KdsRootKey** cmdlet tests that the root key with the specified key identifier (ID) uses a valid configuration. -The test verifies generation of both new group public key and group private key. - -This cmdlet is useful for analyzing failures based on invalid root key configuration failures. - -## EXAMPLES - -### Example 1: Test the root key configuration -``` -PS C:\>Test-KdsRootKey -KeyId "4A3615F1-5A90-22E4-0B1D-1416F93D4412" -``` - -This example tests the configuration of the root key specified by key ID. - -## PARAMETERS - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -KeyId -Specifies the ID of the root key to test. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: 0 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -### None -This cmdlet accepts no input objects. - -## OUTPUTS - -### System.Boolean -The Boolean object that indicates that the root key can be used to generate derived keys. - -## NOTES - -## RELATED LINKS - -[Add-KdsRootKey](./Add-KdsRootKey.md) - -[Clear-KdsCache](./Clear-KdsCache.md) - -[Get-KdsConfiguration](./Get-KdsConfiguration.md) - -[Get-KdsRootKey](./Get-KdsRootKey.md) - -[Add-KdsRootKey](./Add-KdsRootKey.md) - diff --git a/docset/winserver2012-ps/mmagent/Disable-MMAgent.md b/docset/winserver2012-ps/mmagent/Disable-MMAgent.md deleted file mode 100644 index e277f5eaf5..0000000000 --- a/docset/winserver2012-ps/mmagent/Disable-MMAgent.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: MMAgent_Cmdlets.xml -Module Name: MMAgent -online version: https://learn.microsoft.com/powershell/module/mmagent/disable-mmagent?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-MMAgent - -## SYNOPSIS -Disables application launch prefetching, operation recorder API functionality, and page combining. - -## SYNTAX - -``` -Disable-MMAgent [-ApplicationLaunchPrefetching] [-AsJob] [-CimSession ] [-OperationAPI] - [-PageCombining] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Disable-MMAgent** cmdlet disables any or all of the following features: -- Application launch prefetching -- Operation recorder API functionality -- Page combining - -## EXAMPLES - -### Example 1: Disable application launch prefetching -``` -PS C:\> Disable-MMAgent -ApplicationLaunchPrefetching -``` - -This command disables application launch prefetching on the local computer. - -## PARAMETERS - -### -ApplicationLaunchPrefetching -Disables application launch prefetching. - -If you do not specify this parameter, application launch prefetching remains in its current state, either enabled or disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: alp - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationAPI -Disables operation recorder API functionality. - -If you do not specify this parameter, operation recorder API functionality remains in its current state, either enabled or disabled. - -For more information about the Operation Recorder API, see Operation Recorderhttp://msdn.microsoft.com/library/windows/desktop/hh437575(v=VS.85).aspx on MSDN (http://msdn.microsoft.com/library/windows/desktop/hh437575(v=VS.85).aspx) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: oa - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PageCombining -Disables page combining. - -If you do not specify this parameter, page combining remains in its current state, either enabled or disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: pc - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MMAgent](./Enable-MMAgent.md) - -[Get-MMAgent](./Get-MMAgent.md) - -[Set-MMAgent](./Set-MMAgent.md) - diff --git a/docset/winserver2012-ps/mmagent/Enable-MMAgent.md b/docset/winserver2012-ps/mmagent/Enable-MMAgent.md deleted file mode 100644 index 315e327ea5..0000000000 --- a/docset/winserver2012-ps/mmagent/Enable-MMAgent.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: MMAgent_Cmdlets.xml -Module Name: MMAgent -online version: https://learn.microsoft.com/powershell/module/mmagent/enable-mmagent?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-MMAgent - -## SYNOPSIS -Enables application launch prefetching, operation recorder API functionality, and page combining. - -## SYNTAX - -``` -Enable-MMAgent [-ApplicationLaunchPrefetching] [-AsJob] [-CimSession ] [-OperationAPI] - [-PageCombining] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Enable-MMAgent** cmdlet enables any or all of the following features: -- Application launch prefetching -- Operation recorder API functionality -- Page combining - -Specify the **ApplicationLaunchPrefetching** parameter to help improve application startup performance. -Application launch prefetching causes the memory manager agent to monitor the data and code that applications access. -The memory management agent then uses that information to preload the data and code into physical memory for subsequent startups. - -Specify the **OperationAPI** parameter to help speed up operations that repeatedly access the same file data. -Enabling this feature exposes the Windows prefetching mechanism as a public interface. - -Specify the **PageCombining** parameter to help reduce the physical memory that the operating system uses. -Page combining causes the memory manager to periodically combine pages in physical memory that have identical content. - -## EXAMPLES - -### Example 1: Enable application launch prefetching -``` -PS C:\> Enable-MMAgent -ApplicationLaunchPrefetching -``` - -This command enables application launch prefetching on the local computer. - -## PARAMETERS - -### -ApplicationLaunchPrefetching -Enables application launch prefetching. - -If you do not specify this parameter, application launch prefetching remains in its current state, either enabled or disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: alp - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OperationAPI -Enables operation recorder API functionality. - -If you do not specify this parameter, operation recorder API functionality remains in its current state, either enabled or disabled. - -For more information about the Operation Recorder API, see Operation Recorderhttp://msdn.microsoft.com/library/windows/desktop/hh437575(v=VS.85).aspx on MSDN (http://msdn.microsoft.com/library/windows/desktop/hh437575(v=VS.85).aspx) - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: oa - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PageCombining -Enables page combining. - -If you do not specify this parameter, page combining remains in its current state, either enabled or disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: pc - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MMAgent](./Get-MMAgent.md) - -[Set-MMAgent](./Set-MMAgent.md) - -[Disable-MMAgent](./Disable-MMAgent.md) - diff --git a/docset/winserver2012-ps/mmagent/Get-MMAgent.md b/docset/winserver2012-ps/mmagent/Get-MMAgent.md deleted file mode 100644 index b69afeb549..0000000000 --- a/docset/winserver2012-ps/mmagent/Get-MMAgent.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: MMAgent_Cmdlets.xml -Module Name: MMAgent -online version: https://learn.microsoft.com/powershell/module/mmagent/get-mmagent?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MMAgent - -## SYNOPSIS -Returns the state of application launch prefetching, operation API prefetching functionality, and page combining. - -## SYNTAX - -``` -Get-MMAgent [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-MMAgent** cmdlet reports whether the following features are enabled: -- Application launch prefetching -- Operation API prefetching functionality -- Page combining - -This cmdlet also returns the maximum number of prefetch files for scenarios that the operation recorder API records. - -## EXAMPLES - -### Example 1: Return the state of prefetching functionality -``` -PS C:\> Get-MMAgent -``` - -This command returns the state of application launch prefetching, operation recorder API prefetching functionality, and page combining. -This command also returns the maximum number of prefetch files for scenarios that the operation recorder API records. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#MMAgentComponents - -## NOTES - -## RELATED LINKS - -[Set-MMAgent](./Set-MMAgent.md) - -[Enable-MMAgent](./Enable-MMAgent.md) - -[Disable-MMAgent](./Disable-MMAgent.md) - diff --git a/docset/winserver2012-ps/mmagent/MMAgent.md b/docset/winserver2012-ps/mmagent/MMAgent.md deleted file mode 100644 index 05b0bccfa6..0000000000 --- a/docset/winserver2012-ps/mmagent/MMAgent.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: e1383a06-d48b-45e0-81e4-5ead146e81a8 -Module Name: MMAgent ---- - -# MMAgent Module -## Description -This reference provides cmdlet descriptions and syntax for all Memory Management Agent (MMAgent) - specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## MMAgent Cmdlets -### [Disable-MMAgent](./Disable-MMAgent.md) -Disables application launch prefetching, operation recorder API functionality, and page combining. - -### [Enable-MMAgent](./Enable-MMAgent.md) -Enables application launch prefetching, operation recorder API functionality, and page combining. - -### [Get-MMAgent](./Get-MMAgent.md) -Returns the state of application launch prefetching, operation API prefetching functionality, and page combining. - -### [Set-MMAgent](./Set-MMAgent.md) -Sets the maximum number of prefetch files for scenarios that the Operation Recorder API records. - diff --git a/docset/winserver2012-ps/mmagent/Set-MMAgent.md b/docset/winserver2012-ps/mmagent/Set-MMAgent.md deleted file mode 100644 index c3aea41be9..0000000000 --- a/docset/winserver2012-ps/mmagent/Set-MMAgent.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -external help file: MMAgent_Cmdlets.xml -Module Name: MMAgent -online version: https://learn.microsoft.com/powershell/module/mmagent/set-mmagent?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MMAgent - -## SYNOPSIS -Sets the maximum number of prefetch files for scenarios that the Operation Recorder API records. - -## SYNTAX - -``` -Set-MMAgent [-AsJob] [-CimSession ] [-ThrottleLimit ] -MaxOperationAPIFiles -``` - -## DESCRIPTION -The **Set-MMAgent** cmdlet sets the maximum number of prefetch files for scenarios that the Operation Recorder API records. -The Operation Recorder API stores prefetch files (.pf) specific to a particular Operation ID in the \Windows\Prefetch folder. - -## EXAMPLES - -### Example 1: Set the maximum number of prefetch files -``` -PS C:\> Set-MMAgent -MaxOperationAPIFiles 128 -``` - -This command sets the maximum number of prefetch files for scenarios that the Operation Recorder API records to 128. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxOperationAPIFiles -Sets the maximum number of prefetch files for scenarios that the Operation Recorder API records. -The maximum number of prefetch files must be in the range from 1 through 8192. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: moaf - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MMAgent](./Get-MMAgent.md) - -[Enable-MMAgent](./Enable-MMAgent.md) - -[Disable-MMAgent](./Disable-MMAgent.md) - diff --git a/docset/winserver2012-ps/mpio/Clear-MSDSMSupportedHW.md b/docset/winserver2012-ps/mpio/Clear-MSDSMSupportedHW.md deleted file mode 100644 index 944f8bb239..0000000000 --- a/docset/winserver2012-ps/mpio/Clear-MSDSMSupportedHW.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/clear-msdsmsupportedhw?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-MSDSMSupportedHW - -## SYNOPSIS -Removes all hardware identifiers (IDs) from the Microsoft Device Specific Module (MSDSM) supported hardware list. - -## SYNTAX - -``` -Clear-MSDSMSupportedHW [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -This **Clear-MSDSMSupportedHW** cmdlet removes all hardware identifiers (IDs) from the Microsoft Device Specific Module (MSDSM) supported hardware list. - -Note: The **Update-MPIOClaimedHW** cmdlet needs to be run to have the MPIO claiming process take effect. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Clear-MSDSMSupportedHW -``` - -This example removes all hardware IDs from the MSDSM supported hardware list. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Get-MSDSMSupportedHW](./Get-MSDSMSupportedHW.md) - -[New-MSDSMSupportedHW](./New-MSDSMSupportedHW.md) - -[Remove-MSDSMSupportedHW](./Remove-MSDSMSupportedHW.md) - -[Update-MPIOClaimedHW](./Update-MPIOClaimedHW.md) - diff --git a/docset/winserver2012-ps/mpio/Disable-MSDSMAutomaticClaim.md b/docset/winserver2012-ps/mpio/Disable-MSDSMAutomaticClaim.md deleted file mode 100644 index 1f0f6e8b90..0000000000 --- a/docset/winserver2012-ps/mpio/Disable-MSDSMAutomaticClaim.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/disable-msdsmautomaticclaim?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-MSDSMAutomaticClaim - -## SYNOPSIS -Stops MSDSM from automatically claiming SAN disks for MPIO for a bus type. - -## SYNTAX - -``` -Disable-MSDSMAutomaticClaim [-BusType] -``` - -## DESCRIPTION -The **Disable-MSDSMAutomaticClaim** cmdlet stops a Microsoft Device Specific Module (MSDSM) from automatically claiming storage area network (SAN) disks for Microsoft Multipath I/O (MPIO) for a specified bus type. - -The valid bus types are serial attached storage (SAS) and Internet Small Computer System Interface (iSCSI). -This cmdlet does not change previously claimed SAN disks. - -## EXAMPLES - -### Example 1: Disable automatic claim for iSCSI -``` -PS C:\> Disable-MSDSMAutomaticClaimSettings -BusType iSCSI -``` - -This command stops MSDSM from automatically claiming SAN disks for MPIO for iSCSI bus types. -The command does not affect previously claimed disks. - -The command does not affect the settings for an SAS bus type. -If you want to disable automatic claims for both bus types, use the cmdlet again and specify SAS. - -## PARAMETERS - -### -BusType -Specifies a bus type. -This cmdlet disables automatic claiming of SAN disks for this bus type. -The acceptable values for this parameter are: SAS and iSCSI. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MSDSMAutomaticClaim](./Enable-MSDSMAutomaticClaim.md) - -[Get-MSDSMAutomaticClaimSettings](./Get-MSDSMAutomaticClaimSettings.md) - diff --git a/docset/winserver2012-ps/mpio/Enable-MSDSMAutomaticClaim.md b/docset/winserver2012-ps/mpio/Enable-MSDSMAutomaticClaim.md deleted file mode 100644 index c6b1566b72..0000000000 --- a/docset/winserver2012-ps/mpio/Enable-MSDSMAutomaticClaim.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/enable-msdsmautomaticclaim?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-MSDSMAutomaticClaim - -## SYNOPSIS -Enables MSDSM to automatically claim SAN disks for MPIO. - -## SYNTAX - -``` -Enable-MSDSMAutomaticClaim [-BusType] -``` - -## DESCRIPTION -The **Enable-MSDSMAutomaticClaim** cmdlet enables a Microsoft Device Specific Module (MSDSM) to automatically claim storage area network (SAN) disks for Microsoft Multipath I/O (MPIO) for a bus type. - -You need to specify a valid bus type, either serial attached storage (SAS) and Internet Small Computer System Interface (iSCSI). -You can enable MSDSM to automatically claim both SAS and iSCSI disks. -Run the cmdlet twice, once for SAS, once for iSCSI. - -## EXAMPLES - -### Example 1: Enable automatic claims for iSCSI -``` -PS C:\> Enable-MSDSMAutomaticClaim -BusType iSCSI -``` - -This command enables MSDSM to automatically claim resources with an iSCSI bus type. -Specify SAS instead of iSCSI to enable for an SAS bus type. - -## PARAMETERS - -### -BusType -Specifies a bus type. -The cmdlet enables MSDSM to automatically SAN disks for this bus type. -The acceptable values for this parameter are: SAS and iSCSI. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Disable-MSDSMAutomaticClaim](./Disable-MSDSMAutomaticClaim.md) - -[Get-MSDSMAutomaticClaimSettings](./Get-MSDSMAutomaticClaimSettings.md) - diff --git a/docset/winserver2012-ps/mpio/Get-MPIOAvailableHW.md b/docset/winserver2012-ps/mpio/Get-MPIOAvailableHW.md deleted file mode 100644 index 5b23fd9992..0000000000 --- a/docset/winserver2012-ps/mpio/Get-MPIOAvailableHW.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/get-mpioavailablehw?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MPIOAvailableHW - -## SYNOPSIS -Lists devices available to the system that can be managed by the Microsoft Device Specific Module (MSDSM) for Multipath I/O (MPIO). - -## SYNTAX - -``` -Get-MPIOAvailableHW [[-VendorId] ] [[-ProductId] ] [-AsJob] [-BusType ] - [-CimSession ] [-IsMultipathed ] [-IsSPC3Supported ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **** cmdlet lists available hardware devices in the system that can be managed by the Microsoft Device Specific Module (MSDSM) for Multipath I/O (MPIO). - -Note: To add one of the devices to MSDSM supported hardware list, use the vendor identifier (ID) and product ID of the device that are outputs from this cmdlet as inputs for the New-MSDSMSupportedHW cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-MPIOAvailableHW -``` - -This example returns a list of multipath-capable devices currently connected to the system. - -### EXAMPLE 2 -``` -PS C:\>Get-MPIOAvailableHW -BusType iSCSI -``` - -This example returns a list of multipath-capable devices currently connected to the system via iSCSI. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BusType -Specifies the bus type via which the device is connected to the system. -The acceptable values for this parameter are: iSCSI, SAS, and FibreChannel. - -```yaml -Type: BusType[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IsMultipathed -Specifies that the device is currently multipath enabled by Microsoft MPIO. - -```yaml -Type: Boolean[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IsSPC3Supported -Specifies that the supported specification of the device is T10 SPC3 or later. - -```yaml -Type: Boolean[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ProductId -Specifies the product ID of the device. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorId -Specifies the vendor ID of the device. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[New-MSDSMSupportedHW](./New-MSDSMSupportedHW.md) - diff --git a/docset/winserver2012-ps/mpio/Get-MPIOSetting.md b/docset/winserver2012-ps/mpio/Get-MPIOSetting.md deleted file mode 100644 index 82757c2fc4..0000000000 --- a/docset/winserver2012-ps/mpio/Get-MPIOSetting.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/get-mpiosetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MPIOSetting - -## SYNOPSIS -Gets MPIO settings. - -## SYNTAX - -``` -Get-MPIOSetting -``` - -## DESCRIPTION -The **Get-MPIOSetting** cmdlet gets Microsoft Multipath I/O (MPIO) settings. -The settings are as follows: - -- PathVerificationState -- PathVerificationPeriod -- PDORemovePeriod -- RetryCount -- RetryInterval -- UseCustomPathRecoveryTime -- CustomPathRecoveryTime -- DiskTimeoutValue - -You can use the **Set-MPIOSetting** cmdlet to change these values. - -## EXAMPLES - -### Example 1: Get MPIO settings -``` -PS C:\>Get-MPIOSetting -PathVerificationState : Disabled - -PathVerificationPeriod : 30 - -PDORemovePeriod : 20 - -RetryCount : 3 - -RetryInterval : 1 - -UseCustomPathRecoveryTime : Disabled - -CustomPathRecoveryTime : 40 - -DiskTimeoutValue : 120 -``` - -This command gets the MPIO settings. - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-MPIOSetting](./Set-MPIOSetting.md) - diff --git a/docset/winserver2012-ps/mpio/Get-MSDSMAutomaticClaimSettings.md b/docset/winserver2012-ps/mpio/Get-MSDSMAutomaticClaimSettings.md deleted file mode 100644 index fb139d6769..0000000000 --- a/docset/winserver2012-ps/mpio/Get-MSDSMAutomaticClaimSettings.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/get-msdsmautomaticclaimsettings?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MSDSMAutomaticClaimSettings - -## SYNOPSIS -Gets the settings for MSDSM automatically claiming SAN disks for MPIO. - -## SYNTAX - -``` -Get-MSDSMAutomaticClaimSettings -``` - -## DESCRIPTION -The **Get-MSDSMAutomaticClaimSettings** cmdlet gets the settings for a Microsoft Device Specific Module (MSDSM) automatically claiming storage area network (SAN) disks for Microsoft Multipath I/O (MPIO). - -MSDSM can automatically claim serial attached storage (SAS) or Internet Small Computer System Interface (iSCSI) or both or neither. -Use the **Enable-MSDSMAutomaticClaim** cmdlet or the **Disable-MSDSMAutomaticClaim** cmdlet to change the settings. - -## EXAMPLES - -### Example 1: Get automatic claim settings -``` -PS C:\> Get-MSDSMAutomaticClaimSettings -Name Value - ----- ----- - -iSCSI False - -SAS True -``` - -This command gets the automatic claim settings for MSDSM. -In this instance, MSDSM automatically claims SAS disks, but not iSCSI disks. - -## PARAMETERS - -## INPUTS - -### none - -## OUTPUTS - -### Cim.Instance - -## NOTES - -## RELATED LINKS - -[Get-MSDSMSupportedHW](./Get-MSDSMSupportedHW.md) - -[Disable-MSDSMAutomaticClaim](./Disable-MSDSMAutomaticClaim.md) - -[Enable-MSDSMAutomaticClaim](./Enable-MSDSMAutomaticClaim.md) - diff --git a/docset/winserver2012-ps/mpio/Get-MSDSMGlobalDefaultLoadBalancePolicy.md b/docset/winserver2012-ps/mpio/Get-MSDSMGlobalDefaultLoadBalancePolicy.md deleted file mode 100644 index 14d439eeb7..0000000000 --- a/docset/winserver2012-ps/mpio/Get-MSDSMGlobalDefaultLoadBalancePolicy.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/get-msdsmglobaldefaultloadbalancepolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MSDSMGlobalDefaultLoadBalancePolicy - -## SYNOPSIS -Gets the default load balance policy for MPIO devices. - -## SYNTAX - -``` -Get-MSDSMGlobalDefaultLoadBalancePolicy -``` - -## DESCRIPTION -The **Get-MSDSMGlobalDefaultLoadBalancePolicy** cmdlet gets the default load balance policy for Microsoft Multipath I/O (MPIO) devices. -You can use the **Set-MSDSMGlobalDefaultLoadBalancePolicy** cmdlet to change the policy. -Microsoft Device Specific Module (MSDSM) applies this policy only to devices that it claims after you set the policy. - -The cmdlet returns a string that contains one of these values: - -- None. -No currently configured default load balance policy. -- FOO. -Fail Over Only. -- RR. -Round Robin. -- LQD. -Least Queue Depth. -- LB. -Least Blocks. - -## EXAMPLES - -### Example 1: Get load balance policy -``` -PS C:\> Get-MSDSMGlobalDefaultLoadBalancePolicy -RR -``` - -This command gets the global default load balance policy, in this case, RR for round robin. - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -### System.String - -## NOTES - -## RELATED LINKS - -[Set-MSDSMGlobalDefaultLoadBalancePolicy](./Set-MSDSMGlobalDefaultLoadBalancePolicy.md) - diff --git a/docset/winserver2012-ps/mpio/Get-MSDSMSupportedHW.md b/docset/winserver2012-ps/mpio/Get-MSDSMSupportedHW.md deleted file mode 100644 index 7b7fc76202..0000000000 --- a/docset/winserver2012-ps/mpio/Get-MSDSMSupportedHW.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/get-msdsmsupportedhw?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MSDSMSupportedHW - -## SYNOPSIS -Lists hardware identifiers (IDs) in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -## SYNTAX - -``` -Get-MSDSMSupportedHW [[-VendorId] ] [[-ProductId] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-MSDSMSupportedHW** cmdlet lists hardware identifiers (IDs) in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -Note: When using the **VendorID** and the **ProductID** parameters it is not required to pad the parameter values with trailing spaces like was required with MPCLAIM.EXE. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-MSDSMSupportedHW -``` - -This example gets all of the hardware IDs from the MSDSM supported hardware list. - -### EXAMPLE 2 -``` -PS C:\>Get-MSDSMSupportedHW -VendorId "VendorX" -``` - -This example gets all of the hardware IDs for which the vendor ID is VendorX from the MSDSM supported hardware list. - -### EXAMPLE 3 -``` -PS C:\>Get-MSDSMSupportedHW -ProductId "ProductY" -``` - -This example gets all of the hardware IDs for which the product ID is ProductY from the MSDSM supported hardware list. - -### EXAMPLE 4 -``` -PS C:\>Get-MSDSMSupportedHW -VendorId "VendorX" -ProductId "ProductY" -``` - -This example gets all of the hardware IDs for which the vendor ID is VendorX and the product ID is ProductY from the MSDSM supported hardware list. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Returns hardware IDs that contain the specified product ID. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorId -Return hardware IDs that contain the specified vendor ID. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Clear-MSDSMSupportedHW](./Clear-MSDSMSupportedHW.md) - -[New-MSDSMSupportedHW](./New-MSDSMSupportedHW.md) - -[Remove-MSDSMSupportedHW](./Remove-MSDSMSupportedHW.md) - diff --git a/docset/winserver2012-ps/mpio/MPIO.md b/docset/winserver2012-ps/mpio/MPIO.md deleted file mode 100644 index 0c82502d88..0000000000 --- a/docset/winserver2012-ps/mpio/MPIO.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 2fbffabe-343d-4db8-ad9e-a8943f50d096 -Module Name: MPIO ---- - -# MPIO Module -## Description -This reference provides cmdlet descriptions and syntax for all Multipath I/O (MPIO)-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## MPIO Cmdlets -### [Clear-MSDSMSupportedHW](./Clear-MSDSMSupportedHW.md) -Removes all hardware identifiers (IDs) from the Microsoft Device Specific Module (MSDSM) supported hardware list. - -### [Disable-MSDSMAutomaticClaim](./Disable-MSDSMAutomaticClaim.md) -Stops MSDSM from automatically claiming SAN disks for MPIO for a bus type. - -### [Enable-MSDSMAutomaticClaim](./Enable-MSDSMAutomaticClaim.md) -Enables MSDSM to automatically claim SAN disks for MPIO. - -### [Get-MPIOAvailableHW](./Get-MPIOAvailableHW.md) -Lists devices available to the system that can be managed by the Microsoft Device Specific Module (MSDSM) for Multipath I/O (MPIO). - -### [Get-MPIOSetting](./Get-MPIOSetting.md) -Gets MPIO settings. - -### [Get-MSDSMAutomaticClaimSettings](./Get-MSDSMAutomaticClaimSettings.md) -Gets the settings for MSDSM automatically claiming SAN disks for MPIO. - -### [Get-MSDSMGlobalDefaultLoadBalancePolicy](./Get-MSDSMGlobalDefaultLoadBalancePolicy.md) -Gets the default load balance policy for MPIO devices. - -### [Get-MSDSMSupportedHW](./Get-MSDSMSupportedHW.md) -Lists hardware identifiers (IDs) in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -### [New-MSDSMSupportedHW](./New-MSDSMSupportedHW.md) -Creates a new hardware identifier (ID) with a specific vendor ID and product ID combination in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -### [Remove-MSDSMSupportedHW](./Remove-MSDSMSupportedHW.md) -Removes a hardware identifier (ID) with the specific vendor ID and product ID combination from the Microsoft Device Specific Module (MSDSM) supported hardware list. - -### [Set-MPIOSetting](./Set-MPIOSetting.md) -Changes MPIO settings. - -### [Set-MSDSMGlobalDefaultLoadBalancePolicy](./Set-MSDSMGlobalDefaultLoadBalancePolicy.md) -Sets the default load balance policy for MPIO devices. - -### [Update-MPIOClaimedHW](./Update-MPIOClaimedHW.md) -Attempts to claim devices that are currently in the Microsoft Device Specific Module (MSDSM) supported hardware list. - diff --git a/docset/winserver2012-ps/mpio/New-MSDSMSupportedHW.md b/docset/winserver2012-ps/mpio/New-MSDSMSupportedHW.md deleted file mode 100644 index ae0eeae7ea..0000000000 --- a/docset/winserver2012-ps/mpio/New-MSDSMSupportedHW.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/new-msdsmsupportedhw?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-MSDSMSupportedHW - -## SYNOPSIS -Creates a new hardware identifier (ID) with a specific vendor ID and product ID combination in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-MSDSMSupportedHW [-VendorId] [-ProductId] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-MSDSMSupportedHW [-AsJob] [-CimSession ] [-ThrottleLimit ] [-AllApplicable] -``` - -## DESCRIPTION -The **New-MSDSMSupportedHW** cmdlet creates a new hardware identifier (ID) with a specific vendor ID and product ID combination in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -Note: Unlike MPCLAIM.exe, when specifying the vendor ID and product ID, the fields should not be padded with spaces. - -Note: The Update-MPIOClaimedHW cmdlet needs to be executed to have the Multipath I/O (MPIO) claiming process take effect. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>New-MSDSMSupportedHW -ProductID "VendorX" -VendorID "ProductY" -``` - -This example adds a new hardware identifier with vendor ID of VendorX and product ID of ProductY combination in the MSDSM supported hardware list. - -### EXAMPLE 2 -``` -PS C:\>New-MSDSMSupportedHW -AllApplicable -``` - -This example finds all applicable devices (connected to system via Fibre Channel, iSCSI, or SAS), and then adds corresponding hardware identifiers to the MSDSM supported hardware list. - -## PARAMETERS - -### -AllApplicable -Specifies that all applicable devices (connected to system via Fibre Channel, iSCSI, or SAS) will be added to the MSDSM supported hardware list. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: All - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Represents the product ID. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorId -Represents the vendor ID. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Clear-MSDSMSupportedHW](./Clear-MSDSMSupportedHW.md) - -[Get-MSDSMSupportedHW](./Get-MSDSMSupportedHW.md) - -[Remove-MSDSMSupportedHW](./Remove-MSDSMSupportedHW.md) - -[Update-MPIOClaimedHW](./Update-MPIOClaimedHW.md) - diff --git a/docset/winserver2012-ps/mpio/Remove-MSDSMSupportedHW.md b/docset/winserver2012-ps/mpio/Remove-MSDSMSupportedHW.md deleted file mode 100644 index 5aa2302be4..0000000000 --- a/docset/winserver2012-ps/mpio/Remove-MSDSMSupportedHW.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/remove-msdsmsupportedhw?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-MSDSMSupportedHW - -## SYNOPSIS -Removes a hardware identifier (ID) with the specific vendor ID and product ID combination from the Microsoft Device Specific Module (MSDSM) supported hardware list. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-MSDSMSupportedHW [-VendorId] [-ProductId] [-AsJob] [-CimSession ] - [-PassThru] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-MSDSMSupportedHW [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject -``` - -## DESCRIPTION -The **Remove-MSDSMSupportedHW** cmdlet removes a hardware identifier (ID) with the specific vendor ID and product ID combination from the Microsoft Device Specific Module (MSDSM) supported hardware list. - -Note: Unlike MPCLAIM.exe, when specifying the vendor ID and product ID, the fields should not be padded with spaces. - -Note: The Update-MPIOClaimedHW cmdlet needs to be run to have the Multipath I/O (MPIO) claiming process take effect. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-MSDSMSupportedHW -VendorId "VendorX" -ProductId "ProductY" -``` - -This example removes the combination of the vendor ID VendorX and the product ID ProductY from the MSDSM supported hardware list. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Accepts an object from the input pipeline. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Passes the object through to the pipeline. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ProductId -Represents the product ID. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VendorId -Represents the vendor ID. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Clear-MSDSMSupportedHW](./Clear-MSDSMSupportedHW.md) - -[Get-MSDSMSupportedHW](./Get-MSDSMSupportedHW.md) - -[New-MSDSMSupportedHW](./New-MSDSMSupportedHW.md) - -[Update-MPIOClaimedHW](./Update-MPIOClaimedHW.md) - diff --git a/docset/winserver2012-ps/mpio/Set-MPIOSetting.md b/docset/winserver2012-ps/mpio/Set-MPIOSetting.md deleted file mode 100644 index 805051d502..0000000000 --- a/docset/winserver2012-ps/mpio/Set-MPIOSetting.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/set-mpiosetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MPIOSetting - -## SYNOPSIS -Changes MPIO settings. - -## SYNTAX - -``` -Set-MPIOSetting [[-NewPathVerificationPeriod] ] [[-NewPathVerificationState] ] - [[-NewPDORemovePeriod] ] [[-NewRetryCount] ] [[-NewRetryInterval] ] - [[-NewDiskTimeout] ] [[-CustomPathRecovery] ] [[-NewPathRecoveryInterval] ] -``` - -## DESCRIPTION -The **Set-MPIOSetting** cmdlet changes Microsoft Multipath I/O (MPIO) settings. -The settings are as follows: - -- PathVerificationState -- PathVerificationPeriod -- PDORemovePeriod -- RetryCount -- RetryInterval -- UseCustomPathRecoveryTime -- CustomPathRecoveryTime -- DiskTimeoutValue - -You may be prompted to restart the computer for your changes to take effect. - -## EXAMPLES - -### Example 1: Change the disk timeout -``` -PS C:\>Set-MPIOSetting -NewDiskTimeout 30 -``` - -This command sets the disk timeout value to 30 seconds. -The system prompts you to restart after you change settings. - -You can use the **Get-MPIOSetting** cmdlet to verify the change. - -## PARAMETERS - -### -CustomPathRecovery -Specifies whether MPIO performs custom path recovery. -The acceptable values for this parameter are: Enabled and Disabled. -The default value is Disabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewDiskTimeout -Specifies the disk timeout value, in seconds. -This value is the length of time the server waits before it marks the I/O request as timed out. -The default value for DiskTimeoutValue is 120. -We recommend a maximum value of 30. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPathRecoveryInterval -Specifies a custom path recovery time, in seconds. -This is the length of time before the server attempts path recovery. -The default value is 40. -This parameter is not relevant unless the **CustomPathRecovery** parameter has the value Enabled. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPathVerificationPeriod -Specifies a path verification period, in seconds. -This is the length of time for the server to verify every path. -This parameter is not relevant unless the path verification state has a value of Enabled. -The default value is 30. - -You can set the path verification state by using the **NewPathVerificationState** parameter. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPathVerificationState -Specifies whether to enable path verification. -The acceptable values for this parameter are: Enabled and Disabled. -The default value is Disabled. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewPDORemovePeriod -Specifies a physical device object (PDO) removal period, in seconds. -This period is the length of time the server waits after all paths to a PDO have failed before it removes the PDO. -The default value is 20. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewRetryCount -Specifies the number of times to retry an I/O request. -The default value is three times. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewRetryInterval -Specifies a retry interval, in seconds. -This is the length of time after which the server retries a failed I/O request. -The default value is one second. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MPIOSetting](./Get-MPIOSetting.md) - diff --git a/docset/winserver2012-ps/mpio/Set-MSDSMGlobalDefaultLoadBalancePolicy.md b/docset/winserver2012-ps/mpio/Set-MSDSMGlobalDefaultLoadBalancePolicy.md deleted file mode 100644 index 735ff1bb99..0000000000 --- a/docset/winserver2012-ps/mpio/Set-MSDSMGlobalDefaultLoadBalancePolicy.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/set-msdsmglobaldefaultloadbalancepolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MSDSMGlobalDefaultLoadBalancePolicy - -## SYNOPSIS -Sets the default load balance policy for MPIO devices. - -## SYNTAX - -``` -Set-MSDSMGlobalDefaultLoadBalancePolicy [-Policy] -``` - -## DESCRIPTION -The **Set-MSDSMGlobalDefaultLoadBalancePolicy** cmdlet sets the default load balance policy for Microsoft Multipath I/O (MPIO) devices. -Microsoft Device Specific Module (MSDSM) applies this policy only to devices that it claims after you set the policy. - -Use the **Get-MSDSMGlobalDefaultLoadBalancePolicy** cmdlet to see the current default policy. - -## EXAMPLES - -### Example 1: Set round robin as default policy -``` -PS C:\> Set-MSDSMGlobalLoadBalancePolicy -Policy RR -``` - -This command sets the default load balance policy to round robin. - -### Example 2: Clear default policy -``` -PS C:\>Set-MSDSMGlobalLoadBalancePolicy -Policy None -``` - -This command clears any current configured default load balance policy. - -## PARAMETERS - -### -Policy -Specifies a default value for load balance policy. -The acceptable values for this parameter are: - -- None. -Clears any currently configured default load balance policy. -- FOO. -Fail Over Only. -- RR. -Round Robin. -- LQD. -Least Queue Depth. -- LB. -Least Blocks. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### System.String - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MSDSMGlobalDefaultLoadBalancePolicy](./Get-MSDSMGlobalDefaultLoadBalancePolicy.md) - diff --git a/docset/winserver2012-ps/mpio/Update-MPIOClaimedHW.md b/docset/winserver2012-ps/mpio/Update-MPIOClaimedHW.md deleted file mode 100644 index 0665c4a1d0..0000000000 --- a/docset/winserver2012-ps/mpio/Update-MPIOClaimedHW.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -external help file: MPIO_Cmdlets.xml -Module Name: MPIO -online version: https://learn.microsoft.com/powershell/module/mpio/update-mpioclaimedhw?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Update-MPIOClaimedHW - -## SYNOPSIS -Attempts to claim devices that are currently in the Microsoft Device Specific Module (MSDSM) supported hardware list. - -## SYNTAX - -``` -Update-MPIOClaimedHW [-AsJob] [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Update-MPIOClaimedHW** cmdlet attempts to claim devices that are currently in the Microsoft Device Specific Module (MSDSM) supported hardware list. -If this cmdlet is not successful, then it will indicate that a reboot is required. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Update-MPIOClaimedDisk -``` - -This example attempts to claim devices that are currently in the MSDSM supported hardware list. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### None - -## NOTES - -## RELATED LINKS - -[Clear-MSDSMSupportedHW](./Clear-MSDSMSupportedHW.md) - -[Get-MSDSMSupportedHW](./Get-MSDSMSupportedHW.md) - -[New-MSDSMSupportedHW](./New-MSDSMSupportedHW.md) - -[Remove-MSDSMSupportedHW](./Remove-MSDSMSupportedHW.md) - diff --git a/docset/winserver2012-ps/msdtc/Add-DtcClusterTMMapping.md b/docset/winserver2012-ps/msdtc/Add-DtcClusterTMMapping.md deleted file mode 100644 index d12ec2ca4d..0000000000 --- a/docset/winserver2012-ps/msdtc/Add-DtcClusterTMMapping.md +++ /dev/null @@ -1,204 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/add-dtcclustertmmapping?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-DtcClusterTMMapping - -## SYNOPSIS -Adds a cluster DTC mapping. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Add-DtcClusterTMMapping [-CimSession ] [-PassThru] [-ThrottleLimit ] - -ClusterResourceName -Local -Name -Service -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Add-DtcClusterTMMapping [-CimSession ] [-PassThru] [-ThrottleLimit ] - -ClusterResourceName -ExecutablePath -Local -Name -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Add-DtcClusterTMMapping [-CimSession ] [-PassThru] [-ThrottleLimit ] - -ClusterResourceName -ComPlusAppId -Local -Name -``` - -## DESCRIPTION -The **Add-DtcClusterTMMapping** cmdlet adds a cluster Distributed Transaction Coordinator (DTC) mapping. -This cmdlet is supported on clustered computers only. - -## EXAMPLES - -### Example 1: Create a cluster mapping -``` -PS C:\> Add-DtcClusterTMMapping -ClusterResourceName "DtcResource1" -ExecutablePath "C:\TestApp\App.exe" -Local $False -Name "LocalTestAppMapping" -``` - -This command creates a DTC cluster Transaction Manager (TM) mapping. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterResourceName -Specifies the name of a cluster DTC resource. -This cmdlet associates this mapping with the resource that the name specifies. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComPlusAppId -Specifies the COM+ application identifier to associate with this mapping. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutablePath -Specifies the path of the application to associate with this mapping. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -Specifies whether the application type is local. -If you specify a value of $False, the application is a clustered resource. -If the application type is local, the application maps to the Local DTC instance and the cmdlet ignores the value of the **ClusterResourceName** parameter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DTC mapping to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Specifies the name of the Windows service to associate with this mapping. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcClusterTMMapping](./Get-DtcClusterTMMapping.md) - -[Remove-DtcClusterTMMapping](./Remove-DtcClusterTMMapping.md) - -[Set-DtcClusterTMMapping](./Set-DtcClusterTMMapping.md) - diff --git a/docset/winserver2012-ps/msdtc/Complete-DtcDiagnosticTransaction.md b/docset/winserver2012-ps/msdtc/Complete-DtcDiagnosticTransaction.md deleted file mode 100644 index 329c6e6b6b..0000000000 --- a/docset/winserver2012-ps/msdtc/Complete-DtcDiagnosticTransaction.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/complete-dtcdiagnostictransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Complete-DtcDiagnosticTransaction - -## SYNOPSIS -Invokes the Commit process if the specified transaction is the root transaction; otherwise, invokes the Complete method on a transaction object. - -## SYNTAX - -``` -Complete-DtcDiagnosticTransaction [-Transaction] -``` - -## DESCRIPTION -The **Complete-DtcDiagnosticTransaction** cmdlet invokes the Commit process if the specified transaction is the root transaction; otherwise, it invokes the **Complete** method on the transaction object specified by the **DtcDiagnosticTransaction** object. - -## EXAMPLES - -### Example 1: Complete a DTC diagnostic transaction -``` -PS C:\>$Tx = New-DtcDiagnosticTransaction -PS C:\> Complete-DtcDiagnosticTransaction -Transaction $Tx -``` - -The first command creates a new DTC diagnostic transaction and assigns it to a variable. - -The second command invokes the Commit process of the transaction. - -## PARAMETERS - -### -Transaction -Specifies the **DtcDiagnosticTransaction** object on which to invoke the **Complete** method or to commit. - -```yaml -Type: DtcDiagnosticTransaction -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -### Default -Specifies the **DtcDiagnosticTransaction** object on which to invoke the **Complete** method. -You can use the pipeline operator to pass this parameter value to the cmdlet. - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[New-DtcDiagnosticTransaction](./New-DtcDiagnosticTransaction.md) - -[Receive-DtcDiagnosticTransaction](./Receive-DtcDiagnosticTransaction.md) - -[Send-DtcDiagnosticTransaction](./Send-DtcDiagnosticTransaction.md) - -[Undo-DtcDiagnosticTransaction](./Undo-DtcDiagnosticTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-Dtc.md b/docset/winserver2012-ps/msdtc/Get-Dtc.md deleted file mode 100644 index e6ba0ccc95..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-Dtc.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-Dtc - -## SYNOPSIS -Gets DTC instances. - -## SYNTAX - -``` -Get-Dtc [-CimSession ] [-DtcName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-Dtc** cmdlet gets Distributed Transaction Coordinator (DTC) instances that run on the host. -Use the **DtcName** parameter to specify a DTC instance. - -## EXAMPLES - -### Example 1: Get a DTC instance -``` -PS C:\> Get-Dtc -DtcName : Local -KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af -OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b -Status : Started -UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e -VirtualServerName : Contoso093 -XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd - -DtcName : MSDTC-Contoso093DTC1 -KtrmEndpointCid : -OleTxEndpointCid : 04c1c8e4-4810-4dc5-945b-b1cb2c9a2cc4 -Status : Started -UisEndpointCid : 9a8d3a2f-c28c-4bb6-91fd-8378492bf6a9 -VirtualServerName : Contoso093DTC1 -XAEndpointCid : 956d64a7-a307-4aaa-a5d9-10e31f6c51fa - -DtcName : MSDTC-Contoso093DTC2 -KtrmEndpointCid : -OleTxEndpointCid : ab8eacbf-7b9e-45a5-b61d-b42194d492ea -Status : Started -UisEndpointCid : bf1986e4-7c9f-455b-beba-4b8f9fb431ad -VirtualServerName : Contoso093DTC2 -XAEndpointCid : 2833ac93-f291-4fa2-b413-a7b67f7529c1 -``` - -This command gets a DTC instance. -The command does not specify the **DtcName** parameter, so the cmdlet gets the local instance. - -### Example 2: Get the local DTC instance -``` -PS C:\> Get-Dtc -DtcName "Local" -DtcName : Local -KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af -OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b -Status : Started -UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e -VirtualServerName : Contoso093 -XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd -``` - -This command gets the local DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies the DTC instance to get on the host. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet gets the local DTC instance for the host. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Install-Dtc](./Install-Dtc.md) - -[Start-Dtc](./Start-Dtc.md) - -[Stop-Dtc](./Stop-Dtc.md) - -[Test-Dtc](./Test-Dtc.md) - -[Uninstall-Dtc](./Uninstall-Dtc.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcAdvancedHostSetting.md b/docset/winserver2012-ps/msdtc/Get-DtcAdvancedHostSetting.md deleted file mode 100644 index 1790cdd726..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcAdvancedHostSetting.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtcadvancedhostsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcAdvancedHostSetting - -## SYNOPSIS -Queries the DTC host level properties in the registry. - -## SYNTAX - -``` -Get-DtcAdvancedHostSetting [-CimSession ] [-Subkey ] [-ThrottleLimit ] - -Name -``` - -## DESCRIPTION -The **Get-DtcAdvancedHostSetting** cmdlet queries the Distributed Transaction Coordinator (DTC) host level properties in the registry. -The default registry location for advanced host settings is HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSDTC. - -## EXAMPLES - -### Example 1: Query tracing setting -``` -PS C:\>Get-DtcAdvancedHostSetting -Name "TRACE_CM" -SubKey "Tracing\Sources" - -255 -``` - -This command queries the tracing setting for TRACE_CM. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the property to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subkey -Specifies the subkey name for the property to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-DtcAdvancedHostSetting](./Set-DtcAdvancedHostSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcAdvancedSetting.md b/docset/winserver2012-ps/msdtc/Get-DtcAdvancedSetting.md deleted file mode 100644 index 9196670d5f..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcAdvancedSetting.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtcadvancedsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcAdvancedSetting - -## SYNOPSIS -Queries the advanced setting for MSDTC in the registry. - -## SYNTAX - -``` -Get-DtcAdvancedSetting [-CimSession ] [-DtcName ] [-Subkey ] - [-ThrottleLimit ] -Name -``` - -## DESCRIPTION -The **Get-DtcAdvancedSetting** cmdlet gets the advanced setting for Microsoft Distributed Transaction Coordinator (MSDTC). -Use this cmdlet to query the advanced setting information stored in the registry. -You can query only one registry value at one time. -Specify a DTC instance by using the **DtcName** parameter. -If you do not specify an instance, the default value is Local. -The default registry location for advanced settings is HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\MSDTC. - -## EXAMPLES - -### Example 1: Query an advanced setting -``` -PS C:\>Get-DtcAdvancedSetting -Name "AccountName" -DtcName "Local" -Subkey "Security" - -NT AUTHORITY\NetworkService -``` - -This command gets the account name used by the local MSDTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies the DTC instance for which to retrieve the DTC instance specific properties. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the property to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subkey -Specifies the subkey name for the property to get. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-DtcAdvancedSetting](./Set-DtcAdvancedSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcClusterDefault.md b/docset/winserver2012-ps/msdtc/Get-DtcClusterDefault.md deleted file mode 100644 index b1e3176d1c..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcClusterDefault.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtcclusterdefault?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcClusterDefault - -## SYNOPSIS -Retrieves the default cluster server. - -## SYNTAX - -``` -Get-DtcClusterDefault [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcClusterDefault** cmdlet retrieves the default cluster server. -This cmdlet is supported on clustered computers only. - -## EXAMPLES - -### Example 1: Get default cluster resource name -``` -PS C:\>Get-DtcClusterDefault - -MSDTC-DTC-87314257DTC6 -``` - -This command gets the default cluster resource name. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-DtcClusterDefault](./Set-DtcClusterDefault.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcClusterTMMapping.md b/docset/winserver2012-ps/msdtc/Get-DtcClusterTMMapping.md deleted file mode 100644 index 9e938834fa..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcClusterTMMapping.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtcclustertmmapping?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcClusterTMMapping - -## SYNOPSIS -Gets cluster DTC Mapping data. - -## SYNTAX - -``` -Get-DtcClusterTMMapping [-CimSession ] [-Name ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcClusterTMMapping** cmdlet gets cluster Distributed Transaction Coordinator (DTC) Mapping data. -If you do not specify the **Name** parameter, the cmdlet gets all cluster Transaction Manager (TM) mapping data. -This cmdlet is supported on clustered computers only. - -## EXAMPLES - -### Example 1: Get cluster mapping -``` -PS C:\>Get-DtcClusterTMMapping -Name "TestMapping" -``` - -This example get the cluster DTC TM mapping for the **MappingName** TestMapping. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the **MappingName**. -If you do not specify this parameter, the cmdlet gets all TM mappings. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### DtcClusterTMMapping -This cmdlet returns a **DtcClusterTMMapping** object that contains the specified **MappingName** value. -If you do not specify a **MappingName**, this cmdlet gets all mappings. - -## NOTES - -## RELATED LINKS - -[Add-DtcClusterTMMapping](./Add-DtcClusterTMMapping.md) - -[Remove-DtcClusterTMMapping](./Remove-DtcClusterTMMapping.md) - -[Set-DtcClusterTMMapping](./Set-DtcClusterTMMapping.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcDefault.md b/docset/winserver2012-ps/msdtc/Get-DtcDefault.md deleted file mode 100644 index a7b3f9acc2..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcDefault.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtcdefault?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcDefault - -## SYNOPSIS -Gets the default DTC instance. - -## SYNTAX - -``` -Get-DtcDefault [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcDefault** cmdlet gets the default Distributed Transaction Coordinator (DTC) instance that runs on the host. - -## EXAMPLES - -### Example 1: Get the default DTC -``` -PS C:\>Get-DtcDefault - -TestMachine17 -``` - -This command queries the default DTC server name. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### String -This cmdlet returns the computer name of the default transactions coordinator. - -## NOTES - -## RELATED LINKS - -[Set-DtcDefault](./Set-DtcDefault.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcLog.md b/docset/winserver2012-ps/msdtc/Get-DtcLog.md deleted file mode 100644 index b5ad520d67..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcLog.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtclog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcLog - -## SYNOPSIS -Gets DTC log file settings. - -## SYNTAX - -``` -Get-DtcLog [-CimSession ] [-DtcName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcLog** cmdlet gets the log file settings for a Distributed Transaction Coordinator (DTC) instance. -Use the **DtcName** parameter to specify a DTC instance. - -## EXAMPLES - -### Example 1: Get the log file settings for the local DTC instance -``` -PS C:\> Get-DtcLog -MaxSizeInMB : 512 -Path : C:\Windows\system32\MSDtc -SizeInMB : 4 -``` - -This command gets the DTC log file settings for the local DTC instance. - -### Example 2: Get the log file settings for a specified DTC instance -``` -PS C:\> Get-DtcLog -DtcName "InstanceName" -MaxSizeInMB : 512 -Path : G:\MSDTC\beb6d145-405e-47cd-b326-a5505a461229 -SizeInMB : 4 -``` - -This command gets the DTC log file settings for the specified DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet displays log file settings for this instance. -If you do not specify this parameter, or if you specify a value of Local, the log file settings for the local DTC instance are displayed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Reset-DtcLog](./Reset-DtcLog.md) - -[Set-DtcLog](./Set-DtcLog.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcNetworkSetting.md b/docset/winserver2012-ps/msdtc/Get-DtcNetworkSetting.md deleted file mode 100644 index d8ca912e9c..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcNetworkSetting.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtcnetworksetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcNetworkSetting - -## SYNOPSIS -Gets DTC network and security configuration settings. - -## SYNTAX - -``` -Get-DtcNetworkSetting [-CimSession ] [-DtcName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcNetworkSetting** cmdlet gets the Distributed Transaction Coordinator (DTC) network and security configuration settings for a DTC instance. -Use the **DtcName** parameter to specify a DTC instance. - -## EXAMPLES - -### Example 1: Get network and security configuration settings for the local DTC instance -``` -PS C:\> Get-DtcNetworkSetting -DtcName "Local" -AuthenticationLevel : Mutual -InboundTransactionsEnabled : True -LUTransactionsEnabled : True -OutboundTransactionsEnabled : True -RemoteAdministrationAccessEnabled : True -RemoteClientAccessEnabled : True -XATransactionsEnabled : True -``` - -This command gets the network and security configuration settings for the local DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet gets network and security configuration settings for this instance. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet returns the DTC network and security configuration settings for the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-DtcNetworkSetting](./Set-DtcNetworkSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcTransaction.md b/docset/winserver2012-ps/msdtc/Get-DtcTransaction.md deleted file mode 100644 index 96e1ce5eed..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcTransaction.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtctransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcTransaction - -## SYNOPSIS -Gets information about transactions being handled by the DTC instance. - -## SYNTAX - -``` -Get-DtcTransaction [-CimSession ] [-DtcName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcTransaction** cmdlet gets information about transactions being handled by the Distributed Transaction Coordinator (DTC) instance. -Use the **DtcName** parameter to specify the DTC instance. - -## EXAMPLES - -### Example 1: Get DTC transactions -``` -PS C:\>Get-DtcTransaction -DtcName "Local" -TransactionId : b61f99fd-3c83-451c-9d92-4e790ca59585 -Description : xxxxxxxxxx -State : Active -IsolationLevel : 0 -Parent : -``` - -This command queries the transactions handled by the local DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet gets transaction information for this DTC instance. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet gets the information for transactions handled by the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-DtcTransaction](./Set-DtcTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcTransactionsStatistics.md b/docset/winserver2012-ps/msdtc/Get-DtcTransactionsStatistics.md deleted file mode 100644 index 729c93317d..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcTransactionsStatistics.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtctransactionsstatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcTransactionsStatistics - -## SYNOPSIS -Gets a summary of transactions. - -## SYNTAX - -``` -Get-DtcTransactionsStatistics [-CimSession ] [-DtcName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcTransactionsStatistics** cmdlet gets a summary of transactions being handled by the Distributed Transaction Coordinator (DTC) instance specified by the **DtcName** parameter. - -## EXAMPLES - -### Example 1: Get DTC transactions statistics -``` -PS C:\>Get-DtcTransactionsStatistics -DtcName "Local" -Open : 1 -Committed : 0 -Aborted : 0 -ForcedAbort : 0 -InDoubt : 0 -Heuristic : 0 -SinglePhaseInDoubt : 0 -OpenMax : 1 -CommittedMax : 0 -AbortedMax : 0 -InDoubtMax : 0 -HeuristicMax : 0 -``` - -This command gets the summary of transactions handled by the Local DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet gets the summary of transactions for this DTC instance. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet displays the summary of transactions handled by the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcTransactionsTraceSession.md b/docset/winserver2012-ps/msdtc/Get-DtcTransactionsTraceSession.md deleted file mode 100644 index 7241efc1b7..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcTransactionsTraceSession.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtctransactionstracesession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcTransactionsTraceSession - -## SYNOPSIS -Gets the DTC transactions trace session specific setting of the host. - -## SYNTAX - -``` -Get-DtcTransactionsTraceSession [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcTransactionsTraceSession** cmdlet gets the Distributed Transaction Coordinator (DTC) transactions trace session specific setting of the host. -All DTC instances on a single host share trace settings. - -## EXAMPLES - -### Example 1: Get DTC transactions trace session -``` -PS C:\>Get-DtcTransactionsTraceSession -BufferCount SessionStatus PSComputerName ------------ ------------- -------------- -25 Stopped -``` - -This command queries the summary of transactions trace session on the local host. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### DtcTransactionsTraceSession -This cmdlet returns a **DtcTransactionsTraceSession** object that contains trace setting information. - -## NOTES - -## RELATED LINKS - -[Set-DtcTransactionsTraceSession](./Set-DtcTransactionsTraceSession.md) - -[Start-DtcTransactionsTraceSession](./Start-DtcTransactionsTraceSession.md) - -[Stop-DtcTransactionsTraceSession](./Stop-DtcTransactionsTraceSession.md) - -[Write-DtcTransactionsTraceSession](./Write-DtcTransactionsTraceSession.md) - diff --git a/docset/winserver2012-ps/msdtc/Get-DtcTransactionsTraceSetting.md b/docset/winserver2012-ps/msdtc/Get-DtcTransactionsTraceSetting.md deleted file mode 100644 index b4d87bf644..0000000000 --- a/docset/winserver2012-ps/msdtc/Get-DtcTransactionsTraceSetting.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/get-dtctransactionstracesetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-DtcTransactionsTraceSetting - -## SYNOPSIS -Gets the DTC transactions trace setting of the host. - -## SYNTAX - -``` -Get-DtcTransactionsTraceSetting [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-DtcTransactionsTraceSetting** cmdlet gets the Distributed Transaction Coordinator (DTC) transactions trace setting of the host. -Trace settings are shared by all DTC instances on a single host. - -## EXAMPLES - -### Example 1: Get DTC transactions trace setting -``` -PS C:\>Get-DtcTransactionsTraceSetting -AbortedTransactionsTracingEnabled AllTransactionsTracingEnabled LongLivedTransactionsTracingEnabled PSComputerName ---------------------------------- ----------------------------- ----------------------------------- -------------- -True False True -``` - -This command queries the transactions trace setting on the local host. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### DtcTransactionsTraceSettings -This cmdlet returns an object of DtcTransactionsTraceSettings containing the trace settings information. - -## NOTES - -## RELATED LINKS - -[Set-DtcTransactionsTraceSetting](./Set-DtcTransactionsTraceSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Install-Dtc.md b/docset/winserver2012-ps/msdtc/Install-Dtc.md deleted file mode 100644 index 381650cb69..0000000000 --- a/docset/winserver2012-ps/msdtc/Install-Dtc.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/install-dtc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Install-Dtc - -## SYNOPSIS -Installs the local transactions coordinator. - -## SYNTAX - -``` -Install-Dtc [-CimSession ] [-LogPath ] [-StartType] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Install-Dtc** cmdlet installs the local transactions coordinator. - -## EXAMPLES - -### Example 1: Install DTC -``` -PS C:\>Install-Dtc -LogPath "C:\log" -StartType "AutoStart" -``` - -This command installs local DTC. -The command specifies AutoStart as the start type. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LogPath -Specifies the path of the log file. -If not specified, this cmdlet uses the default log path. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -StartType -Specifies the start type for the local transactions coordinator. -The acceptable values for this parameter are: - -- AutoStart -- DemandStart -- Disabled - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: BootStart, SystemStart, AutoStart, DemandStart, Disabled - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-Dtc](./Get-Dtc.md) - -[Start-Dtc](./Start-Dtc.md) - -[Stop-Dtc](./Stop-Dtc.md) - -[Test-Dtc](./Test-Dtc.md) - -[Uninstall-Dtc](./Uninstall-Dtc.md) - diff --git a/docset/winserver2012-ps/msdtc/Join-DtcDiagnosticResourceManager.md b/docset/winserver2012-ps/msdtc/Join-DtcDiagnosticResourceManager.md deleted file mode 100644 index 6c85b5fa88..0000000000 --- a/docset/winserver2012-ps/msdtc/Join-DtcDiagnosticResourceManager.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/join-dtcdiagnosticresourcemanager?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Join-DtcDiagnosticResourceManager - -## SYNOPSIS -Enlists a diagnostic Resource Manager for a transaction object. - -## SYNTAX - -``` -Join-DtcDiagnosticResourceManager [-Transaction] [[-ComputerName] ] - [[-Port] ] [-Volatile] -``` - -## DESCRIPTION -The **Join-DtcDiagnosticResourceManager** cmdlet enlists a diagnostic Resource Manager (RM) for a specified transaction object. -The transaction first needs to be sent to the RM. - -## EXAMPLES - -### Example 1: Enlist a new diagnostic transaction -``` -PS C:\>$Transaction = New-DtcDiagnosticTransaction -PS C:\> Join-DtcDiagnosticResourceManager -Transaction $Transaction -``` - -The first command creates a transaction by using the New-DtcDiagnosticTransaction cmdlet, and then stores that transaction in the **$Transaction** variable. - -The second command enlists the transaction stored in **$Transaction** to a diagnostic resource manager. - -## PARAMETERS - -### -ComputerName -Specifies the host name of the computer on which the RM runs. -If you do not specify a host name, this cmdlet uses the name of the local computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the listening port of the test RM. -If you do not specify a port number, this cmdlet uses the name of the local computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transaction -Specifies the transaction object on which to enlist the RM. - -```yaml -Type: DtcDiagnosticTransaction -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Volatile -Indicates that this cmdlet makes a volatile enlistment. -If you do not specify this parameter, the cmdlet makes a durable enlistment. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Start-DtcDiagnosticResourceManager](./Start-DtcDiagnosticResourceManager.md) - -[Stop-DtcDiagnosticResourceManager](./Stop-DtcDiagnosticResourceManager.md) - -[New-DtcDiagnosticTransaction](./New-DtcDiagnosticTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/MsDTC.md b/docset/winserver2012-ps/msdtc/MsDTC.md deleted file mode 100644 index 18f78d484b..0000000000 --- a/docset/winserver2012-ps/msdtc/MsDTC.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 4.0.4.0 -Locale: en-US -Module Guid: 52923875-f2e3-4ad2-8e0c-96c7b10e2e3d -Module Name: MsDTC ---- - -# MsDTC Module -## Description -This reference provides information about the Windows PowerShell cmdlets provided with Microsoft Distributed Transaction Coordinator (MSDTC). The cmdlet help topics in this section are in alphabetical order. - -## MsDTC Cmdlets -### [Add-DtcClusterTMMapping](./Add-DtcClusterTMMapping.md) -Adds a cluster DTC mapping. - -### [Complete-DtcDiagnosticTransaction](./Complete-DtcDiagnosticTransaction.md) -Invokes the Commit process if the specified transaction is the root transaction; otherwise, invokes the Complete method on a transaction object. - -### [Get-Dtc](./Get-Dtc.md) -Gets DTC instances. - -### [Get-DtcAdvancedHostSetting](./Get-DtcAdvancedHostSetting.md) -Queries the DTC host level properties in the registry. - -### [Get-DtcAdvancedSetting](./Get-DtcAdvancedSetting.md) -Queries the advanced setting for MSDTC in the registry. - -### [Get-DtcClusterDefault](./Get-DtcClusterDefault.md) -Retrieves the default cluster server. - -### [Get-DtcClusterTMMapping](./Get-DtcClusterTMMapping.md) -Gets cluster DTC Mapping data. - -### [Get-DtcDefault](./Get-DtcDefault.md) -Gets the default DTC instance. - -### [Get-DtcLog](./Get-DtcLog.md) -Gets DTC log file settings. - -### [Get-DtcNetworkSetting](./Get-DtcNetworkSetting.md) -Gets DTC network and security configuration settings. - -### [Get-DtcTransaction](./Get-DtcTransaction.md) -Gets information about transactions being handled by the DTC instance. - -### [Get-DtcTransactionsStatistics](./Get-DtcTransactionsStatistics.md) -Gets a summary of transactions. - -### [Get-DtcTransactionsTraceSession](./Get-DtcTransactionsTraceSession.md) -Gets the DTC transactions trace session specific setting of the host. - -### [Get-DtcTransactionsTraceSetting](./Get-DtcTransactionsTraceSetting.md) -Gets the DTC transactions trace setting of the host. - -### [Install-Dtc](./Install-Dtc.md) -Installs the local transactions coordinator. - -### [Join-DtcDiagnosticResourceManager](./Join-DtcDiagnosticResourceManager.md) -Enlists a diagnostic Resource Manager for a transaction object. - -### [New-DtcDiagnosticTransaction](./New-DtcDiagnosticTransaction.md) -Creates a new transaction in a Transaction Manager on the local computer. - -### [Receive-DtcDiagnosticTransaction](./Receive-DtcDiagnosticTransaction.md) -Propagates a transaction from a given diagnostic Resource Manager. - -### [Remove-DtcClusterTMMapping](./Remove-DtcClusterTMMapping.md) -Removes a cluster DTC mapping. - -### [Reset-DtcLog](./Reset-DtcLog.md) -Resets the log file of a DTC instance. - -### [Send-DtcDiagnosticTransaction](./Send-DtcDiagnosticTransaction.md) -Propagates a transaction to a specified diagnostic Resource Manager. - -### [Set-DtcAdvancedHostSetting](./Set-DtcAdvancedHostSetting.md) -Sets the DTC host level properties in the registry. - -### [Set-DtcAdvancedSetting](./Set-DtcAdvancedSetting.md) -Sets DTC instance specific properties in the registry. - -### [Set-DtcClusterDefault](./Set-DtcClusterDefault.md) -Sets the cluster default transactions coordinator. - -### [Set-DtcClusterTMMapping](./Set-DtcClusterTMMapping.md) -Modifies an existing cluster DTC mapping. - -### [Set-DtcDefault](./Set-DtcDefault.md) -Sets the default transactions coordinator. - -### [Set-DtcLog](./Set-DtcLog.md) -Modifies the log file settings of a DTC instance. - -### [Set-DtcNetworkSetting](./Set-DtcNetworkSetting.md) -Modifies DTC network and security configuration for a DTC instance. - -### [Set-DtcTransaction](./Set-DtcTransaction.md) -Modifies the state of a transaction. - -### [Set-DtcTransactionsTraceSession](./Set-DtcTransactionsTraceSession.md) -Modifies the DTC transactions trace setting of the host. - -### [Set-DtcTransactionsTraceSetting](./Set-DtcTransactionsTraceSetting.md) -Modifies the DTC transactions trace setting of the host. - -### [Start-Dtc](./Start-Dtc.md) -Starts the DTC instance. - -### [Start-DtcDiagnosticResourceManager](./Start-DtcDiagnosticResourceManager.md) -Starts a diagnostic Resource Manager. - -### [Start-DtcTransactionsTraceSession](./Start-DtcTransactionsTraceSession.md) -Starts a new DTC transactions trace session for the host. - -### [Stop-Dtc](./Stop-Dtc.md) -Stops a DTC instance. - -### [Stop-DtcDiagnosticResourceManager](./Stop-DtcDiagnosticResourceManager.md) -Stops and removes a diagnostic Resource Manager job. - -### [Stop-DtcTransactionsTraceSession](./Stop-DtcTransactionsTraceSession.md) -Stops the active DTC transactions trace session on the host. - -### [Test-Dtc](./Test-Dtc.md) -Tests whether two computers can participate in networked transactions. - -### [Undo-DtcDiagnosticTransaction](./Undo-DtcDiagnosticTransaction.md) -Invokes the Abort process on the specified transaction. - -### [Uninstall-Dtc](./Uninstall-Dtc.md) -Uninstalls the local transactions coordinator. - -### [Write-DtcTransactionsTraceSession](./Write-DtcTransactionsTraceSession.md) -Writes the data from an active DTC transactions trace session into the log file. - diff --git a/docset/winserver2012-ps/msdtc/New-DtcDiagnosticTransaction.md b/docset/winserver2012-ps/msdtc/New-DtcDiagnosticTransaction.md deleted file mode 100644 index d9c99468ae..0000000000 --- a/docset/winserver2012-ps/msdtc/New-DtcDiagnosticTransaction.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/new-dtcdiagnostictransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-DtcDiagnosticTransaction - -## SYNOPSIS -Creates a new transaction in a Transaction Manager on the local computer. - -## SYNTAX - -``` -New-DtcDiagnosticTransaction [[-Timeout] ] [-IsolationLevel] -``` - -## DESCRIPTION -The **New-DtcDiagnosticTransaction** cmdlet creates a new transaction in a Transaction Manager (TM) on the local computer. -By default it creates a transaction on the default transaction manager on the local computer. -This cmdlet returns a transaction object that you can pass to other cmdlets. - -## EXAMPLES - -### Example 1: Create a diagnostic transaction -``` -PS C:\>New-DtcDiagnosticTransaction -Timeout 60 -IsolationLevel Serializable -Id --- -4625a5a3-af35-465d-a331-f224d79e4c85 -``` - -This command creates a new serializable diagnostic transaction with a timeout of 60 seconds. - -## PARAMETERS - -### -IsolationLevel -Specifies the isolation level for a transaction.The acceptable values for this parameter are: - -- Serializable -- RepeatableRead -- ReadCommitted -- ReadUncommitted -- Snapshot -- Chaos - -If you do not specify this parameter, the cmdlet uses the default **IsolationLevel** value specified in the **System.Transactions.Transaction** object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: Serializable, RepeatableRead, ReadCommitted, ReadUncommitted, Snapshot, Chaos, Unspecified - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the timeout, in seconds, for the transaction. -If you do not specify this parameter, the cmdlet uses the default timeout value specified in the **System.Transactions.Transaction** object. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Complete-DtcDiagnosticTransaction](./Complete-DtcDiagnosticTransaction.md) - -[Receive-DtcDiagnosticTransaction](./Receive-DtcDiagnosticTransaction.md) - -[Send-DtcDiagnosticTransaction](./Send-DtcDiagnosticTransaction.md) - -[Undo-DtcDiagnosticTransaction](./Undo-DtcDiagnosticTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Receive-DtcDiagnosticTransaction.md b/docset/winserver2012-ps/msdtc/Receive-DtcDiagnosticTransaction.md deleted file mode 100644 index 9ff47c4e16..0000000000 --- a/docset/winserver2012-ps/msdtc/Receive-DtcDiagnosticTransaction.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/receive-dtcdiagnostictransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Receive-DtcDiagnosticTransaction - -## SYNOPSIS -Propagates a transaction from a given diagnostic Resource Manager. - -## SYNTAX - -``` -Receive-DtcDiagnosticTransaction [[-ComputerName] ] [[-Port] ] [-PropagationMethod] -``` - -## DESCRIPTION -The **Receive-DtcDiagnosticTransaction** cmdlet propagates a transaction from a specified diagnostic Resource Manager (RM). -A transaction is created on the specified RM and propagated to the Windows PowerShell® client using either pull or push propagation. -Use the **PropagationMethod** parameter to specify the propagation mechanism. - -## EXAMPLES - -### Example 1: Receive a diagnostic transaction -```powershell -PS C:\> Receive-DtcDiagnosticTransaction -ComputerName "Host1" -Port 17123 -PropagationMethod Pull -``` -```output -Id --- -d23fd4b1-1b54-486a-9e9f-a92550a19ce2 -``` - -This command pulls a diagnostic transaction from Host1 port 17123. - -## PARAMETERS - -### -ComputerName -Specifies the host name of the computer on which the RM runs. -If you do not specify a host name, this cmdlet uses the name of the local computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Port -Specifies the listening port of the test RM. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: 3002 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropagationMethod -Specifies the propagation mechanism, pull or push, to use. -The default is pull. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: Pull, Push - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Complete-DtcDiagnosticTransaction](./Complete-DtcDiagnosticTransaction.md) - -[New-DtcDiagnosticTransaction](./New-DtcDiagnosticTransaction.md) - -[Send-DtcDiagnosticTransaction](./Send-DtcDiagnosticTransaction.md) - -[Undo-DtcDiagnosticTransaction](./Undo-DtcDiagnosticTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Remove-DtcClusterTMMapping.md b/docset/winserver2012-ps/msdtc/Remove-DtcClusterTMMapping.md deleted file mode 100644 index fb4b126b52..0000000000 --- a/docset/winserver2012-ps/msdtc/Remove-DtcClusterTMMapping.md +++ /dev/null @@ -1,156 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/remove-dtcclustertmmapping?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-DtcClusterTMMapping - -## SYNOPSIS -Removes a cluster DTC mapping. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-DtcClusterTMMapping [-CimSession ] [-ThrottleLimit ] [-All] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-DtcClusterTMMapping [-CimSession ] [-ThrottleLimit ] -Name [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Remove-DtcClusterTMMapping** cmdlet removes a cluster Distributed Transaction Coordinator (DTC) mapping. -This cmdlet is supported on clustered computers only. - -## EXAMPLES - -### Example 1: Remove a local mapping -``` -PS C:\> Remove-DtcClusterTMMapping -Name "LocalTestAppMapping" -Confirm - -Are you sure you want to perform this action? - -Removing Tm Mapping will result in the application using default Dtc as its transactions coordinator. - -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Yes -``` - -This command removes a local **DtcClusterTMMapping** object. - -## PARAMETERS - -### -All -Indicates that this cmdlet deletes all TM mappings. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the mapping name of the TM mapping to delete. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Add-DtcClusterTMMapping](./Add-DtcClusterTMMapping.md) - -[Get-DtcClusterTMMapping](./Get-DtcClusterTMMapping.md) - -[Set-DtcClusterTMMapping](./Set-DtcClusterTMMapping.md) - diff --git a/docset/winserver2012-ps/msdtc/Reset-DtcLog.md b/docset/winserver2012-ps/msdtc/Reset-DtcLog.md deleted file mode 100644 index fd92070697..0000000000 --- a/docset/winserver2012-ps/msdtc/Reset-DtcLog.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/reset-dtclog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-DtcLog - -## SYNOPSIS -Resets the log file of a DTC instance. - -## SYNTAX - -``` -Reset-DtcLog [-CimSession ] [-DtcName ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Reset-DtcLog** cmdlet resets the log file of a Distributed Transaction Coordinator (DTC) instance. -You can use the **DtcName** parameter to specify a DTC instance. -This cmdlet also recreates the transactions log with the existing settings and restarts the DTC instance. - -## EXAMPLES - -### Example 1: Reset a DTC log -``` -PS C:\>Reset-DtcLog -DtcName "Local" -Confirm:$False -WhatIf:$False -``` - -This command resets the log file for the Local DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet resets the log file for this instance. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet resets the log file for the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcLog](./Get-DtcLog.md) - -[Set-DtcLog](./Set-DtcLog.md) - diff --git a/docset/winserver2012-ps/msdtc/Send-DtcDiagnosticTransaction.md b/docset/winserver2012-ps/msdtc/Send-DtcDiagnosticTransaction.md deleted file mode 100644 index 878c4a155a..0000000000 --- a/docset/winserver2012-ps/msdtc/Send-DtcDiagnosticTransaction.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/send-dtcdiagnostictransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Send-DtcDiagnosticTransaction - -## SYNOPSIS -Propagates a transaction to a specified diagnostic Resource Manager. - -## SYNTAX - -``` -Send-DtcDiagnosticTransaction [-Transaction] [[-ComputerName] ] - [[-Port] ] [-PropagationMethod] -``` - -## DESCRIPTION -The **Send-DtcDiagnosticTransaction** cmdlet propagates a transaction to a specified diagnostic Resource Manager (RM). -Use the **PropagationMethod** parameter to specify the propagation method. - -## EXAMPLES - -### Example 1: Send a DTC diagnostic transaction -```powershell -PS C:\>$Tx = New-DtcDiagnosticTransaction -PS C:\> Send-DtcDiagnosticTransaction -Transaction $Tx -ComputerName "Host1" -PropagationMethod Push -``` - -The first command creates a new DTC diagnostic transaction and assigns it to a variable. - -The second command sends the diagnostic transaction to an RM running on the computer named Host1. - -## PARAMETERS - -### -ComputerName -Specifies the host name of the computer on which the RM is running. -If you do not specify a host name, the cmdlet uses the name of the local computer. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Port -Specifies the listening port of the test RM. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: 3002 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PropagationMethod -Specifies the propagation mechanism, pull or push, to use. -The default is pull. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: Pull, Push - -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transaction -Specifies the **DtcDiagnosticTransaction** object to use in the transaction propagation. -You can use the pipeline operator to pass this parameter value to the cmdlet. - -```yaml -Type: DtcDiagnosticTransaction -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Complete-DtcDiagnosticTransaction](./Complete-DtcDiagnosticTransaction.md) - -[New-DtcDiagnosticTransaction](./New-DtcDiagnosticTransaction.md) - -[Receive-DtcDiagnosticTransaction](./Receive-DtcDiagnosticTransaction.md) - -[Undo-DtcDiagnosticTransaction](./Undo-DtcDiagnosticTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcAdvancedHostSetting.md b/docset/winserver2012-ps/msdtc/Set-DtcAdvancedHostSetting.md deleted file mode 100644 index 74f21515a2..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcAdvancedHostSetting.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtcadvancedhostsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcAdvancedHostSetting - -## SYNOPSIS -Sets the DTC host level properties in the registry. - -## SYNTAX - -``` -Set-DtcAdvancedHostSetting [-CimSession ] [-Subkey ] [-ThrottleLimit ] - -Name [-Type] -Value -``` - -## DESCRIPTION -The **Set-DtcAdvancedHostSetting** cmdlet sets the Distributed Transaction Coordinator (DTC) host level properties in the registry. - -## EXAMPLES - -### Example 1: Specify a diagnostic trace file path -``` -PS C:\> Set-DtcAdvancedHostSetting -Name "TraceFilePath" -Type "SZ" -Value "C:\Temp" -SubKey "Tracing\Output" -``` - -This command specifies a diagnostic trace file path. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the property to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subkey -Specifies the subkey name for the property to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the registry type of the property to store. -The acceptable values for this parameter are: - -- SZ -- DWORD - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: String, DWORD - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the property to store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcAdvancedHostSetting](./Get-DtcAdvancedHostSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcAdvancedSetting.md b/docset/winserver2012-ps/msdtc/Set-DtcAdvancedSetting.md deleted file mode 100644 index 9bb74d5ee8..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcAdvancedSetting.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtcadvancedsetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcAdvancedSetting - -## SYNOPSIS -Sets DTC instance specific properties in the registry. - -## SYNTAX - -``` -Set-DtcAdvancedSetting [-CimSession ] [-DtcName ] [-Subkey ] - [-ThrottleLimit ] -Name [-Type] -Value -``` - -## DESCRIPTION -The **Set-DtcAdvancedSetting** cmdlet sets the Distributed Transaction Coordinator (DTC) instance specific properties in the registry. - -## EXAMPLES - -### Example 1: Modify a setting for the local DTC -``` -PS C:\> Set-DtcAdvancedSetting -Name "AllowOnlySecureRpcCalls" -Type "DWORD" -Value "0" -DtcName "Local" -``` - -This command disables remote procedure call (RPC) security on the local DTC. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies the DTC instance for which to set the DTC instance specific properties. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the property to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Subkey -Specifies the subkey name for the property to set. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Type -Specifies the registry type of the property to store. -The acceptable values for this parameter are: - -- SZ -- DWORD - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: String, DWORD - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Value -Specifies the value of the property to store. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcAdvancedSetting](./Get-DtcAdvancedSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcClusterDefault.md b/docset/winserver2012-ps/msdtc/Set-DtcClusterDefault.md deleted file mode 100644 index a56fc4be14..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcClusterDefault.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtcclusterdefault?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcClusterDefault - -## SYNOPSIS -Sets the cluster default transactions coordinator. - -## SYNTAX - -``` -Set-DtcClusterDefault [-CimSession ] [-ThrottleLimit ] -DtcResourceName -``` - -## DESCRIPTION -The **Set-DtcClusterDefault** cmdlet sets the cluster default transactions coordinator. - -## EXAMPLES - -### Example 1: Specify a resource -``` -PS C:\> Set-DtcClusterDefault -DtcResourceName "ClusteredDtcResource" -``` - -This command sets the default cluster DTC to the resource named ClusteredDtcResource. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcResourceName -Specifies the name of the Distributed Transaction Coordinator (DTC) cluster resource that needs to be set as default cluster TM. -This command is supported only on clustered nodes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### String -This cmdlet returns the virtual server name of the cluster default transactions coordinator. - -## NOTES - -## RELATED LINKS - -[Get-DtcClusterDefault](./Get-DtcClusterDefault.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcClusterTMMapping.md b/docset/winserver2012-ps/msdtc/Set-DtcClusterTMMapping.md deleted file mode 100644 index bf1311b197..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcClusterTMMapping.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtcclustertmmapping?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcClusterTMMapping - -## SYNOPSIS -Modifies an existing cluster DTC mapping. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DtcClusterTMMapping [-CimSession ] [-ClusterResourceName ] [-ThrottleLimit ] - -Local -Name -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DtcClusterTMMapping [-CimSession ] [-Local ] [-ThrottleLimit ] - -ClusterResourceName -Name -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-DtcClusterTMMapping [-CimSession ] [-ClusterResourceName ] [-Local ] - [-ThrottleLimit ] -ComPlusAppId -Name -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-DtcClusterTMMapping [-CimSession ] [-ClusterResourceName ] [-Local ] - [-ThrottleLimit ] -ExecutablePath -Name -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Set-DtcClusterTMMapping [-CimSession ] [-ClusterResourceName ] [-Local ] - [-ThrottleLimit ] -Name -Service -``` - -## DESCRIPTION -The **Set-DtcClusterTMMapping** cmdlet modifies an existing cluster Distributed Transaction Coordinator (DTC) mapping. -This cmdlet is supported on clustered computers only. - -## EXAMPLES - -### Example 1: Modify a DTC cluster mapping -``` -PS C:\> Set-DtcClusterTMMapping -ExecutablePath "C:\TestApp\SampleApp.exe" -Name "LocalTestAppMapping" -ClusterResourceName "DtcResource2" -``` - -This command modifies an existing DTC cluster TM mapping. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClusterResourceName -Specifies the name of a cluster DTC resource. -This cmdlet sets the TM mapping of the resource that the name specifies. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComPlusAppId -Specifies the COM+ application identifier to associate with this mapping. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExecutablePath -Specifies the path of the application to associate with this mapping. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -Specifies whether the application type is local. -If you specify a value of $False, the application is a clustered resource. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the DTC mapping to add. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Service -Specifies the name of the Windows service to associate with this mapping. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -### DtcClusterTMMapping - -## NOTES -* This cmdlet returns a **DtcClusterTMMapping** object that contains modified mapping information. - -## RELATED LINKS - -[Add-DtcClusterTMMapping](./Add-DtcClusterTMMapping.md) - -[Get-DtcClusterTMMapping](./Get-DtcClusterTMMapping.md) - -[Remove-DtcClusterTMMapping](./Remove-DtcClusterTMMapping.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcDefault.md b/docset/winserver2012-ps/msdtc/Set-DtcDefault.md deleted file mode 100644 index a6d17cce7f..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcDefault.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtcdefault?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcDefault - -## SYNOPSIS -Sets the default transactions coordinator. - -## SYNTAX - -``` -Set-DtcDefault [-CimSession ] [-ServerName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Set-DtcDefault** cmdlet sets the default transactions coordinator. - -## EXAMPLES - -### Example 1: Set the default DTC coordinator -``` -PS C:\>Set-DtcDefault -ServerName "host14" -``` - -This command sets the default DTC coordinator to host14. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ServerName -Specifies the host name or virtual server name of the Distributed Transaction Coordinator (DTC) to set as the default coordinator. -If you do not specify this parameter, this cmdlet specifies the local DTC as the default coordinator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcDefault](./Get-DtcDefault.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcLog.md b/docset/winserver2012-ps/msdtc/Set-DtcLog.md deleted file mode 100644 index bfea0b3d2b..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcLog.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtclog?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcLog - -## SYNOPSIS -Modifies the log file settings of a DTC instance. - -## SYNTAX - -``` -Set-DtcLog [-CimSession ] [-DtcName ] [-MaxSizeInMB ] [-Path ] - [-SizeInMB ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DtcLog** cmdlet modifies the log file settings of a Distributed Transaction Coordinator (DTC) instance. -Use the **DtcName** parameter to specify a DTC instance. -This cmdlet also recreates the transactions log with new settings and restarts the DTC instance. - -## EXAMPLES - -### Example 1: Set the log file path and file size -``` -PS C:\> Set-DtcLog -Path "C:\Windows\system32\MSDtc\NewLog\" -SizeInMB 32 -MaxSizeInMB 1024 -PS C:\> Get-DtcLog -MaxSizeInMB : 1024 -Path : C:\Windows\system32\MSDtc\NewLog -SizeInMB : 32 -``` - -The first command sets the path for the DTC log file and specifies the file size. -The second command confirms the change. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet modifies the log file for this instance. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet modifies the log file for the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: n - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -MaxSizeInMB -Specifies the maximum file size of the new log file in MB. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Path -Specifies the physical or network path to store the new log file. -If a log file already exists in the specified path it is overwritten. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: p - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -SizeInMB -Specifies the initial file allocation size of the new log file in megabytes. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: s - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcLog](./Get-DtcLog.md) - -[Reset-DtcLog](./Reset-DtcLog.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcNetworkSetting.md b/docset/winserver2012-ps/msdtc/Set-DtcNetworkSetting.md deleted file mode 100644 index ca301dbf41..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcNetworkSetting.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtcnetworksetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcNetworkSetting - -## SYNOPSIS -Modifies DTC network and security configuration for a DTC instance. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DtcNetworkSetting [-AuthenticationLevel] [-CimSession ] [-DtcName ] - [-InboundTransactionsEnabled ] [-LUTransactionsEnabled ] - [-OutboundTransactionsEnabled ] [-RemoteAdministrationAccessEnabled ] - [-RemoteClientAccessEnabled ] [-ThrottleLimit ] [-XATransactionsEnabled ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DtcNetworkSetting [-CimSession ] [-DtcName ] [-ThrottleLimit ] - [-DisableNetworkAccess] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-DtcNetworkSetting** cmdlet modifies the Distributed Transaction Coordinator (DTC) network and security configuration for the DTC instance specified by the **DtcName** parameter. -This cmdlet also restarts the DTC instance. - -## EXAMPLES - -### Example 1: Modify network and security settings -``` -PS C:\> Set-DtcNetworkSetting -DtcName "Local" -AuthenticationLevel "Incoming" -InboundTransactionsEnabled $False -PS C:\> Get-DtcNetworkSetting -DtcName "Local" -__GENUS : 2 -__CLASS : DtcNetworkSettings -__SUPERCLASS : -__DYNASTY : DtcNetworkSettings -__RELPATH : -__PROPERTY_COUNT : 7 -__DERIVATION : {} -__SERVER : -__NAMESPACE : -__PATH : -AuthenticationLevel : Mutual -InboundTransactionsEnabled : True -LUTransactionsEnabled : True -OutboundTransactionsEnabled : True -RemoteAdministrationAccessEnabled : True -RemoteClientAccessEnabled : True -XATransactionsEnabled : True -``` - -The first command modifies the DTC network and security settings for the local DTC instance. -The second command verifies the changes. - -## PARAMETERS - -### -AuthenticationLevel -Sets the network authentication level of the DTC instance to NoAuth, Incoming, or Mutual. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: -Accepted values: NoAuth, Incoming, Mutual - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisableNetworkAccess -Specifies whether to disable network access for the DTC instance. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet modifies the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue, ByPropertyName) -Accept wildcard characters: False -``` - -### -InboundTransactionsEnabled -Indicates whether to enable inbound transactions to the DTC instance. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LUTransactionsEnabled -Indicates whether to enable LU transactions in the DTC instance. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutboundTransactionsEnabled -Indicates whether to enable outbound transactions from the DTC instance. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteAdministrationAccessEnabled -Indicates whether to enable remote administration access for the DTC instance. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteClientAccessEnabled -Indicates whether to enable remote client access for the DTC instance. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -XATransactionsEnabled -Indicates whether to enable XA transactions in the DTC instance. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcNetworkSetting](./Get-DtcNetworkSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcTransaction.md b/docset/winserver2012-ps/msdtc/Set-DtcTransaction.md deleted file mode 100644 index 726df5f047..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcTransaction.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtctransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcTransaction - -## SYNOPSIS -Modifies the state of a transaction. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DtcTransaction [-CimSession ] [-DtcName ] [-ThrottleLimit ] [-Abort] - -TransactionId -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DtcTransaction [-CimSession ] [-DtcName ] [-ThrottleLimit ] [-Commit] - -TransactionId -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-DtcTransaction [-CimSession ] [-DtcName ] [-ThrottleLimit ] [-Trace] - -TransactionId -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-DtcTransaction [-CimSession ] [-DtcName ] [-ThrottleLimit ] [-Forget] - -TransactionId -``` - -## DESCRIPTION -The **Set-DtcTransaction** cmdlet modifies the state of a transaction in the Distributed Transaction Coordinator (DTC) host-level properties stored in the registry. - -## EXAMPLES - -### Example 1: Set a trace for a transaction -``` -PS C:\> Set-DtcTransaction -DtcName "Local" -Trace -TransactionId 2E6E62E0-044B-4DFE-9A8B-B69CFF5C9E26 -``` - -This command sets a trace for the specified transaction. - -## PARAMETERS - -### -Abort -Indicates to abort the specified transaction. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Commit -Specifies to commit the specified transaction. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies a DTC instance. -The cmdlet modifies the state of a transaction in the DTC host-level properties for this instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Forget -Indicates to forget the specified transaction. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Trace -Specifies to trace the transaction. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransactionId -Specifies the TransactionId of the transaction to modify. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcTransaction](./Get-DtcTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcTransactionsTraceSession.md b/docset/winserver2012-ps/msdtc/Set-DtcTransactionsTraceSession.md deleted file mode 100644 index d8f04ebb33..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcTransactionsTraceSession.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtctransactionstracesession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcTransactionsTraceSession - -## SYNOPSIS -Modifies the DTC transactions trace setting of the host. - -## SYNTAX - -``` -Set-DtcTransactionsTraceSession [-CimSession ] [-ThrottleLimit ] -BufferCount -``` - -## DESCRIPTION -The **Set-DtcTransactionsTraceSession** cmdlet modifies the Distributed Transaction Coordinator (DTC) transactions trace setting of the host. - -## EXAMPLES - -### Example 1: Set the transactions trace session buffer count -``` -PS C:\> Set-DtcTransactionsTraceSession -BufferCount 32 -``` - -This command sets the DTC transactions trace session buffer count to 32. - -## PARAMETERS - -### -BufferCount -Specifies the number of buffers to use for a DTC transactions trace. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcTransactionsTraceSession](./Get-DtcTransactionsTraceSession.md) - -[Start-DtcTransactionsTraceSession](./Start-DtcTransactionsTraceSession.md) - -[Stop-DtcTransactionsTraceSession](./Stop-DtcTransactionsTraceSession.md) - -[Write-DtcTransactionsTraceSession](./Write-DtcTransactionsTraceSession.md) - diff --git a/docset/winserver2012-ps/msdtc/Set-DtcTransactionsTraceSetting.md b/docset/winserver2012-ps/msdtc/Set-DtcTransactionsTraceSetting.md deleted file mode 100644 index 8e1ffd2c81..0000000000 --- a/docset/winserver2012-ps/msdtc/Set-DtcTransactionsTraceSetting.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/set-dtctransactionstracesetting?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-DtcTransactionsTraceSetting - -## SYNOPSIS -Modifies the DTC transactions trace setting of the host. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-DtcTransactionsTraceSetting [-AbortedTransactionsTracingEnabled ] [-CimSession ] - [-LongLivedTransactionsTracingEnabled ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-DtcTransactionsTraceSetting [-CimSession ] [-ThrottleLimit ] - -AllTransactionsTracingEnabled -``` - -## DESCRIPTION -The **Set-DtcTransactionsTraceSetting** cmdlet modifies the Distributed Transaction Coordinator (DTC) transactions trace setting of the host. - -## EXAMPLES - -### Example 1: Enable trace settings for all transactions -``` -PS C:\> Set-DtcTransactionsTraceSetting -AllTransactionsTracingEnabled $True -``` - -This command enables trace settings for all transactions. - -## PARAMETERS - -### -AbortedTransactionsTracingEnabled -Indicates whether to enable tracing for aborted transactions. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllTransactionsTracingEnabled -Indicates whether to enable tracing for all transactions. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LongLivedTransactionsTracingEnabled -Indicates whether to enable tracing for long-lived transactions. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcTransactionsTraceSetting](./Get-DtcTransactionsTraceSetting.md) - diff --git a/docset/winserver2012-ps/msdtc/Start-Dtc.md b/docset/winserver2012-ps/msdtc/Start-Dtc.md deleted file mode 100644 index f4f9e5a383..0000000000 --- a/docset/winserver2012-ps/msdtc/Start-Dtc.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/start-dtc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-Dtc - -## SYNOPSIS -Starts the DTC instance. - -## SYNTAX - -``` -Start-Dtc [-CimSession ] [-DtcName ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Start-Dtc** cmdlet starts the Distributed Transaction Coordinator (DTC) instance that the **DtcName** parameter specifies. - -## EXAMPLES - -### Example 1: Start the local DTC instance -``` -PS C:\>Start-Dtc -DtcName "Local" -``` - -This command starts the local DTC instance. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies the DTC instance to start. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet starts the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-Dtc](./Get-Dtc.md) - -[Install-Dtc](./Install-Dtc.md) - -[Stop-Dtc](./Stop-Dtc.md) - -[Test-Dtc](./Test-Dtc.md) - -[Uninstall-Dtc](./Uninstall-Dtc.md) - diff --git a/docset/winserver2012-ps/msdtc/Start-DtcDiagnosticResourceManager.md b/docset/winserver2012-ps/msdtc/Start-DtcDiagnosticResourceManager.md deleted file mode 100644 index b59510b524..0000000000 --- a/docset/winserver2012-ps/msdtc/Start-DtcDiagnosticResourceManager.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/start-dtcdiagnosticresourcemanager?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-DtcDiagnosticResourceManager - -## SYNOPSIS -Starts a diagnostic Resource Manager. - -## SYNTAX - -``` -Start-DtcDiagnosticResourceManager [[-Port] ] [[-Name] ] -``` - -## DESCRIPTION -The **Start-DtcDiagnosticResourceManager** cmdlet starts a diagnostic Resource Manager (RM) as a Windows PowerShell® background job. - -## EXAMPLES - -### Example 1: Start a diagnostic resource manager -``` -PS C:\>Start-DtcDiagnosticResourceManager -Port 17124 -Name "testRM" -``` - -This example starts a DTC diagnostic resource manager. - -## PARAMETERS - -### -Name -Specifies the name for the diagnostic resource manager to start. -You can later refer to the RM by using this name. -If you do not specify a name, the RM instance ID, a GUID, is always assigned to the RM and you can refer to it by that ID. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Port -Specifies the listening port of the test RM. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Join-DtcDiagnosticResourceManager](./Join-DtcDiagnosticResourceManager.md) - -[Stop-DtcDiagnosticResourceManager](./Stop-DtcDiagnosticResourceManager.md) - diff --git a/docset/winserver2012-ps/msdtc/Start-DtcTransactionsTraceSession.md b/docset/winserver2012-ps/msdtc/Start-DtcTransactionsTraceSession.md deleted file mode 100644 index 27c4651700..0000000000 --- a/docset/winserver2012-ps/msdtc/Start-DtcTransactionsTraceSession.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/start-dtctransactionstracesession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Start-DtcTransactionsTraceSession - -## SYNOPSIS -Starts a new DTC transactions trace session for the host. - -## SYNTAX - -``` -Start-DtcTransactionsTraceSession [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Start-DtcTransactionsTraceSession** cmdlet starts a new Distributed Transaction Coordinator (DTC) transactions trace session for the host. -If there is an active session, this cmdlet prompts you before it stops the current session and starts a new trace session. - -## EXAMPLES - -### Example 1: Start a trace session -``` -PS C:\> Start-DtcTransactionsTraceSession -``` - -This command starts a trace session. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcTransactionsTraceSession](./Get-DtcTransactionsTraceSession.md) - -[Set-DtcTransactionsTraceSession](./Set-DtcTransactionsTraceSession.md) - -[Stop-DtcTransactionsTraceSession](./Stop-DtcTransactionsTraceSession.md) - -[Write-DtcTransactionsTraceSession](./Write-DtcTransactionsTraceSession.md) - diff --git a/docset/winserver2012-ps/msdtc/Stop-Dtc.md b/docset/winserver2012-ps/msdtc/Stop-Dtc.md deleted file mode 100644 index cd966c38b5..0000000000 --- a/docset/winserver2012-ps/msdtc/Stop-Dtc.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/stop-dtc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-Dtc - -## SYNOPSIS -Stops a DTC instance. - -## SYNTAX - -``` -Stop-Dtc [-CimSession ] [-DtcName ] [-Recursive] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Stop-Dtc** cmdlet stops the Distributed Transaction Coordinator (DTC) instance that the **DtcName** parameter specifies. - -## EXAMPLES - -### Example 1: Stop a local DTC instance -``` -This command uses the Get-Dtc cmdlet to view the status of the local DTC instance. -PS C:\> Get-Dtc -DtcName "Local" -__GENUS : 2 -__CLASS : DtcInstance -__SUPERCLASS : -__DYNASTY : DtcInstance -__RELPATH : -__PROPERTY_COUNT : 7 -__DERIVATION : {} -__SERVER : -__NAMESPACE : -__PATH : -DtcName : Local -KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af -OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b -Status : Started -UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e -VirtualServerName : Contoso093 -XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd - -This command stops the local DTC instance. The first command shows that the instance is started, and, therefore, it is safe to stop that instance. -PS C:\> Stop-Dtc -DtcName "Local" - -This command uses **Get-Dtc**, again, to confirm that the DTC instance is stopped. -PS C:\> Get-Dtc -DtcName "Local" -__GENUS : 2 -__CLASS : DtcInstance -__SUPERCLASS : -__DYNASTY : DtcInstance -__RELPATH : -__PROPERTY_COUNT : 7 -__DERIVATION : {} -__SERVER : -__NAMESPACE : -__PATH : -DtcName : Local -KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af -OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b -Status : Stopped -UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e -VirtualServerName : Contoso093 -XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd -``` - -This example stops the local DTC instance. -To stop a different instance, specify a different value for the **DtcName** parameter. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DtcName -Specifies the DTC instance to stop. -If you do not specify this parameter, or if you specify a value of Local, this cmdlet stops the local DTC instance. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recursive -Indicates that the cmdlet stops any services that rely on the specified DTC instance, such as Microsoft SQL Server. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-Dtc](./Get-Dtc.md) - -[Install-Dtc](./Install-Dtc.md) - -[Start-Dtc](./Start-Dtc.md) - -[Test-Dtc](./Test-Dtc.md) - -[Uninstall-Dtc](./Uninstall-Dtc.md) - diff --git a/docset/winserver2012-ps/msdtc/Stop-DtcDiagnosticResourceManager.md b/docset/winserver2012-ps/msdtc/Stop-DtcDiagnosticResourceManager.md deleted file mode 100644 index e1e24479bc..0000000000 --- a/docset/winserver2012-ps/msdtc/Stop-DtcDiagnosticResourceManager.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/stop-dtcdiagnosticresourcemanager?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-DtcDiagnosticResourceManager - -## SYNOPSIS -Stops and removes a diagnostic Resource Manager job. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Stop-DtcDiagnosticResourceManager [[-Job] ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Stop-DtcDiagnosticResourceManager [[-InstanceId] ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Stop-DtcDiagnosticResourceManager [[-Name] ] -``` - -## DESCRIPTION -The **Stop-DtcDiagnosticResourceManager** cmdlet stops and removes a **DiagnosticResourceManagerJob** that runs as a Windows PowerShell® background job. -To stop the default Resource Manager, you must explicitly specify the name of the default Resource Manager. - -## EXAMPLES - -### Example 1: Stop a diagnostic resource manager -``` -PS C:\>Stop-DtcDiagnosticResourceManager -Name "testRM" -``` - -This command stops the DTC diagnostic resource manager named testRM. - -## PARAMETERS - -### -InstanceId -Specifies the **DtcDiagResourceManagerJob** instance ID to stop. - -```yaml -Type: Guid -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Job -Specifies the **DtcDiagResourceManagerJob** instance to stop. -This parameter accepts pipeline input. - -```yaml -Type: DtcDiagnosticResourceManagerJob -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies a name of the diagnostic resource manager to stop. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Join-DtcDiagnosticResourceManager](./Join-DtcDiagnosticResourceManager.md) - -[Start-DtcDiagnosticResourceManager](./Start-DtcDiagnosticResourceManager.md) - diff --git a/docset/winserver2012-ps/msdtc/Stop-DtcTransactionsTraceSession.md b/docset/winserver2012-ps/msdtc/Stop-DtcTransactionsTraceSession.md deleted file mode 100644 index ca527d5b2f..0000000000 --- a/docset/winserver2012-ps/msdtc/Stop-DtcTransactionsTraceSession.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/stop-dtctransactionstracesession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Stop-DtcTransactionsTraceSession - -## SYNOPSIS -Stops the active DTC transactions trace session on the host. - -## SYNTAX - -``` -Stop-DtcTransactionsTraceSession [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Stop-DtcTransactionsTraceSession** cmdlet stops the active Distributed Transaction Coordinator (DTC) transactions trace session on the host. -If there is no active session, this cmdlet exits. - -## EXAMPLES - -### Example 1: Stop a DTC transaction trace session -``` -PS C:\>Stop-DtcTransactionsTraceSession -Confirm:$False -``` - -This command stops a DTC transaction trace session. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcTransactionsTraceSession](./Get-DtcTransactionsTraceSession.md) - -[Set-DtcTransactionsTraceSession](./Set-DtcTransactionsTraceSession.md) - -[Start-DtcTransactionsTraceSession](./Start-DtcTransactionsTraceSession.md) - -[Write-DtcTransactionsTraceSession](./Write-DtcTransactionsTraceSession.md) - diff --git a/docset/winserver2012-ps/msdtc/Test-Dtc.md b/docset/winserver2012-ps/msdtc/Test-Dtc.md deleted file mode 100644 index 53187c8699..0000000000 --- a/docset/winserver2012-ps/msdtc/Test-Dtc.md +++ /dev/null @@ -1,314 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/test-dtc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Test-Dtc - -## SYNOPSIS -Tests whether two computers can participate in networked transactions. - -## SYNTAX - -``` -Test-Dtc [[-LocalComputerName] ] [[-RemoteComputerName] ] [[-ResourceManagerPort] ] - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Test-Dtc** cmdlet tests whether two computers can participate in networked transactions. -The cmdlet performs the following tests: - -- Checks whether the required firewall rules are enabled. -- Checks whether the Microsoft Distributed Transaction Coordinator (MSDTC) network security settings are correctly configured for network transactions. -- Checks whether the two computers can ping each other. -- Checks whether a transaction can be propagated between the two computers. - -To run this cmdlet, you must first enable the firewall rule for Distributed Transaction Coordinator on both computers by using the Netsh utility run the following command: - -`netsh advfirewall firewall set rule group="Distributed Transaction Coordinator" new enable=yes` - -For more information, see [Netsh Command Syntax, Contexts, and Formatting](/windows-server/networking/technologies/netsh/netsh-contexts). - -To enable the rule using PowerShell run the following command: - -`Enable-NetFirewallRule -DisplayGroup "Distributed Transaction Coordinator"` - -## EXAMPLES - -### Example 1: Test MSDTC on the local computer -``` -PS C:\> Test-Dtc -LocalComputerName "$env:COMPUTERNAME" -Verbose -VERBOSE: ": Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: ": Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: ": Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso089: AuthenticationLevel: Mutual -VERBOSE: Contoso089: InboundTransactionsEnabled: True -VERBOSE: Contoso089: OutboundTransactionsEnabled: True -VERBOSE: Contoso089: RemoteClientAccessEnabled: False -VERBOSE: Contoso089: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso089: XATransactionsEnabled: True -VERBOSE: Contoso089: LUTransactionsEnabled: True -``` - -This command tests MSDTC on the local computer. - -### Example 2: Test MSDTC on the local computer and a remote computer -``` -PS C:\> Test-Dtc -LocalComputerName "$env:COMPUTERNAME" -RemoteComputerName "Contoso075" -ResourceManagerPort 17100 -Verbose -VERBOSE: ": Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: ": Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: ": Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso089: AuthenticationLevel: Mutual -VERBOSE: Contoso089: InboundTransactionsEnabled: True -VERBOSE: Contoso089: OutboundTransactionsEnabled: True -VERBOSE: Contoso089: RemoteClientAccessEnabled: False -VERBOSE: Contoso089: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso089: XATransactionsEnabled: True -VERBOSE: Contoso089: LUTransactionsEnabled: True -VERBOSE: Exporting cmdlet 'Get-CimInstance'. -VERBOSE: Exporting cmdlet 'Get-CimSession'. -VERBOSE: Exporting cmdlet 'New-CimSession'. -VERBOSE: Exporting cmdlet 'New-CimSessionOption'. -VERBOSE: Exporting cmdlet 'Remove-CimSession'. -VERBOSE: Exporting cmdlet 'Get-CimAssociatedInstance'. -VERBOSE: Exporting cmdlet 'Get-CimClass'. -VERBOSE: Exporting cmdlet 'Invoke-CimMethod'. -VERBOSE: Exporting cmdlet 'New-CimInstance'. -VERBOSE: Exporting cmdlet 'Register-CimIndicationEvent'. -VERBOSE: Exporting cmdlet 'Remove-CimInstance'. -VERBOSE: Exporting cmdlet 'Set-CimInstance'. -VERBOSE: Importing cmdlet 'Get-CimAssociatedInstance'. -VERBOSE: Importing cmdlet 'Get-CimClass'. -VERBOSE: Importing cmdlet 'Get-CimInstance'. -VERBOSE: Importing cmdlet 'Get-CimSession'. -VERBOSE: Importing cmdlet 'Invoke-CimMethod'. -VERBOSE: Importing cmdlet 'New-CimInstance'. -VERBOSE: Importing cmdlet 'New-CimSession'. -VERBOSE: Importing cmdlet 'New-CimSessionOption'. -VERBOSE: Importing cmdlet 'Register-CimIndicationEvent'. " -VERBOSE: Importing cmdlet 'Remove-CimInstance'. -VERBOSE: Importing cmdlet 'Remove-CimSession'. -VERBOSE: Importing cmdlet 'Set-CimInstance'. -VERBOSE: "Contoso075 Operating System Version: 6.2.8179." -VERBOSE: "Contoso075: Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: "Contoso075: Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: "Contoso075: Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso075: AuthenticationLevel: Mutual -VERBOSE: Contoso075: InboundTransactionsEnabled: True -VERBOSE: Contoso075: OutboundTransactionsEnabled: True -VERBOSE: Contoso075: RemoteClientAccessEnabled: False -VERBOSE: Contoso075: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso075: XATransactionsEnabled: True -VERBOSE: Contoso075: LUTransactionsEnabled: True -VERBOSE: "Pinging computer Contoso089 from Contoso075 succeeded." -VERBOSE: "Pinging computer Contoso075 from Contoso089 succeeded." -VERBOSE: Contoso089: OleTx: a9f3f4c0-cc24-4f34-bfc3-6b6d819dab84 -VERBOSE: Contoso075: OleTx: 94a24f8a-3040-4fa2-9f27-833ffb2037bc -VERBOSE: Contoso089: XA: f35da6a2-26d2-4d14-98e6-1a8feea41bc8 -VERBOSE: Contoso075: XA: 15614187-293b-4a39-92ce-6740b1ea526c -VERBOSE: Contoso089: UIS: 7f8d8ad0-7096-47fd-9aab-5d561852c93b -VERBOSE: Contoso075: UIS: e1a97aaa-003c-4b61-a978-8601e8438d5f -VERBOSE: "This diagnostic test will attempt to carry out a transaction propagation between Contoso089 and -Contoso075. It requires that a TCP port is opened on Contoso089 so that a Test Resource Manager can participate -in network transactions." "You have specified 17100 as the 'ResourceManagerPort'." "Please open port 17100 in the -firewall to proceed with the test." -VERBOSE: "Test resource manager started." -VERBOSE: "A new PSSession to Contoso075 created." -VERBOSE: "Transaction propagated from Contoso089 to Contoso075 using PULL propagation." -VERBOSE: "Transaction propagated from Contoso089 to Contoso075 using PUSH propagation." -VERBOSE: "Test Resource Manager Verbose Log:" -VERBOSE: DtcDiagRM:17100 is now listening at http://Contoso089:17100/DTCDiagRM. -VERBOSE: Resolution of IP address to hostname failed, just using IP address: 2001:0db8:2a:1006:c041:b365:30de:b2e3. -VERBOSE: DtcDiagRM:17100 received a request for PropagationToken from 2001:0db8:2a:1006:c041:b365:30de:b2e3. -VERBOSE: DtcDiagRM:17100 created Transaction 4a546251-db38-4fe9-91bb-22e532deb68b. -VERBOSE: DtcDiagRM:17100 obtained a PropagationToken for Transaction 4a546251-db38-4fe9-91bb-22e532deb68b from DTC. -VERBOSE: Resolution of IP address to hostname failed, just using IP address: 2001:0db8:2a:1006:c041:b365:30de:b2e3. -VERBOSE: ResourceManager DtcDiagRM:17100 received a request for an ExportCookie from -2001:0db8:2a:1006:c041:b365:30de:b2e3. -VERBOSE: DtcDiagRM:17100 created Transaction cc088777-03c6-43cc-83f6-06539b83e1fd. -VERBOSE: DtcDiagRM:17100 obtained an ExportCookie for Transaction cc088777-03c6-43cc-83f6-06539b83e1fd from DTC. -VERBOSE: Resource Manager DtcDiagRM:17100 - 24aeb805-7ef5-4410-9a19-f5fddf93c4d2 is removed. -``` - -This command tests the local computer and the computer named Contoso075. -The command specifies a resource manager port. - -### Example 3: Test MSDTC on a local computer that blocks inbound transactions -``` -PS C:\> Test-Dtc -LocalComputerName "$env:COMPUTERNAME" -RemoteComputerName "Contoso075" -ResourceManagerPort 17100 -Verbose -VERBOSE: ": Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: ": Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: ": Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso089: AuthenticationLevel: Mutual -VERBOSE: Contoso089: InboundTransactionsEnabled: False -WARNING: "Contoso089: Inbound transactions are not allowed and this computer cannot participate in network transactions." -VERBOSE: Contoso089: OutboundTransactionsEnabled: True -VERBOSE: Contoso089: RemoteClientAccessEnabled: False -VERBOSE: Contoso089: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso089: XATransactionsEnabled: True -VERBOSE: Contoso089: LUTransactionsEnabled: True -VERBOSE: Operation '' complete. -VERBOSE: "Contoso075 Operating System Version: 6.2.8179." -VERBOSE: "Contoso075: Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: "Contoso075: Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: "Contoso075: Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso075: AuthenticationLevel: Mutual -VERBOSE: Contoso075: InboundTransactionsEnabled: True -VERBOSE: Contoso075: OutboundTransactionsEnabled: True -VERBOSE: Contoso075: RemoteClientAccessEnabled: False -VERBOSE: Contoso075: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso075: XATransactionsEnabled: True -VERBOSE: Contoso075: LUTransactionsEnabled: True -VERBOSE: "Pinging computer Contoso089 from Contoso075 succeeded." -VERBOSE: "Pinging computer Contoso075 from Contoso089 succeeded." -VERBOSE: Contoso089: OleTx: a9f3f4c0-cc24-4f34-bfc3-6b6d819dab84 -VERBOSE: Contoso075: OleTx: 94a24f8a-3040-4fa2-9f27-833ffb2037bc -VERBOSE: Contoso089: XA: f35da6a2-26d2-4d14-98e6-1a8feea41bc8 -VERBOSE: Contoso075: XA: 15614187-293b-4a39-92ce-6740b1ea526c -VERBOSE: Contoso089: UIS: 7f8d8ad0-7096-47fd-9aab-5d561852c93b -VERBOSE: Contoso075: UIS: e1a97aaa-003c-4b61-a978-8601e8438d5f -"DTC security settings and firewall settings should be fixed in order to complete the transactions propagation test." -``` - -This command tests the local computer and the computer named Contoso075. -The output from this test shows that the local computer does not allow inbound transactions. - -### Example 4: Test MSDTC on a local computer that blocks outbound transactions -``` -PS C:\> Test-Dtc -LocalComputerName "$env:COMPUTERNAME" -RemoteComputerName "Contoso075" -ResourceManagerPort 17100 -Verbose -VERBOSE: ": Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: ": Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: ": Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso089: AuthenticationLevel: Mutual -VERBOSE: Contoso089: InboundTransactionsEnabled: True -VERBOSE: Contoso089: OutboundTransactionsEnabled: False -WARNING: "Contoso089: Outbound transactions are not allowed and this computer cannot participate in network transactions." -VERBOSE: Contoso089: RemoteClientAccessEnabled: False -VERBOSE: Contoso089: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso089: XATransactionsEnabled: True -VERBOSE: Contoso089: LUTransactionsEnabled: True -VERBOSE: Operation '' complete. -VERBOSE: "Contoso075 Operating System Version: 6.2.8179." -VERBOSE: "Contoso075: Firewall rule for "RPC Endpoint Mapper" is enabled." -VERBOSE: "Contoso075: Firewall rule for "DTC incoming connections" is enabled." -VERBOSE: "Contoso075: Firewall rule for "DTC outgoing connections" is enabled." -VERBOSE: Contoso075: AuthenticationLevel: Mutual -VERBOSE: Contoso075: InboundTransactionsEnabled: True -VERBOSE: Contoso075: OutboundTransactionsEnabled: True -VERBOSE: Contoso075: RemoteClientAccessEnabled: False -VERBOSE: Contoso075: RemoteAdministrationAccessEnabled: True -VERBOSE: Contoso075: XATransactionsEnabled: True -VERBOSE: Contoso075: LUTransactionsEnabled: True -VERBOSE: "Pinging computer Contoso089 from Contoso075 succeeded." -VERBOSE: "Pinging computer Contoso075 from Contoso089 succeeded." -VERBOSE: Contoso089: OleTx: a9f3f4c0-cc24-4f34-bfc3-6b6d819dab84 -VERBOSE: Contoso075: OleTx: 94a24f8a-3040-4fa2-9f27-833ffb2037bc -VERBOSE: Contoso089: XA: f35da6a2-26d2-4d14-98e6-1a8feea41bc8 -VERBOSE: Contoso075: XA: 15614187-293b-4a39-92ce-6740b1ea526c -VERBOSE: Contoso089: UIS: 7f8d8ad0-7096-47fd-9aab-5d561852c93b -VERBOSE: Contoso075: UIS: e1a97aaa-003c-4b61-a978-8601e8438d5f -"DTC security settings and firewall settings should be fixed in order to complete the transactions propagation test." -``` - -This command tests the local computer and the computer named Contoso075. -The output from this test shows that the local computer does not allow outbound transactions. - -## PARAMETERS - -### -LocalComputerName -Specifies the virtual server name of the MSDTC instance on the local computer to test. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RemoteComputerName -Specifies the virtual server name of the MSDTC instance on the remote computer to test. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResourceManagerPort -Specifies the port number that the MSDTC diagnostic Resource Manager uses. -If you do not specify a value, this cmdlet uses a default value of 3002. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-Dtc](./Get-Dtc.md) - -[Install-Dtc](./Install-Dtc.md) - -[Start-Dtc](./Start-Dtc.md) - -[Stop-Dtc](./Stop-Dtc.md) - -[Uninstall-Dtc](./Uninstall-Dtc.md) diff --git a/docset/winserver2012-ps/msdtc/Undo-DtcDiagnosticTransaction.md b/docset/winserver2012-ps/msdtc/Undo-DtcDiagnosticTransaction.md deleted file mode 100644 index 98e8a614f6..0000000000 --- a/docset/winserver2012-ps/msdtc/Undo-DtcDiagnosticTransaction.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/undo-dtcdiagnostictransaction?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Undo-DtcDiagnosticTransaction - -## SYNOPSIS -Invokes the Abort process on the specified transaction. - -## SYNTAX - -``` -Undo-DtcDiagnosticTransaction [-Transaction] -``` - -## DESCRIPTION -The **Undo-DtcDiagnosticTransaction** cmdlet invokes the Abort process on the specified transaction. - -## EXAMPLES - -### Example 1: Undo a DTC diagnostic transaction -``` -PS C:\>$Tx = New-DtcDiagnosticTransaction -PS C:\> Undo-DtcDiagnosticTransaction -Transaction $Tx -``` - -This command creates a new diagnostic transaction and assigns it to a variable. - -The second command undoes the transaction. - -## PARAMETERS - -### -Transaction -Specifies the **DtcDiagnosticTransaction** object on which to invoke the Abort process. -You can use the pipeline operator to pass this parameter value to the cmdlet. - -```yaml -Type: DtcDiagnosticTransaction -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Complete-DtcDiagnosticTransaction](./Complete-DtcDiagnosticTransaction.md) - -[New-DtcDiagnosticTransaction](./New-DtcDiagnosticTransaction.md) - -[Receive-DtcDiagnosticTransaction](./Receive-DtcDiagnosticTransaction.md) - -[Send-DtcDiagnosticTransaction](./Send-DtcDiagnosticTransaction.md) - diff --git a/docset/winserver2012-ps/msdtc/Uninstall-Dtc.md b/docset/winserver2012-ps/msdtc/Uninstall-Dtc.md deleted file mode 100644 index c707f9e577..0000000000 --- a/docset/winserver2012-ps/msdtc/Uninstall-Dtc.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/uninstall-dtc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Uninstall-Dtc - -## SYNOPSIS -Uninstalls the local transactions coordinator. - -## SYNTAX - -``` -Uninstall-Dtc [-CimSession ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Uninstall-Dtc** cmdlet uninstalls the local transactions coordinator. - -## EXAMPLES - -### Example 1: Uninstall DTC -``` -PS C:\>Uninstall-Dtc -Confirm:$False -``` - -This command uninstalls DTC without asking for confirmation. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-Dtc](./Get-Dtc.md) - -[Install-Dtc](./Install-Dtc.md) - -[Start-Dtc](./Start-Dtc.md) - -[Stop-Dtc](./Stop-Dtc.md) - -[Test-Dtc](./Test-Dtc.md) - diff --git a/docset/winserver2012-ps/msdtc/Write-DtcTransactionsTraceSession.md b/docset/winserver2012-ps/msdtc/Write-DtcTransactionsTraceSession.md deleted file mode 100644 index a7a4fc7019..0000000000 --- a/docset/winserver2012-ps/msdtc/Write-DtcTransactionsTraceSession.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -external help file: MsDTC_Cmdlets.xml -Module Name: MsDTC -online version: https://learn.microsoft.com/powershell/module/msdtc/write-dtctransactionstracesession?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Write-DtcTransactionsTraceSession - -## SYNOPSIS -Writes the data from an active DTC transactions trace session into the log file. - -## SYNTAX - -``` -Write-DtcTransactionsTraceSession [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Write-DtcTransactionsTraceSession** cmdlet writes the data from an active Distributed Transaction Coordinator (DTC) transactions trace session into the log file. -If there is no active session, this cmdlet exits. - -## EXAMPLES - -### Example 1: Write a DTC transaction trace session to a log file -``` -PS C:\>Write-DtcTransactionsTraceSession -``` - -This command writes current DTC transaction traces session information to a log file. - -## PARAMETERS - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-DtcTransactionsTraceSession](./Get-DtcTransactionsTraceSession.md) - -[Set-DtcTransactionsTraceSession](./Set-DtcTransactionsTraceSession.md) - -[Start-DtcTransactionsTraceSession](./Start-DtcTransactionsTraceSession.md) - -[Stop-DtcTransactionsTraceSession](./Stop-DtcTransactionsTraceSession.md) - diff --git a/docset/winserver2012-ps/msmq/Clear-MsmqOutgoingQueue.md b/docset/winserver2012-ps/msmq/Clear-MsmqOutgoingQueue.md deleted file mode 100644 index 32a499607a..0000000000 --- a/docset/winserver2012-ps/msmq/Clear-MsmqOutgoingQueue.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/clear-msmqoutgoingqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-MsmqOutgoingQueue - -## SYNOPSIS -Purges all outgoing queues that are represented by the supplied MsmqOutgoingQueue objects. - -## SYNTAX - -``` -Clear-MsmqOutgoingQueue -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Clear-MsmqOutgoingQueue** cmdlet purges all outgoing queues that are represented by the supplied **MsmqOutgoingQueue** objects. -It returns an **MsmqOutgoingQueue** object that represents the cleared outgoing queue. - -## EXAMPLES - -### Example 1: Purge all outgoing queues -``` -PS C:\>Get-MsmqOutgoingQueue -Name "Order*" | Clear-MsmqOutgoingQueue -``` - -This command gets all outgoing queue with a wildcard named Order and purges them. - -## PARAMETERS - -### -InputObject -Specifies an array of **MsmqOutgoingQueue** objects that represents an outgoing queue that is purged. - -```yaml -Type: OutgoingQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqOutgoingQueue](./Get-MsmqOutgoingQueue.md) - -[Resume-MsmqOutgoingQueue](./Resume-MsmqOutgoingQueue.md) - -[Suspend-MsmqOutgoingQueue](./Suspend-MsmqOutgoingQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Clear-MsmqQueue.md b/docset/winserver2012-ps/msmq/Clear-MsmqQueue.md deleted file mode 100644 index 1382c6b806..0000000000 --- a/docset/winserver2012-ps/msmq/Clear-MsmqQueue.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/clear-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Clear-MsmqQueue - -## SYNOPSIS -Clears all queues that are represented by the supplied MessageQueue objects. - -## SYNTAX - -``` -Clear-MsmqQueue -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Clear-MsmqQueue** cmdlet clears all queues that are represented by the supplied **MessageQueue** objects. -It returns a **MessageQueue** object that represents the cleared outgoing queue. - -## EXAMPLES - -### Example 1: Clear all queues under a specified wildcard -``` -PS C:\>Get-MessageQueue -Name Order* | Clear-MessageQueue -``` - -This command gets all queue under the wildcard named Order, then clears them. - -## PARAMETERS - -### -InputObject -Specifies a **MessageQueue** object that represents a queue that will be purged. - -```yaml -Type: MessageQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqQueue](./Get-MsmqQueue.md) - -[New-MsmqQueue](./New-MsmqQueue.md) - -[Receive-MsmqQueue](./Receive-MsmqQueue.md) - -[Remove-MsmqQueue](./Remove-MsmqQueue.md) - -[Send-MsmqQueue](./Send-MsmqQueue.md) - -[Set-MsmqQueue](./Set-MsmqQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Enable-MsmqCertificate.md b/docset/winserver2012-ps/msmq/Enable-MsmqCertificate.md deleted file mode 100644 index 6ef63613ad..0000000000 --- a/docset/winserver2012-ps/msmq/Enable-MsmqCertificate.md +++ /dev/null @@ -1,117 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/enable-msmqcertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-MsmqCertificate - -## SYNOPSIS -Registers a certificate with Active Directory Domain Services. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-MsmqCertificate -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-MsmqCertificate [-RenewInternalCertificate] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-MsmqCertificate** cmdlet registers a certificate with Active Directory Domain Services. -If the **RenewInternalCertificate** parameter is specified, the cmdlet generates a new certificate in the user's personal certificate store and registers it with Active Directory Domain Services. -It returns a **System.Security.Cryptography.X509Certificates.X509Certificate** object that represents the enabled certificate. - -## EXAMPLES - -### Example 1: Register a certificate with Active Directory Domain Services -``` -PS C:\>$_ | Enable-MsmqCertificate -PS C:\> RenewInternalCertificate -``` - -This first command registers a certificate with Active Directory Domain Services. -The final command renews the certificate. - -## PARAMETERS - -### -InputObject -Specifies a certificate object that represents a certificate that is registered with the Active Directory Domain Services. -This parameter cannot be used if the **RenewInternalCertificate** parameter is specified. - -```yaml -Type: X509Certificate2 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -RenewInternalCertificate -Indicates that this cmdlet generates a new certificate in the user's personal certificate store and registers it with Active Directory Domain Services. -This parameter cannot be used if the **X509Certificate2** parameter is specified or if a certificate is piped to this cmdlet's input. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqCertificate](./Get-MsmqCertificate.md) - -[Remove-MsmqCertificate](./Remove-MsmqCertificate.md) - diff --git a/docset/winserver2012-ps/msmq/Get-MsmqCertificate.md b/docset/winserver2012-ps/msmq/Get-MsmqCertificate.md deleted file mode 100644 index 6c9f01121d..0000000000 --- a/docset/winserver2012-ps/msmq/Get-MsmqCertificate.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/get-msmqcertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MsmqCertificate - -## SYNOPSIS -Gets an array of object type System.Security.Cryptography.X509Certificates.X509Certificate. - -## SYNTAX - -``` -Get-MsmqCertificate [[-ComputerName] ] -``` - -## DESCRIPTION -The **Get-MsmqCertificate** cmdlet returns an array of object type **System.Security.Cryptography.X509Certificates.X509Certificate**. -Each entry represents a personal certificate that is currently registered in Active Directory Domain Services. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -ComputerName -Specifies the certificates of the current user for the specified host or virtual server. -If you do not specify this parameter the cmdlet gets the certificates of the current user for all hosts or virtual servers. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: cn - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Enable-MsmqCertificate](./Enable-MsmqCertificate.md) - -[Remove-MsmqCertificate](./Remove-MsmqCertificate.md) - diff --git a/docset/winserver2012-ps/msmq/Get-MsmqOutgoingQueue.md b/docset/winserver2012-ps/msmq/Get-MsmqOutgoingQueue.md deleted file mode 100644 index d8497cb681..0000000000 --- a/docset/winserver2012-ps/msmq/Get-MsmqOutgoingQueue.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/get-msmqoutgoingqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MsmqOutgoingQueue - -## SYNOPSIS -Gets an array of MsmqOutgoingQueue objects, each representing a transactional or non-transactional outgoing queue. - -## SYNTAX - -``` -Get-MsmqOutgoingQueue [[-Name] ] -``` - -## DESCRIPTION -The **Get-MsmqOutgoingQueue** cmdlet returns an array of **MsmqOutgoingQueue** objects, each representing a transactional or non-transactional outgoing queue. -The outgoing queue must be local to the machine on which the cmdlet is executed. -Without parameters, this cmdlet returns all outgoing queues of the host machine. - -## EXAMPLES - -### Example 1: Get an array of Outgoing queue objects specified by name -``` -PS C:\>Get-MsmqOutgoingQueue -Name Order* -``` - -This command gets an array of outgoing queue objects that have the wildcard named Order. - -## PARAMETERS - -### -Name -Specifies an array that contains the name of the outgoing queue. -This parameter supports wildcard characters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqOutgoingQueue](./Clear-MsmqOutgoingQueue.md) - -[Resume-MsmqOutgoingQueue](./Resume-MsmqOutgoingQueue.md) - -[Suspend-MsmqOutgoingQueue](./Suspend-MsmqOutgoingQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Get-MsmqQueue.md b/docset/winserver2012-ps/msmq/Get-MsmqQueue.md deleted file mode 100644 index b8ed4619a4..0000000000 --- a/docset/winserver2012-ps/msmq/Get-MsmqQueue.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/get-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MsmqQueue - -## SYNOPSIS -Gets an array of MsmqQueue objects. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-MsmqQueue [[-Name] ] [-Journal] [-QueueType] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-MsmqQueue [[-Name] ] [-QueueType] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-MsmqQueue [[-Name] ] [-QueueType] [-SubQueue ] -``` - -## DESCRIPTION -The **Get-MsmqQueue** cmdlet gets an array of **MsmqQueue** objects, each of them representing an existing private, public or system queue. -The queue must be local to the machine on which this cmdlet runs. -If you do not specify any parameters this cmdlet will return all Public, Private and System Queues of the host machine. - -## EXAMPLES - -### Example 1: Get an array of MsmqQueue objects -``` -PS C:\>Get-MsmqQueue -Name "Order*" -QueueType Private -``` - -This command gets an array of private MsmqQueue objects that are have the name Order. - -## PARAMETERS - -### -Journal -Indicates that this cmdlet gets the Journal queues that match the **Name** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of a queue. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -QueueType -Specifies the queue type. -If you specify this parameter as PrivateAndPublic, this cmdlet returns all public and private queues that match the **Name** parameter. -If you specify this parameter as Private, this cmdlet returns all private queues that match the **Name** parameter. -If you specify this parameter as Public, this cmdlet returns all public queues that match the **Name** parameter. -If you specify this parameter as SystemDeadLetter, this cmdlet returns all non-transactional dead letter queues that match the **Name** parameter. -If you specify this parameter as SystemJournal, this cmdlet returns all system journal queues that match the **Name** parameter. - -The acceptable values for this parameter are: -- PrivateAndPublic -- Private -- Public -- SystemJournal -- SystemDeadLetter -- SystemTransactionalDeadLetter - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: PrivateAndPublic, Private, Public, SystemJournal, SystemDeadLetter, SystemTransactionalDeadLetter - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SubQueue -Specifies the **subqueue** object for the main queue. -If the subqueue doesn't exist, then this cmdlet will create one implicitly. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqQueue](./Clear-MsmqQueue.md) - -[New-MsmqQueue](./New-MsmqQueue.md) - -[Receive-MsmqQueue](./Receive-MsmqQueue.md) - -[Remove-MsmqQueue](./Remove-MsmqQueue.md) - -[Send-MsmqQueue](./Send-MsmqQueue.md) - -[Set-MsmqQueue](./Set-MsmqQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Get-MsmqQueueACL.md b/docset/winserver2012-ps/msmq/Get-MsmqQueueACL.md deleted file mode 100644 index decfb11c5f..0000000000 --- a/docset/winserver2012-ps/msmq/Get-MsmqQueueACL.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/get-msmqqueueacl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MsmqQueueACL - -## SYNOPSIS -Gets an array of MsmqQueueAcl objects for the specified queues. - -## SYNTAX - -``` -Get-MsmqQueueACL [-InputObject] -``` - -## DESCRIPTION -The **Get-MsmqQueueACL** cmdlet returns an array of **MsmqQueueAcl** objects for the specified queues. -This cmdlet can be applied to private, public, system journal, system dead-letter, and system transactional dead-letter queues. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -### -InputObject -Specifies an array of **MsmqQueue** objects that represent queues for which ACL information is returned. - -```yaml -Type: MessageQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-MsmqQueueACL](./Set-MsmqQueueACL.md) - diff --git a/docset/winserver2012-ps/msmq/Get-MsmqQueueManager.md b/docset/winserver2012-ps/msmq/Get-MsmqQueueManager.md deleted file mode 100644 index 76914bb692..0000000000 --- a/docset/winserver2012-ps/msmq/Get-MsmqQueueManager.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/get-msmqqueuemanager?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MsmqQueueManager - -## SYNOPSIS -Gets a QueueManager state info object that represents the local queue manager. - -## SYNTAX - -``` -Get-MsmqQueueManager -``` - -## DESCRIPTION -The **Get-MsmqQueueManager** cmdlet gets a **QueueManager** state info object that represents the local queue manager. -The cmdlet will call native Microsoft Message queue (MSMQ) APIs to populate the properties of the **QueueManager** object. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-MsmqQueueManager](./Set-MsmqQueueManager.md) - diff --git a/docset/winserver2012-ps/msmq/Get-MsmqQueueManagerACL.md b/docset/winserver2012-ps/msmq/Get-MsmqQueueManagerACL.md deleted file mode 100644 index 17c20ff387..0000000000 --- a/docset/winserver2012-ps/msmq/Get-MsmqQueueManagerACL.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/get-msmqqueuemanageracl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-MsmqQueueManagerACL - -## SYNOPSIS -Gets an array of MsmqQueueManagerAcl objects for the local queue manager. - -## SYNTAX - -``` -Get-MsmqQueueManagerACL -``` - -## DESCRIPTION -The **Get-MsmqQueueManagerACL** cmdlet gets an array of **MsmqQueueManagerAcl** objects for the local queue manager. - -## EXAMPLES - -### 1: -``` - -``` - -## PARAMETERS - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-MsmqQueueManagerACL](./Set-MsmqQueueManagerACL.md) - diff --git a/docset/winserver2012-ps/msmq/MSMQ.md b/docset/winserver2012-ps/msmq/MSMQ.md deleted file mode 100644 index c8d77bec61..0000000000 --- a/docset/winserver2012-ps/msmq/MSMQ.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 1.0.0.0 -Locale: en-US -Module Guid: 33ca09b1-a7fe-42e0-8aa1-e7203746ca94 -Module Name: MSMQ ---- - -# MSMQ_Cmdlets Module -## Description -This reference provides cmdlet descriptions and syntax for all MSMQ-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## MSMQ_Cmdlets Cmdlets -### [Clear-MsmqOutgoingQueue](./Clear-MsmqOutgoingQueue.md) -Purges all outgoing queues that are represented by the supplied MsmqOutgoingQueue objects. - -### [Clear-MsmqQueue](./Clear-MsmqQueue.md) -Clears all queues that are represented by the supplied MessageQueue objects. - -### [Enable-MsmqCertificate](./Enable-MsmqCertificate.md) -Registers a certificate with Active Directory Domain Services. - -### [Get-MsmqCertificate](./Get-MsmqCertificate.md) -Gets an array of object type System.Security.Cryptography.X509Certificates.X509Certificate. - -### [Get-MsmqOutgoingQueue](./Get-MsmqOutgoingQueue.md) -Gets an array of MsmqOutgoingQueue objects, each representing a transactional or non-transactional outgoing queue. - -### [Get-MsmqQueue](./Get-MsmqQueue.md) -Gets an array of MsmqQueue objects. - -### [Get-MsmqQueueACL](./Get-MsmqQueueACL.md) -Gets an array of MsmqQueueAcl objects for the specified queues. - -### [Get-MsmqQueueManager](./Get-MsmqQueueManager.md) -Gets a QueueManager state info object that represents the local queue manager. - -### [Get-MsmqQueueManagerACL](./Get-MsmqQueueManagerACL.md) -Gets an array of MsmqQueueManagerAcl objects for the local queue manager. - -### [Move-MsmqMessage](./Move-MsmqMessage.md) -Moves messages between subqueues of the same queue or between the main queue and one of its subqueues. - -### [New-MsmqMessage](./New-MsmqMessage.md) -Creates a System.Messaging.Message object. - -### [New-MsmqQueue](./New-MsmqQueue.md) -Creates a MSMQ queue. - -### [Receive-MsmqQueue](./Receive-MsmqQueue.md) -Performs a destructive read from a queue. - -### [Remove-MsmqCertificate](./Remove-MsmqCertificate.md) -Removes the specified personal certificate. - -### [Remove-MsmqQueue](./Remove-MsmqQueue.md) -Removes specified queues from the supplied MsmqQueue objects. - -### [Resume-MsmqOutgoingQueue](./Resume-MsmqOutgoingQueue.md) -Resumes specified outgoing queues. - -### [Send-MsmqQueue](./Send-MsmqQueue.md) -Sends a test message to the specified queues. - -### [Set-MsmqQueue](./Set-MsmqQueue.md) -Sets queue properties. - -### [Set-MsmqQueueACL](./Set-MsmqQueueACL.md) -Sets the access rights of specified queues. - -### [Set-MsmqQueueManager](./Set-MsmqQueueManager.md) -Configures the properties of the specified queue manager. - -### [Set-MsmqQueueManagerACL](./Set-MsmqQueueManagerACL.md) -Sets access rights of the local queue manager. - -### [Suspend-MsmqOutgoingQueue](./Suspend-MsmqOutgoingQueue.md) -Suspends the specified outgoing queues. - diff --git a/docset/winserver2012-ps/msmq/Move-MsmqMessage.md b/docset/winserver2012-ps/msmq/Move-MsmqMessage.md deleted file mode 100644 index 8f9cf86bd5..0000000000 --- a/docset/winserver2012-ps/msmq/Move-MsmqMessage.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/move-msmqmessage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Move-MsmqMessage - -## SYNOPSIS -Moves messages between subqueues of the same queue or between the main queue and one of its subqueues. - -## SYNTAX - -``` -Move-MsmqMessage [-Transactional] -DestinationQueue -InputObject - -Message -``` - -## DESCRIPTION -The **Move-MsmqMessage** cmdlet moves messages between subqueues of the same queue or between the main queue and one of its subqueues. -The cmdlet returns a **Message** object representing the message that was moved. -Subqueues are created by this cmdlet implicitly on move or open operations. -You can get subqueues with the Get-MsmqQueue cmdlet. - -## EXAMPLES - -### Example 1: Move a message between two queues -``` -PS C:\>$SrcQueue = Get-MSMQQueue -Private -Name "MyQueue" -PS C:\> $DstQueue = Get-Message = $SrcQueue | Receive-MSMQQueue -Peek -MSMQQueue -Private -Name "MyQueue" -SubQueue "MySubQueue" -PS C:\> $SrcQueue | Move-MSMQMessage -DestinationQueue $DstQueue -Message $Message -``` - -The first command gets a private queue named MyQueue and stores it in the variable named $SrcQueue. -The second command gets a message from $SrcQueue and stores the result in the variable named $DstQueue. -The final command moves the message from $SrcQueue and stores it in the destination queue. - -## PARAMETERS - -### -DestinationQueue -Specifies an **MsmqQueue** object that represents the destination queue to which the message will be moved. -The destination queue can be a subqueue or the main queue. - -```yaml -Type: MessageQueue -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies an **MsmqQueue** object that represents the source queue from which the message will be moved. -The source queue can be a subqueue or the main queue. - -```yaml -Type: MessageQueue -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Message -Specifies a **Message** object representing the message to be moved. - -```yaml -Type: Message -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transactional -Indicates that this cmdlet moves the message within a transaction context. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - diff --git a/docset/winserver2012-ps/msmq/New-MsmqMessage.md b/docset/winserver2012-ps/msmq/New-MsmqMessage.md deleted file mode 100644 index 3be27b2716..0000000000 --- a/docset/winserver2012-ps/msmq/New-MsmqMessage.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/new-msmqmessage?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-MsmqMessage - -## SYNOPSIS -Creates a System.Messaging.Message object. - -## SYNTAX - -``` -New-MsmqMessage [[-Body] ] [-AcknowledgeType] [-AdminQueuePath ] [-Authenticated] [-Journaling] - [-Label ] [-Recoverable] [-ResponseQueuePath ] [-TimeToBeReceived ] - [-TimeToReachQueue ] -``` - -## DESCRIPTION -The **New-MsmqMessage** cmdlet creates a **System.Messaging.Message** object. - -## EXAMPLES - -### Example 1: Create a message object -``` -PS C:\>New-MsmqMessage -Body "Test Message" -Recoverable -AdminQueue ".\private$\adminqueue" -``` - -This command creates a message object with body text named Test Message. - -## PARAMETERS - -### -AcknowledgeType -Specifies the type of acknowledgement messages that can be returned by Messaging Queuing. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: None, PositiveArrival, PositiveReceive, NotAcknowledgeReachQueue, FullReachQueue, NegativeReceive, NotAcknowledgeReceive, FullReceive - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminQueuePath -Specifies the queue that receives the acknowledgement messages that Message Queuing generates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authenticated -Indicates that this cmdlet sends the message as an authenticated message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Specifies the body of the message. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Journaling -Indicates that this cmdlet keeps a copy of the message in a machine journal on the originating computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Label -Specifies a label that describes the message. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recoverable -Indicates that this cmdlet sets the recoverable property of a message object. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseQueuePath -Specifies the queue that receives application-generated response messages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToBeReceived -Specifies the maximum amount of time in milliseconds for the message to be received from the destination queue. -Default is 49.17:02:47.295. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: TTBR - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToReachQueue -Specifies the maximum amount of time in milliseconds for the message to reach the queue. -Default is 49.17:02:47.295. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: TTRQ - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Move-MsmqMessage](./Move-MsmqMessage.md) - diff --git a/docset/winserver2012-ps/msmq/New-MsmqQueue.md b/docset/winserver2012-ps/msmq/New-MsmqQueue.md deleted file mode 100644 index f9e280c82c..0000000000 --- a/docset/winserver2012-ps/msmq/New-MsmqQueue.md +++ /dev/null @@ -1,219 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/new-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-MsmqQueue - -## SYNOPSIS -Creates a MSMQ queue. - -## SYNTAX - -``` -New-MsmqQueue [-Name] [-Authenticate] [-Journaling] [-JournalQuota ] [-Label ] - [-MulticastAddress ] [-PrivacyLevel] [-QueueQuota ] [-QueueType] [-Transactional] -``` - -## DESCRIPTION -The **New-MsmqQueue** cmdlet will create new public or private queues with the properties passed as parameters. -The cmdlet returns **System.Messaging.MessageQueue** objects that represent the created queues. -If the queue type parameter is not explicitly provided, the cmdlet defaults to a private queue. - -## EXAMPLES - -### Example 1: Create a public MsmqQueue -``` -PS C:\>New-MsmqQueue -Name "OrderQueue" -QueueType Public -``` - -This command creates a public MsmqQueue named OrderQueue. - -### Example 2: Create a private MsmqQueue with a quota and multicast address -``` -PS C:\>New-MsmqQueue -Name "OrderQueue" -Authenticate True -QueueQuota 200000 -MulticastAddress "234.12.3:8001" -``` - -This command creates a private MsmqQueue named OrderQueue that has a quota of 200000 and a specific multicast address. - -## PARAMETERS - -### -Authenticate -Indicates that this cmdlet accepts authenticated messages for the queue. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Journaling -Indicates that this cmdlet copies received messages to the journal queue. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalQuota -Specifies the maximum size of the journal queue in KB. -If you do not specify a value the default journal queue quota is used. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Label -Specifies the queue description. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MulticastAddress -Specifies the multicast address associated with the queue. -If you do not specify a value no multicast address is assigned to this queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies an array that this cmdlet assigns the name of a queue. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -PrivacyLevel -Specifies the privacy level associated with the queue. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: None, Optional, Body - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueQuota -Specifies the maximum size of the queue in kilobytes (KB). -If you do not specify a value this cmdlet uses the default queue quote. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueType -Specifies the type of queue this cmdlet creates. -If you specify the value as Private, this cmdlet creates a private queue with the queue name as specified by the **Name** parameter. -If you specify the value as Public, this cmdlet creates a public queue with the queue name as specified by the **Name** parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: Private, Public - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transactional -Indicates that this cmdlet creates a transactional queue at the specified path. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqQueue](./Clear-MsmqQueue.md) - -[Get-MsmqQueue](./Get-MsmqQueue.md) - -[Receive-MsmqQueue](./Receive-MsmqQueue.md) - -[Remove-MsmqQueue](./Remove-MsmqQueue.md) - -[Send-MsmqQueue](./Send-MsmqQueue.md) - -[Set-MsmqQueue](./Set-MsmqQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Receive-MsmqQueue.md b/docset/winserver2012-ps/msmq/Receive-MsmqQueue.md deleted file mode 100644 index ff08c3b1cd..0000000000 --- a/docset/winserver2012-ps/msmq/Receive-MsmqQueue.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/receive-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Receive-MsmqQueue - -## SYNOPSIS -Does a destructive read from a queue. - -## SYNTAX - -### Transactional (Default) -``` -Receive-MsmqQueue [-Count ] [-RetrieveBody] [-Timeout ] [-Transactional] - -InputObject -``` - -### Peek -``` -Receive-MsmqQueue [-Count ] [-Peek] [-RetrieveBody] [-Timeout ] -InputObject -``` - -## DESCRIPTION -The **Receive-MsmqQueue** cmdlet does a destructive read from a queue. -The cmdlet returns the received **System.Messaging.Message** object. -This cmdlet accepts values for the **Name** parameter of path names, format names, and direct format names. -Some other Message Queuing (also known as MSMQ) cmdlets require a friendly name for the queue. -If you specify the **Peek** parameter, the cmdlet peeks at the message instead of doing a destructive read. -The cmdlet succeeds if it returns at least one message. - -If you specify the **Peek** parameter, this cmdlet returns the number of messages that is the minimum of the number supplied by the **Count** parameter and the number of messages in the queue.s - -## EXAMPLES - -### Example 1: Peek at a MsmqQueue message instead of doing a destructive read -```powershell -PS C:\>Get-MsmqQueue -Name "a04bm10\private$\order_queue" | Receive-MsmqQueue -Transactional -Peek -``` - -This command peeks at the queue named a04bm10\private$\order_queue and does not perform a destructive read. - -## PARAMETERS - -### -Count -Specifies the number of messages to be returned. -The default value is 1. -You must specify a value greater than 0. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies a **MessageQueue** object. -The cmdlet reads from the queue that the **MessageQueue** specifies. -This parameter accepts pipeline input. - -```yaml -Type: MessageQueue -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Peek -Indicates that this cmdlet returns a copy of the first message in the queue without removing the message from the queue. - -```yaml -Type: SwitchParameter -Parameter Sets: Peek -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RetrieveBody -Indicates that this cmdlet returns the body of the message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Timeout -Specifies the maximum time, in milliseconds, to wait for the queue to contain a message. -The default value is 0. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transactional -Indicates that this cmdlet performs a transacted retrieval. - -```yaml -Type: SwitchParameter -Parameter Sets: Transactional -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqQueue](./Clear-MsmqQueue.md) - -[Get-MsmqQueue](./Get-MsmqQueue.md) - -[New-MsmqQueue](./New-MsmqQueue.md) - -[Remove-MsmqQueue](./Remove-MsmqQueue.md) - -[Send-MsmqQueue](./Send-MsmqQueue.md) - -[Set-MsmqQueue](./Set-MsmqQueue.md) diff --git a/docset/winserver2012-ps/msmq/Remove-MsmqCertificate.md b/docset/winserver2012-ps/msmq/Remove-MsmqCertificate.md deleted file mode 100644 index ceda6ecc0f..0000000000 --- a/docset/winserver2012-ps/msmq/Remove-MsmqCertificate.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/remove-msmqcertificate?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-MsmqCertificate - -## SYNOPSIS -Removes the specified personal certificate. - -## SYNTAX - -``` -Remove-MsmqCertificate -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-MsmqCertificate** cmdlet removes the personal certificates represented by the supplied certificate objects from Active Directory Domain Services, and returns the removed MSMQ certificate. - -## EXAMPLES - -### Example 1: Remove a personal certificate -``` -PS C:\>Get-MsmqCertificate | Remove-MsmqCertificate -``` - -This command removes a personal certificate objects from Active Directory Domain Services. - -## PARAMETERS - -### -InputObject -Specifies a certificate object that represents a certificate that is removed from the Active Directory Domain Services. - -```yaml -Type: X509Certificate2[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqCertificate](./Get-MsmqCertificate.md) - -[Enable-MsmqCertificate](./Enable-MsmqCertificate.md) - diff --git a/docset/winserver2012-ps/msmq/Remove-MsmqQueue.md b/docset/winserver2012-ps/msmq/Remove-MsmqQueue.md deleted file mode 100644 index cbe481b23f..0000000000 --- a/docset/winserver2012-ps/msmq/Remove-MsmqQueue.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/remove-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-MsmqQueue - -## SYNOPSIS -Removes specified queues from the supplied MsmqQueue objects. - -## SYNTAX - -``` -Remove-MsmqQueue -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-MsmqQueue** cmdlet removes queues that are represented by the supplied **MsmqQueue** objects. -The cmdlet has no return value. - -## EXAMPLES - -### Example 1: Remove a queue -``` -PS C:\>Get-MsmqQueue -Name "Order*" -QueueType Public | Remove-MsmqQueue -``` - -This command removes all public queues that contain the wildcard name Order*. - -## PARAMETERS - -### -InputObject -Specifies an array of **MsmqQueue** objects that represent the queues that will be removed. -This parameter accepts pipelined input. - -```yaml -Type: MessageQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqQueue](./Clear-MsmqQueue.md) - -[Get-MsmqQueue](./Get-MsmqQueue.md) - -[New-MsmqQueue](./New-MsmqQueue.md) - -[Receive-MsmqQueue](./Receive-MsmqQueue.md) - -[Send-MsmqQueue](./Send-MsmqQueue.md) - -[Set-MsmqQueue](./Set-MsmqQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Resume-MsmqOutgoingQueue.md b/docset/winserver2012-ps/msmq/Resume-MsmqOutgoingQueue.md deleted file mode 100644 index 4a5e20f540..0000000000 --- a/docset/winserver2012-ps/msmq/Resume-MsmqOutgoingQueue.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/resume-msmqoutgoingqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Resume-MsmqOutgoingQueue - -## SYNOPSIS -Resumes specified outgoing queues. - -## SYNTAX - -``` -Resume-MsmqOutgoingQueue [-InputObject ] -``` - -## DESCRIPTION -The **Resume-MsmqOutgoingQueue** cmdlet resumes all outgoing queues that are represented by the supplied **MsmqOutgoingQueue** objects. -This cmdlet returns the resumed **MsmqOutgoingQueue** objects. - -## EXAMPLES - -### Example 1: Resume an outgoing queue -``` -PS C:\>Get-MsmqOutgoingQueue -Name "Order*" | Resume-MsmqOutgoingQueue -``` - -This command resumes the outgoing queues that have wildcard named Order*. - -## PARAMETERS - -### -InputObject -Specifies an array of **MsmqOutgoingQueue** objects that represent the outgoing queues to be resumed. -This parameter accepts pipelined input. - -```yaml -Type: OutgoingQueue[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqOutgoingQueue](./Clear-MsmqOutgoingQueue.md) - -[Get-MsmqOutgoingQueue](./Get-MsmqOutgoingQueue.md) - -[Suspend-MsmqOutgoingQueue](./Suspend-MsmqOutgoingQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Send-MsmqQueue.md b/docset/winserver2012-ps/msmq/Send-MsmqQueue.md deleted file mode 100644 index 5f1de968d4..0000000000 --- a/docset/winserver2012-ps/msmq/Send-MsmqQueue.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/send-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Send-MsmqQueue - -## SYNOPSIS -Sends a test message to the specified queues. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Send-MsmqQueue [-Name] [-AcknowledgeType] [-AdminQueuePath ] [-Authenticated] [-Body ] - [-Journaling] [-Label ] [-MessageObject ] [-Recoverable] [-ResponseQueuePath ] - [-TimeToBeReceived ] [-TimeToReachQueue ] [-Transactional] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Send-MsmqQueue [-AcknowledgeType] [-AdminQueuePath ] [-Authenticated] [-Body ] [-Journaling] - [-Label ] [-MessageObject ] [-Recoverable] [-ResponseQueuePath ] - [-TimeToBeReceived ] [-TimeToReachQueue ] [-Transactional] -InputObject -``` - -## DESCRIPTION -The **Send-MsmqQueue** cmdlet sends a test message to one or more remote queues. -Note that the **Name** parameter accepts path names, format names and direct format names, unlike other MSMQ cmdlets that accept only a friendly name for the queue. -This cmdlet sends express messages by default. -It returns a **System.Messaging.Message** object that represents the message sent. - -## EXAMPLES - -### Example 1: Send a test message to a local queue -``` -PS C:\>Get-MsmqQueue -Name "order_queue" | Send-MsmqQueue -Recoverable -Label "From Windows PowerShell" -``` - -This command sends a non-transactional recoverable test message to the local queue named "order_queue" with a label named "From Windows PowerShell". Recoverable messages are written to disk and resilient to system crashes for guaranteed delivery. - -### Example 2: Send a test message to a remote queue with a label -``` -PS C:\>Send-MsmqQueue -Name "FormatName:DIRECT=TCP:10.199.37.61\order_queue" -Transactional -Label "From Windows PowerShell" -``` - -This command sends a transactional test message to the remote queue named "FormatName:DIRECT=TCP:10.199.37.61\order_queue" with a label named "From Windows PowerShell". - -## PARAMETERS - -### -AcknowledgeType -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Accepted values: None, PositiveArrival, PositiveReceive, NotAcknowledgeReachQueue, FullReachQueue, NegativeReceive, NotAcknowledgeReceive, FullReceive - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdminQueuePath -Specifies the pathname of the queue that receives the acknowledgement messages that Message Queuing generates. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authenticated -Indicates that this cmdlet sends the message as an authenticated message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Body -Specifies the body of the message to be sent to the queue. - -```yaml -Type: Object -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies an array of **MessageQueue** objects that represent the destination queues to which the message will be sent. -This parameter accepts pipelined input. - -```yaml -Type: MessageQueue[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Journaling -Indicates whether a copy of the message should be kept in a machine journal on the originating computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Label -Specifies a label that describes the message. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageObject -Specifies a pre-constructed message object that can be passed in as pipelined input. - -```yaml -Type: Message -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the queue. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Recoverable -Indicates that this cmdlet sends the message as a recoverable message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ResponseQueuePath -Specifies the pathname of the queue that receives application-generated response messages. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToBeReceived -Specifies the maximum amount of time for the message to be received from the destination queue. -The default value for this parameter is 49.17:02:47.295. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: TTBR - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TimeToReachQueue -Specifies the maximum amount of time for the message to reach the queue. -The default value for this parameter is 49.17:02:47.295. - -```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: TTRQ - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Transactional -Indicates that this cmdlet sends the message as a transactional message. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqQueue](./Clear-MsmqQueue.md) - -[Get-MsmqQueue](./Get-MsmqQueue.md) - -[New-MsmqQueue](./New-MsmqQueue.md) - -[Receive-MsmqQueue](./Receive-MsmqQueue.md) - -[Remove-MsmqQueue](./Remove-MsmqQueue.md) - -[Set-MsmqQueue](./Set-MsmqQueue.md) diff --git a/docset/winserver2012-ps/msmq/Set-MsmqQueue.md b/docset/winserver2012-ps/msmq/Set-MsmqQueue.md deleted file mode 100644 index 98d9650a30..0000000000 --- a/docset/winserver2012-ps/msmq/Set-MsmqQueue.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/set-msmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MsmqQueue - -## SYNOPSIS -Sets queue properties. - -## SYNTAX - -``` -Set-MsmqQueue [-Authenticate ] [-Journaling ] [-JournalQuota ] [-Label ] - [-MulticastAddress ] [-PrivacyLevel ] [-QueueQuota ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-MsmqQueue** cmdlet sets the properties of the private and public queues that are represented by the supplied **MsmqQueue** objects. -This cmdlet will return an error when supplied with a journal queue, system journal queue, system dead-letter queue, or a system transactional dead-letter queue. -This cmdlet returns an **MsmqQueue** object that represents the modified queue. - -## EXAMPLES - -### Example 1: Set the properties of a specified queue -``` -PS C:\>Get-MsmqQueue -Name "Order*" -QueueType Private | Set-MsmqQueue -QueueQuota 500000 -Journaling -``` - -This command sets the queue quota to 500000 on all queues that have the wildcard named Order*. - -## PARAMETERS - -### -Authenticate -Indicates whether this cmdlet accepts only authenticated messages from the queue. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies an array of **MsmqQueue** objects that represents a queue on which the properties are to be set. -This parameter accepts pipelined input. - -```yaml -Type: MessageQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Journaling -Indicates whether this cmdlet copies received messages to the journal queue. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalQuota -Specifies the maximum size of the journal queue in kilobytes (KB). - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Label -Specifies the queue description that this cmdlet modifies for the queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MulticastAddress -Specifies the multicast address associated with the queue. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrivacyLevel -Specifies the privacy level associated with the queue. - -```yaml -Type: EncryptionRequired -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -QueueQuota -Specifies the maximum size of the queue in kilobytes. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqQueue](./Clear-MsmqQueue.md) - -[Get-MsmqQueue](./Get-MsmqQueue.md) - -[New-MsmqQueue](./New-MsmqQueue.md) - -[Receive-MsmqQueue](./Receive-MsmqQueue.md) - -[Remove-MsmqQueue](./Remove-MsmqQueue.md) - -[Send-MsmqQueue](./Send-MsmqQueue.md) - diff --git a/docset/winserver2012-ps/msmq/Set-MsmqQueueACL.md b/docset/winserver2012-ps/msmq/Set-MsmqQueueACL.md deleted file mode 100644 index 02ff9063ce..0000000000 --- a/docset/winserver2012-ps/msmq/Set-MsmqQueueACL.md +++ /dev/null @@ -1,210 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/set-msmqqueueacl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MsmqQueueACL - -## SYNOPSIS -Sets the access rights of specified queues. - -## SYNTAX - -``` -Set-MsmqQueueACL [-InputObject] [-Allow ] - [-Deny ] [-Remove ] -UserName [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-MsmqQueueACL** cmdlet sets the access rights of the specified queues. -This cmdlet returns the updated **MsmqQueueAcl** object. -This cmdlet can be applied to private, public, journal, system journal, system dead-letter, and system transactional dead-letter queues. - -## EXAMPLES - -### Example 1: Modify the ACLs of queues specified by name -```powershell -PS C:\> $queue = Get-MsmqQueue -Name "Order*" -QueueType Private -PS C:\> $rights = "DeleteQueue", "PeekMessage", "ReceiveMessage", "WriteMessage" -PS C:\> $rights | Foreach-Object { Set-MsmqQueueAcl -InputObject $queue -UserName "CONTOSO\DavidChew" -Allow $PSItem} -PS C:\> Set-MsmqQueueAcl -InputObject $queue -UserName "CONTOSO\DavidChew" -Deny TakeQueueOwnership -``` - -This command gets all the private queues that have names that start with the string Order by using the **Get-MsmqQueue** cmdlet. The current cmdlet modifies the ACL of the queues. - -## PARAMETERS - -### -Allow -Specifies the permissions that are granted to the supplied user account or group. - -The acceptable values for this parameter are: - -- DeleteQueue - Delete the specified queue -- FullControl - Full control of the specified queue -- GetQueuePermissions - Get the permissions of the specified queue -- GetQueueProperties - Get the properties of the specified queue -- ReceiveJournalMessage - Receive messages from the journal queue. This includes the rights to delete and peek messages from the journal queue -- DeleteJournalMessage - Delete messages from the journal queue -- PeekMessage - Peek a message from the specified queue -- ReceiveMessage - Receive messages from the queue. This includes the rights to delete and peek messages -- WriteMessage - Send a message to the specified queue -- DeleteMessage - Delete a message from the specified queue -- ChangeQueuePermissions - Set the permissions of the specified queue -- SetQueueProperties - Set the properties of the specified queue -- TakeQueueOwnership - Assign the specified queue to oneself -- GenericRead - A combination of `GetQueueProperties`, `GetQueuePermissions`, `ReceiveMessage`, and `ReceiveJournalMessage` -- GenericWrite - A combination of `GetQueueProperties`, `GetQueuePermissions`, and `WriteMessage` - -```yaml -Type: MessageQueueAccessRights -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Deny -Specifies the permissions that are revoked from the supplied user account or group. - -The acceptable values for this parameter are: - -- DeleteQueue - Delete the specified queue -- FullControl - Full control of the specified queue -- GetQueuePermissions - Get the permissions of the specified queue -- GetQueueProperties - Get the properties of the specified queue -- ReceiveJournalMessage - Receive messages from the journal queue. This includes the rights to delete and peek messages from the journal queue -- DeleteJournalMessage - Delete messages from the journal queue -- PeekMessage - Peek a message from the specified queue -- ReceiveMessage - Receive messages from the queue. This includes the rights to delete and peek messages -- WriteMessage - Send a message to the specified queue -- DeleteMessage - Delete a message from the specified queue -- ChangeQueuePermissions - Set the permissions of the specified queue -- SetQueueProperties - Set the properties of the specified queue -- TakeQueueOwnership - Assign the specified queue to oneself -- GenericRead - A combination of `GetQueueProperties`, `GetQueuePermissions`, `ReceiveMessage`, and `ReceiveJournalMessage` -- GenericWrite - A combination of `GetQueueProperties`, `GetQueuePermissions`, and `WriteMessage` - -```yaml -Type: MessageQueueAccessRights -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies an array of **MsmqQueue** objects that represent the queues for which permissions are updated. -This parameter accepts pipelined input. - -```yaml -Type: MessageQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -### -Remove -Specifies the permissions that are removed from the supplied user account or group. - -The acceptable values for this parameter are: - -- DeleteQueue - Delete the specified queue -- FullControl - Full control of the specified queue -- GetQueuePermissions - Get the permissions of the specified queue -- GetQueueProperties - Get the properties of the specified queue -- ReceiveJournalMessage - Receive messages from the journal queue. This includes the rights to delete and peek messages from the journal queue -- DeleteJournalMessage - Delete messages from the journal queue -- PeekMessage - Peek a message from the specified queue -- ReceiveMessage - Receive messages from the queue. This includes the rights to delete and peek messages -- WriteMessage - Send a message to the specified queue -- DeleteMessage - Delete a message from the specified queue -- ChangeQueuePermissions - Set the permissions of the specified queue -- SetQueueProperties - Set the properties of the specified queue -- TakeQueueOwnership - Assign the specified queue to oneself -- GenericRead - A combination of `GetQueueProperties`, `GetQueuePermissions`, `ReceiveMessage`, and `ReceiveJournalMessage` -- GenericWrite - A combination of `GetQueueProperties`, `GetQueuePermissions`, and `WriteMessage` - -```yaml -Type: MessageQueueAccessRights -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the user account or group whose permissions are changed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqQueueACL](./Get-MsmqQueueACL.md) - diff --git a/docset/winserver2012-ps/msmq/Set-MsmqQueueManager.md b/docset/winserver2012-ps/msmq/Set-MsmqQueueManager.md deleted file mode 100644 index 0db6dc3196..0000000000 --- a/docset/winserver2012-ps/msmq/Set-MsmqQueueManager.md +++ /dev/null @@ -1,211 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/set-msmqqueuemanager?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MsmqQueueManager - -## SYNOPSIS -Configures the properties of the specified queue manager. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-MsmqQueueManager [-Connect] [-JournalQuota ] [-MessageQuota ] [-MsgLogStore ] - [-MsgStore ] [-RenewEncryptionKey] [-TransactionLogStore ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-MsmqQueueManager [-Disconnect] [-JournalQuota ] [-MessageQuota ] [-MsgLogStore ] - [-MsgStore ] [-RenewEncryptionKey] [-TransactionLogStore ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-MsmqQueueManager [-JournalQuota ] [-MessageQuota ] [-MsgLogStore ] - [-MsgStore ] [-RenewEncryptionKey] [-TransactionLogStore ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-MsmqQueueManager** cmdlet is used to configure the properties of the specified MSMQ queue manager. -After renewing the encryption keys through the parameter **RenewEncryptionKey**, the user must restart the MSMQ service for the new keys to become effective. -This cmdlet returns a **QueueManager** object that represents the modified local queue manager. - -## EXAMPLES - -### Example 1: Specify properties for the specified queue manager -``` -PS C:\>Set-MsmqQueueManager -MessageQuota 2048576 -MsgStoreLocation "c:\MSMQ\MessageFiles" -TransactionLogStore "c:\MSMQ\XactLogs" -``` - -This command specifies the message quota, message store location, and transaction log store for the default queue. - -## PARAMETERS - -### -Connect -Indicates that this cmdlet connects the computer to the network and to the directory service. -This parameter cannot be specified if the **Disconnect** parameter is specified. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Disconnect -Indicates that this cmdlet disconnects the computer from the network and from the directory service. -This parameter cannot be specified if the **Connect** parameter is specified. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -JournalQuota -Specifies the total Journal Message Storage quota for MSMQ. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MessageQuota -Specifies the total Message Storage quota for MSMQ. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsgLogStore -Indicates that this cmdlet changes the message logger storage location and moves over all the message logger files to the new location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MsgStore -Specifies a new location for the message storage and moves over all the message files to the new location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RenewEncryptionKey -Indicates that this cmdlet renews the public encryption key. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TransactionLogStore -Specifies the transaction logger storage location and moves over all the transaction logger files to the new location. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: XactLogStore - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqQueueManager](./Get-MsmqQueueManager.md) - diff --git a/docset/winserver2012-ps/msmq/Set-MsmqQueueManagerACL.md b/docset/winserver2012-ps/msmq/Set-MsmqQueueManagerACL.md deleted file mode 100644 index ff368ebd08..0000000000 --- a/docset/winserver2012-ps/msmq/Set-MsmqQueueManagerACL.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/set-msmqqueuemanageracl?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-MsmqQueueManagerACL - -## SYNOPSIS -Sets access rights of the local queue manager. - -## SYNTAX - -``` -Set-MsmqQueueManagerACL [-Allow ] [-Deny ] - [-Remove ] -UserName [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-MsmqQueueManagerACL** cmdlet sets the access rights of the local queue manager. -This cmdlet returns the updated **MsmqQueueManagerAcl** object. - -## EXAMPLES - -### Example 1: Set the access rights of the local queue manager -``` -PS C:\>Set-MsmqQueueManagerAcl -UserName "CONTOSO\pattiful" -Allow DeleteMessage,PeekMessage -Deny TakeOwnership,SetPermissions -``` - -This command sets the access rights to Allow, DeleteMessage, and PeekMessage for the user named CONTOSO\pattiful on the default queue. -This command also allows the user to take ownership and set permissions on that queue. - -## PARAMETERS - -### -Allow -Specifies the permissions that are granted to the supplied user account or group. - -The acceptable values for this parameter are: - -- AllExtendedRights: All extended rights for the specified queue manager. -- CreateChildObjects: Create child objects with the specified queue manager. -- CreateQueue: Create a queue with the specified queue manager. -- Delete: Delete queues of the specified queue manager. -- DeleteChildObjects: Delete child objects from the specified queue manager. -- FullControl: Full control of the specified queue manager. -- GetPermissions: Get the permissions of the specified queue manager. -- GetProperties: Get the properties of the specified queue manager. -ListContent: List content stored in the queues of the specified queue manager. -- PeekDeadLetter: Peek a message from the specified queue manager's system dead letter queue and transactional dead letter queue. -- PeekJournal: Peek a message from the specified queue manager's system journal queue. -- ReceiveDeadLetter: Receive a message from the specified queue manager's system dead letter queue and transactional dead letter queue. -- ReceiveJournal: Receive a message from the specified queue manager's system journal queue. -- SetPermissions: Set the permissions of the specified queue manager. -- SetProperties: Set the properties of the specified queue manager. -- TakeOwnership: Assign a queue of the specified queue manager to the specified user. - -```yaml -Type: QueueManagerAccessRights -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Deny -Specifies the permissions that are revoked from the supplied user account or group. - -The acceptable values for this parameter are: - -- AllExtendedRights: All extended rights for the specified queue manager. -- CreateChildObjects: Create child objects with the specified queue manager. -- CreateQueue: Create a queue with the specified queue manager. -- Delete: Delete queues of the specified queue manager. -- DeleteChildObjects: Delete child objects from the specified queue manager. -- FullControl: Full control of the specified queue manager. -- GetPermissions: Get the permissions of the specified queue manager. -- GetProperties: Get the properties of the specified queue manager. -- ListContent: List content stored in the queues of the specified queue manager. -- PeekDeadLetter: Peek a message from the specified queue manager's system dead letter queue and transactional dead letter queue. -- PeekJournal: Peek a message from the specified queue manager's system journal queue. -- ReceiveDeadLetter: Receive a message from the specified queue manager's system dead letter queue and transactional dead letter queue. -- ReceiveJournal: Receive a message from the specified queue manager's system journal queue. -- SetPermissions: Set the permissions of the specified queue manager. -- SetProperties: Set the properties of the specified queue manager. -- TakeOwnership: Assign a queue of the specified queue manager to the user. - -```yaml -Type: QueueManagerAccessRights -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -```yaml -Type: QueueManagerAccessRights -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserName -Specifies the user account or group whose permissions are to be changed. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-MsmqQueueManagerACL](./Get-MsmqQueueManagerACL.md) - diff --git a/docset/winserver2012-ps/msmq/Suspend-MsmqOutgoingQueue.md b/docset/winserver2012-ps/msmq/Suspend-MsmqOutgoingQueue.md deleted file mode 100644 index 680f0887b9..0000000000 --- a/docset/winserver2012-ps/msmq/Suspend-MsmqOutgoingQueue.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -external help file: MSMQ_Cmdlets.xml -Module Name: MSMQ -online version: https://learn.microsoft.com/powershell/module/msmq/suspend-msmqoutgoingqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Suspend-MsmqOutgoingQueue - -## SYNOPSIS -Suspends the specified outgoing queues. - -## SYNTAX - -``` -Suspend-MsmqOutgoingQueue -InputObject -``` - -## DESCRIPTION -The **Suspend-MsmqOutgoingQueue** cmdlet suspends all outgoing queues that are represented by the supplied **MsmqOutgoingQueue** objects, and returns the suspended queue objects. - -## EXAMPLES - -### Example 1: Suspend an outgoing queue -``` -PS C:\>Get-MsmqOutgoingQueue -Name "Order*" | Suspend-MsmqOutgoingQueue -``` - -This command suspends all outgoing queues that have the wildcard named Order*. - -## PARAMETERS - -### -InputObject -Specifies an array of **MsmqOutgoingQueue** objects that represent the outgoing queues that are to be suspended. -This parameter accepts pipelined input. - -```yaml -Type: OutgoingQueue[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True(ByValue) -Accept wildcard characters: False -``` - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Clear-MsmqOutgoingQueue](./Clear-MsmqOutgoingQueue.md) - -[Get-MsmqOutgoingQueue](./Get-MsmqOutgoingQueue.md) - -[Resume-MsmqOutgoingQueue](./Resume-MsmqOutgoingQueue.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapter.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapter.md deleted file mode 100644 index f8d5790da2..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapter.md +++ /dev/null @@ -1,268 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapter - -## SYNOPSIS -Disables a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapter [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapter [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapter** cmdlet disables a network adapter. -A network adapter must be enabled to connect to a network. -This cmdlet causes loss of network connectivity of the specified network adapter. -Note: Do not disable the network adapter being used to manage a remote computer. -By default the user will be prompted to confirm the network adapter should be disabled - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapter -Name "Ethernet 2" - - -A version of the cmdlet that uses position. -PS C:\>Disable-NetAdapter "Ethernet 2" - - -A version of the cmdlet that uses position and wildcard characters. -PS C:\>Disable-NetAdapter E*2 -``` - -This example disables a network adapter named Ethernet Connection 2. - -### EXAMPLE 2 -``` -PS C:\>Disable-NetAdapter -Name VMGuestTrafficAdapter -CimSession HyperVServer4 -``` - -This example disables the network adapter named VMGuestTrafficAdapter on the remote computer named HyperVServer4. - -### EXAMPLE 3 -``` -PS C:\>Disable-NetAdapter -Name * -``` - -This example disables all network adapters. -Note: If remotely managing a computer, then all network connectivity will be lost and cannot be remotely restored. - -### EXAMPLE 4 -``` -PS C:\>Disable-NetAdapter -Name MyAdapter -Confirm -Are you sure you want to perform this action? -Disable-NetAdapter ꞌMyAdapter' - - -[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):Y - - -A version of the cmdlet that overrides the default confirmation prompt when disabling the network adapter named MyAdapter. For more information about changing the default confirmation prompt, see the [CODE_Snippit]$ConfirmPreference[CODE_Snippit] variable by running the [CODE_Snippit]Get-Help -Name about_Preference_Variables[CODE_Snippit] cmdlet. -PS C:\>Disable-NetAdapter -Name MyAdapter -Confirm:$false -``` - -This example disables the network adapter named MyAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapter](./Enable-NetAdapter.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterBinding.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterBinding.md deleted file mode 100644 index 300bb1a4dd..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterBinding.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterbinding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterBinding - -## SYNOPSIS -Disables a binding to a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterBinding [-Name] [-AllBindings] [-AsJob] [-CimSession ] - [-ComponentID ] [-DisplayName ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterBinding [-AllBindings] [-AsJob] [-CimSession ] [-ComponentID ] - [-DisplayName ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterBinding [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterBinding** cmdlet disables a binding to a network adapter. -Running this cmdlet causes loss of network connectivity depending on the binding that is disabled. -Note: Disabling some adapter bindings can automatically enable other network adapter bindings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -``` - -This example disables TCP/IPv4 on the network adapter named MyAdapter using the display name Internet Protocol Version 4 (TCP/IPv4) and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Disable-NetAdapterBinding -Name MyAdapter -ComponentID ms_tcpip -``` - -This example disables TCP/IPv4 on the network adapter named MyAdapter using the component ID ms_tcpip and restarts the network adapter. - -### EXAMPLE 3 -``` -PS C:\>Disable-NetAdapterBinding -Name MyAdapter -DisplayName "Inter* (TCP/IPv4)" -``` - -This example disables TCP/IPv4 on network adapter named MyAdapter using a wildcard character in the display name and restarts the network adapter. - -## PARAMETERS - -### -AllBindings -Disables all protocols and filters associated with this network adapter that can be disabled. -Some protocols and filters may be mandatory and therefore cannot be disabled. -Note: Disabling some network adapter bindings can cause other network adapter bindings to automatically be enabled. -Each network adapter binding is disabled only once so after running with this parameter there may still be network adapter bindings that are enabled. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComponentID -Specifies the underlying name of the transport or filter in the following form. - - - `ms_xxxx`, such as `ms_tcpip`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -DisplayName -Specifies the transport or filter name shown in the Networking tab under the network adapter properties in Windows Server® 2012 and later. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters. -If a wildcard character is used to identify a network adapter, then the wildcard character is matched against both hidden and visible adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter BindingSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterBindingSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterBinding](./Enable-NetAdapterBinding.md) - -[Get-NetAdapterBinding](./Get-NetAdapterBinding.md) - -[Set-NetAdapterBinding](./Set-NetAdapterBinding.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterChecksumOffload.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterChecksumOffload.md deleted file mode 100644 index cba964063e..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterChecksumOffload.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterchecksumoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterChecksumOffload - -## SYNOPSIS -Disables the selected checksum offloads on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterChecksumOffload [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-IpIPv4] [-NoRestart] [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit ] [-UdpIPv4] [-UdpIPv6] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IpIPv4] [-NoRestart] [-PassThru] - [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit ] [-UdpIPv4] [-UdpIPv6] -InputObject [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IncludeHidden] [-IpIPv4] [-NoRestart] - [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit ] [-UdpIPv4] [-UdpIPv6] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterChecksumOffload** cmdlet disables the selected checksum offloads on the network adapter. -When specified, IPv4, TCPv4, and TCPv6 checksums can be disabled. -If none of these parameters are passed into this cmdlet, then by default all of the checksums for this adapter are disabled. -Physical network adapters have various checksum offloads in which the checksum calculations occur in the network adapter and not in the main processor. -This reduces processor utilization and can increase network throughput. -This cmdlet disables the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6. -Note: Disabling checksum offload will also disable other stateless offloading including Receive Side Scaling (RSS), Receive Segment Coalescing (RSC) and Large Send Offload (LSO). - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterChecksumOffload -Name * -TcpIPv6 -``` - -This example disables TCP/IPv6 checksum offload on all network adapters and restarts the network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IpIPv4 -Specifies that IPv4 checksum offloading is Disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpIPv4 -Specifies that TCP IPv4 checksum offloading is Disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpIPv6 -Specifies that TCP IPv6 checksum offloading is Disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpIPv4 -Specifies that UDP IPv4 checksum offloading is Disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpIPv6 -Specifies that UDP IPv6 checksum offloading is Disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterChecksumOffload](./Enable-NetAdapterChecksumOffload.md) - -[Get-NetAdapterChecksumOffload](./Get-NetAdapterChecksumOffload.md) - -[Set-NetAdapterChecksumOffload](./Set-NetAdapterChecksumOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterEncapsulatedPacketTaskOffload.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterEncapsulatedPacketTaskOffload.md deleted file mode 100644 index 8902d8fd27..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterEncapsulatedPacketTaskOffload.md +++ /dev/null @@ -1,246 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterencapsulatedpackettaskoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterEncapsulatedPacketTaskOffload - -## SYNOPSIS -Disables encapsulated packet task offload. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterEncapsulatedPacketTaskOffload [-Name] [-AsJob] [-CimSession ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterEncapsulatedPacketTaskOffload** cmdlet disables encapsulated packet task offload. -Encapsulated task offload allows the network adapter to perform offload operations such as large send offload (LSO) and virtual machine queue (VMQ) on the inner header for encapsulated packets. -Network performance may be degraded by running this cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterEncapsulatedPacketTaskOffload -Name MyAdapter -``` - -This example disables encapsulated packet task offload for the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterEncapsulatedPacketTaskOffload](./Enable-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Get-NetAdapterEncapsulatedPacketTaskOffload](./Get-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Set-NetAdapterEncapsulatedPacketTaskOffload](./Set-NetAdapterEncapsulatedPacketTaskOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterIPsecOffload.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterIPsecOffload.md deleted file mode 100644 index 6ad555b55e..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterIPsecOffload.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapteripsecoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterIPsecOffload - -## SYNOPSIS -Disables IPsec offload on the network adapter, so that the network adapter will not perform the per packet encryption operations. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterIPsecOffload [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterIPsecOffload** cmdlet disables IPsec offload on the network adapter, so that the network adapter will not perform the per packet encryption operations. -IPsec offload can increase the network throughput and reduce the processor utilization of the computer. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterIPsecOffload -Name MyAdapter -``` - -This example disables IPsec offload on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter IPsecOffloadV2SettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter IPsecOffloadV2SettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterIPsecOffload](./Enable-NetAdapterIPsecOffload.md) - -[Get-NetAdapterIPsecOffload](./Get-NetAdapterIPsecOffload.md) - -[Set-NetAdapterIPsecOffload](./Set-NetAdapterIPsecOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterLso.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterLso.md deleted file mode 100644 index b746b933d7..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterLso.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterlso?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterLso - -## SYNOPSIS -Disables all large send offload (LSO) properties, such as LSOv4 and LSOv6, of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterLso [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterLso [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterLso [-AsJob] [-CimSession ] [-IPv4] [-IPv6] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterLso** cmdlet disables the state of the large send offload (LSO) settings, such as LSOv4 and LSOv6, on the network adapter. -If neither LSOv4 or LSOv6 is specified, then both are Disabled. -LSO is a technology in which the work of segmenting data into network frames is performed by the network adapter instead of by the TCP/IP stack. -With LSO, TCP/IP sends very large data packets down to the network adapter driver and the network adapter hardware. -The network adapter breaks up the data into smaller network-sized frames. -This increases the speed of large packet send operations and decreases the processor usage of the computer, because the work is performed on the network adapter. -To disable individual LSOv4 or LSOv6, run the Set-NetAdapterLso cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterLso -Name MyAdapter -IPv6 -``` - -This example disables the LSO for IPv6 on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4 -Specifies that this cmdlet affects IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6 -Specifies that this cmdlet affects IPv6 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter LsoSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter LsoSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterLso](./Enable-NetAdapterLso.md) - -[Get-NetAdapterLso](./Get-NetAdapterLso.md) - -[Set-NetAdapterLso](./Set-NetAdapterLso.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterPowerManagement.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterPowerManagement.md deleted file mode 100644 index c412dfaf82..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterPowerManagement.md +++ /dev/null @@ -1,429 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterpowermanagement?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterPowerManagement - -## SYNOPSIS -Disables specific power management features on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterPowerManagement [-Name] [-ArpOffload] [-AsJob] [-CimSession ] - [-D0PacketCoalescing] [-DeviceSleepOnDisconnect] [-IncludeHidden] [-NoRestart] [-NSOffload] [-PassThru] - [-RsnRekeyOffload] [-SelectiveSuspend] [-ThrottleLimit ] [-WakeOnMagicPacket] [-WakeOnPattern] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterPowerManagement [-ArpOffload] [-AsJob] [-CimSession ] [-D0PacketCoalescing] - [-DeviceSleepOnDisconnect] [-NoRestart] [-NSOffload] [-PassThru] [-RsnRekeyOffload] [-SelectiveSuspend] - [-ThrottleLimit ] [-WakeOnMagicPacket] [-WakeOnPattern] -InputObject [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterPowerManagement [-ArpOffload] [-AsJob] [-CimSession ] [-D0PacketCoalescing] - [-DeviceSleepOnDisconnect] [-IncludeHidden] [-NoRestart] [-NSOffload] [-PassThru] [-RsnRekeyOffload] - [-SelectiveSuspend] [-ThrottleLimit ] [-WakeOnMagicPacket] [-WakeOnPattern] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterPowerManagement** cmdlet disables specific power management features on the network adapter. -If no power parameters are specified then all power management features are disabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterPowerManagement -Name "Ethernet 1" -``` - -This example disables power management on the network adapter named Ethernet 1 and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>$netAdapter1 = Get-NetAdapter -Name "Ethernet 3" - - - -PS C:\>Disable-NetAdapterPowerManagement -InputObject $netAdapter1 - - -This cmdlet uses the pipeline to select the network adapter named Ethernet 3 and then pipe that object into this cmdlet. -PS C:\>Get-NetAdapter -Name "Ethernet 3" | Disable-NetAdapterPowerManagement -``` - -This example assigns a variable to the network adapter named Ethernet 3 and then inputs that variable into this cmdlet. - -### EXAMPLE 3 -``` -PS C:\>Disable-NetAdapterManagement -Name "Ethernet 2" -NoRestart -``` - -This example disables power management on the network adapter named Ethernet 2 and specifies that the network adapter is not restarted. - -## PARAMETERS - -### -ArpOffload -Manages the address resolution protocol (ARP) offload capability of the adapter. - -The computer, when in low power mode using the ARP offload technology, is able to offload the responsibility of handling responses for incoming ARP protocol requests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -D0PacketCoalescing -Manages the D0 packet coalescing capability of the network adapter. - -This feature enables power saving on the computer by reducing the number of receive interrupts. -This reduces the number of receive interrupts by coalescing random broadcast or multicast packets. -The processing overhead and power consumption is significantly reduced on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceSleepOnDisconnect -Manages the device sleep on disconnect capability of the network adapter. - -This feature allows the device to stand-by in a low power mode when media is disconnected and wake when media is connected again. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NSOffload -Manages the neighbor solicitation (NS) offload capability of the network adapter. - -The computer, when in low power mode using the NS offload technology, is able to offload the handling of responses for incoming NS protocol requests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RsnRekeyOffload -Manages the Wi-Fi robust security network (RSN) rekey offload capability of the network adapter. - -The computer, when it goes into sleep state, is able to offload the group temporal key (GTK) rekeying for wake on wireless LAN (WoWLAN). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelectiveSuspend -Manages the selective suspend capability of the network adapter. - -The network drive interface specification (NDIS) selective suspend interface allows NDIS to suspend an idle network adapter by transitioning the adapter to a low-power state. -This enables the computer to reduce the power overhead on the CPU and network adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WakeOnMagicPacket -Manages the wake on magic packet capability of the network adapter. - -The magic packet is a broadcast frame containing anywhere within its payload `6` bytes of all `255` (`FF FF FF FF FF FF` in hexadecimal), followed by sixteen repetitions of the 48-bit MAC address of the target computer, for a total of `102` bytes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WakeOnPattern -Manages the wake on pattern capability of the network adapter. - -A wake pattern refers to network packet filters that determine if incoming network traffic should wake the computer. -These patterns can be enabled on the network adapter. - -The following wake patterns may be supported by a network adapter: - - - Wake Pattern - - - Wake on new incoming TCP connection for IPv4 and IPv6 including TCP SYN IPv4 and TCP SYN IPv6. - - - 802.1x re-authentication packets - - - Bitmapped Patterns. -Most network adapters can be programmed with bit-mapped pattern filters. -Bitmapped patterns are defined by a bit-map mask and a pattern filter. -As a network packet is received, it is masked using the bitmap mask and then compared to the pattern filter. -If there is a match, then the network adapter wakes the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter PowerManagementSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter PowerManagementSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterPowerManagement](./Enable-NetAdapterPowerManagement.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterPowerManagement](./Get-NetAdapterPowerManagement.md) - -[Set-NetAdapterPowerManagement](./Set-NetAdapterPowerManagement.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterQos.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterQos.md deleted file mode 100644 index fa71ce07bc..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterQos.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterqos?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterQos - -## SYNOPSIS -Disables quality of service (QoS) on the network adapter, specifically data center bridging (DCB). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterQos [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterQos [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterQos [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterQos** cmdlet disables quality of service (QoS) on a network adapter. -The QoS features, which include bandwidth allocation and priority based flow control, are specified in the IEEE data center bridging (DCB) standard. -When QoS is disabled, the computer will not send to the network adapter any configuration for the QoS features. -This cmdlet does not stop the network adapter from setting up configurations and utilizing the hardware QoS capabilities. - -A network adapter that supports DCB is typically known as a converged network adapter. -It supports both storage and networking functionalities. -In some use cases the DCB must be enabled to support the storage functionalities. -If DCB on a network adapter is disabled from the point of view of a computer, then it may still be functioning on the network adapter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterQos -Name * -``` - -This example disables QoS on all network adapters and restarts the network adapters. - -### EXAMPLE 2 -``` -PS C:\>Disable-NetAdapterQos -Name "Ethernet 2" - - -This is the cmdlet using wildcard characters. -PS C:\>Disable-NetAdapterQos -Name E*2 -``` - -This example disables QoS on a network adapter named Ethernet 2 and restarts the network adapter. - -### EXAMPLE 3 -``` -PS C:\>$netAdapterQoS1 = Get-NetAdapterQos -Name * - - - -PS C:\>Disable-NetAdapterQos -InputObject $netAdapterQoS1 - - -This is a version of the cmdlet that gets all of the network adapters that support QoS and disables QoS on all of them via the pipeline, then restarts the QoS network adapters. -PS C:\>Get-NetAdapterQos -Name * | Disable-NetAdapterQos -``` - -This example gets all of the network adapters that support QoS and disables QoS on all of them and restarts the QoS network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The input object is a list of network adapter objects, such as output from the Get-NetAdapter cmdlet. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance# ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The output object contains QoS capabilities and configurations on a network adapter. -The output object is returned only when **PassThru** parameter is specified. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterQos](./Enable-NetAdapterQos.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterQos](./Get-NetAdapterQos.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterRdma.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterRdma.md deleted file mode 100644 index 15487787a5..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterRdma.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterrdma?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterRdma - -## SYNOPSIS -Disables remote direct memory access (RDMA) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterRdma [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterRdma [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterRdma [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterRdma** cmdlet disables remote direct memory access (RDMA) on the network adapter. -RDMA can increase networking throughput, reduce latency, and reduce processor utilization. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterRdma -Name MyAdapter -``` - -This example disables RDMA on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterRdma](./Enable-NetAdapterRdma.md) - -[Get-NetAdapterRdma](./Get-NetAdapterRdma.md) - -[Set-NetAdapterRdma](./Set-NetAdapterRdma.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterRsc.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterRsc.md deleted file mode 100644 index 4354237ab4..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterRsc.md +++ /dev/null @@ -1,277 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterrsc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterRsc - -## SYNOPSIS -Disables receive segment coalescing (RSC). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterRsc [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterRsc [-AsJob] [-CimSession ] [-IPv4] [-IPv6] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterRsc [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterRsc** cmdlet disables receive segment coalescing (RSC). -If neither IPv4 or IPv6 is specified, then both are disabled. -RSC takes multiple packets that were received within the same interrupt period and combines the packets into a single large package to be processed by the network stack. -This reduces the processing overhead for incoming packets and reduces the number of processor cycles that are used, leading to better scalability. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterRsc -Name MyAdapter -IPv6 -``` - -This example disables RSC for IPv6 on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4 -Specifies that this cmdlet affects IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6 -Specifies that this cmdlet affects IPv6 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterRsc](./Enable-NetAdapterRsc.md) - -[Get-NetAdapterRsc](./Get-NetAdapterRsc.md) - -[Set-NetAdapterRsc](./Set-NetAdapterRsc.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterRss.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterRss.md deleted file mode 100644 index 57c2f8864f..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterRss.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadapterrss?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterRss - -## SYNOPSIS -Disables receive side scaling (RSS) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterRss [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterRss [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterRss [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterRss** cmdlet disables receive side scaling (RSS) on the network adapter. -RSS is a scalability technology that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet. -Without RSS in firstref_longhorn and later, network traffic is processed on the first processor which can quickly reach full utilization limiting receive network throughput. -Running this cmdlet can reduce the performance of servers running Windows Server® 2012 and later. -Various properties can be configured to optimize the performance of RSS. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterRss -Name MyAdapter -``` - -This example disables RSS on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterRss](./Enable-NetAdapterRss.md) - -[Get-NetAdapterRss](./Get-NetAdapterRss.md) - -[Set-NetAdapterRss](./Set-NetAdapterRss.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterSriov.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterSriov.md deleted file mode 100644 index 1b5a5882f4..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterSriov.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadaptersriov?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterSriov - -## SYNOPSIS -Disables Single-Root I/O Virtualization (SR-IOV) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterSriov [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterSriov [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterSriov [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterSriov** cmdlet disables Single-Root I/O Virtualization (SR-IOV) on the network adapter. -SR-IOV enables network traffic to bypass the software switch layer of the Hyper-V virtualization stack. -As a result, the I/O overhead in the software emulation layer is reduced and can achieve network performance that is nearly the same performance as in non-virtualized environments. - -This cmdlet prevents the adapter from using SR-IOV until enabled again. -While SR-IOV is disabled, Windows Server® 2012 and later will not attempt to allocate a virtual function (VF) to a virtual machine (VM). -If VFs from this network adapter are allocated to any VM, then the VFs are revoked and each VM interface reverted to the synthetic network path. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Disable-NetAdapterSriov -Name "Ethernet 1" -``` - -This example disables SR-IOV on the network adapter named Ethernet 1 and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>$netAdapter3 = Get-NetAdapter -Name "Ethernet 3" - - - -PS C:\>Disable-NetAdapterSriov -InputObject $netAdapter3 - - -A version of the cmdlet that uses the pipeline to select the network adapter named Ethernet 3 and pipes that object into this cmdlet. -PS C:\> Get-NetAdapter -Name "Ethernet 3" | Disable-NetAdapterSriov -``` - -This example gets a network adapter named Ethernet 3, and disables the network adapter before restarting the network adapter. - -### EXAMPLE 3 -``` -PS C:\> Disable-NetAdapterSriov -Name "Ethernet 2" -NoRestart -``` - -This example disables SR-IOV on the network adapter named Ethernet 1 without restarting the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The output object contains the network adapter object with SR-IOV disabled. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterSriov](./Enable-NetAdapterSriov.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - -[Get-NetAdapterSriovVf](./Get-NetAdapterSriovVf.md) - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - diff --git a/docset/winserver2012-ps/netadapter/Disable-NetAdapterVmq.md b/docset/winserver2012-ps/netadapter/Disable-NetAdapterVmq.md deleted file mode 100644 index f8492ba46e..0000000000 --- a/docset/winserver2012-ps/netadapter/Disable-NetAdapterVmq.md +++ /dev/null @@ -1,248 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/disable-netadaptervmq?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Disable-NetAdapterVmq - -## SYNOPSIS -Disables the virtual machine queue (VMQ) feature on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Disable-NetAdapterVmq [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Disable-NetAdapterVmq [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Disable-NetAdapterVmq [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Disable-NetAdapterVmq** cmdlet disables the virtual machine queue (VMQ) feature on the network adapter. -VMQ is a scaling networking technology for the Hyper-V switch. -Without VMQ the networking performance of the Hyper-V switch bound to this network adapter may be reduced. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Disable-NetAdapterVmq -Name GuestTrafficAdapter -``` - -This example disables VMQ on the network adapter named GuestTrafficAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Enable-NetAdapterVmq](./Enable-NetAdapterVmq.md) - -[Get-NetAdapterVmq](./Get-NetAdapterVmq.md) - -[Get-NetAdapterVmqQueue](./Get-NetAdapterVmqQueue.md) - -[Set-NetAdapterVmq](./Set-NetAdapterVmq.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapter.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapter.md deleted file mode 100644 index 43790b2de2..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapter.md +++ /dev/null @@ -1,240 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapter - -## SYNOPSIS -Enables a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapter [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapter [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapter** cmdlet enables a network adapter. -A network adapter must be enabled to connect to a network. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapter -Name "Ethernet 2" - - -A version of the cmdlet that uses position. -PS C:\>Enable-NetAdapter "Ethernet 2" - - -A version of the cmdlet that uses position and wildcard characters. -PS C:\>Enable-NetAdapter E*2 -``` - -This example enables the network adapter named Ethernet 2 and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapter -Name VMGuestTrafficAdapter -CimSession HyperVServer4 -``` - -This example enables the network adapter named VMGuestTrafficAdapter on the remote machine named HyperVServer4 and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapter](./Disable-NetAdapter.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterBinding.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterBinding.md deleted file mode 100644 index 7220f6a484..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterBinding.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterbinding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterBinding - -## SYNOPSIS -Enables a binding to a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterBinding [-Name] [-AllBindings] [-AsJob] [-CimSession ] - [-ComponentID ] [-DisplayName ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterBinding [-AllBindings] [-AsJob] [-CimSession ] [-ComponentID ] - [-DisplayName ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterBinding [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterBinding** cmdlet enables binding of a protocol or filter to the network. -By default this cmdlet operates on the protocols and filters visible in the Windows UI Network Adapter properties pages. -Note: Enabling some adapter bindings can automatically disable other network adapter bindings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" - - -This is a version of the cmdlet that enables TCPv4 and IPv4 on the network adapter named MyAdapter using wildcard characters in the display name and restarts the network adapter. -PS C:\>Enable-NetAdapterBinding -Name MyAdapter -DisplayName "Inter* (TCP/IPv4)" -``` - -This example enables TCIPv4 and IPv4 on the network adapter named MyAdapter using the display name and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterBinding -Name MyAdapter -ComponentID ms_tcpip -``` - -This example enables TCPv4 and IPv4 on the network adapter named MyAdapter using the component ID and restarts the network adapter. - -## PARAMETERS - -### -AllBindings -Enables all protocols and filters associated with this network adapter. -Note: Enabling certain network adapter bindings can automatically disable other network adapter bindings. -Each network adapter binding is only enabled once. -Therefore, after running the cmdlet with this parameter specified there may still be network adapter bindings that are disabled. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComponentID -Specifies the underlying name of the transport or filter in the following form. - - - `ms_xxxx`, such as `ms_tcpip`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -DisplayName -Specifies the transport or filter name shown in the Networking tab under the network adapter properties in Windows Server® 2012 and later. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter BindingSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter BindingSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterBinding](./Disable-NetAdapterBinding.md) - -[Get-NetAdapterBinding](./Get-NetAdapterBinding.md) - -[Set-NetAdapterBinding](./Set-NetAdapterBinding.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterChecksumOffload.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterChecksumOffload.md deleted file mode 100644 index 72277f609e..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterChecksumOffload.md +++ /dev/null @@ -1,335 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterchecksumoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterChecksumOffload - -## SYNOPSIS -Enables checksum offloads on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterChecksumOffload [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-IpIPv4] [-NoRestart] [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit ] [-UdpIPv4] [-UdpIPv6] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IncludeHidden] [-IpIPv4] [-NoRestart] - [-PassThru] [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit ] [-UdpIPv4] [-UdpIPv6] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IpIPv4] [-NoRestart] [-PassThru] - [-TcpIPv4] [-TcpIPv6] [-ThrottleLimit ] [-UdpIPv4] [-UdpIPv6] -InputObject [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterChecksumOffload** cmdlet enables checksum offloads on the network adapter. -When specified IPv4, TCPv4, or TCPv6 can be enabled in the transmit, receive, or both directions. -By default all checksums are enabled in both directions. -Physical network adapters have various checksum offloads in which the checksum calculations occur in the network adapter and not in the main processor. -This reduces processor utilization and can increase network throughput. -This cmdlet enables the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6. -Checksum offloading is also required for other stateless offloads to work including receive side scaling (RSS), receive segment coalescing (RSC), and large send offload (LSO). - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterChecksumOffload -Name * -TcpIPv4 -UdpIPv4 -IpIPv4 -``` - -This example enables all IPv4 checksum offloads on all visible network adapters and restarts the network adapters. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterChecksumOffload -Name * -``` - -This example enables all checksum offloads on all visible network adapters and restarts the network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IpIPv4 -Enables checksum offload for IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpIPv4 -Enables checksum offload for TCP IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpIPv6 -Enables checksum offload for TCP IPv6 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpIPv4 -Enables checksum offload for UDP IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpIPv6 -Enables checksum offload for UDP IPv6 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterChecksumOffload](./Disable-NetAdapterChecksumOffload.md) - -[Get-NetAdapterChecksumOffload](./Get-NetAdapterChecksumOffload.md) - -[Set-NetAdapterChecksumOffload](./Set-NetAdapterChecksumOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterEncapsulatedPacketTaskOffload.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterEncapsulatedPacketTaskOffload.md deleted file mode 100644 index 80f8dc4c34..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterEncapsulatedPacketTaskOffload.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterencapsulatedpackettaskoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterEncapsulatedPacketTaskOffload - -## SYNOPSIS -Enables encapsulated packet task offload. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterEncapsulatedPacketTaskOffload [-Name] [-AsJob] [-CimSession ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterEncapsulatedPacketTaskOffload** cmdlet enables encapsulated packet task offload on the network adapter. -This allows the network adapter to perform task offload operations such as large send offload (LSO), virtual machine queue (VMQ), receive side scaling (RSS) based on the inner packet header, or encapsulated packet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterEncapsulatedPacketTaskOffload -Name MyAdapter -``` - -This example enables encapsulated packet task offload for the network adapter named MyAdapter and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterEncapsulatedPacketTaskOffload -Name * -``` - -This example enables encapsulated packet task offload on all encapsulation packet task offload capable network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterEncapsulatedPacketTaskOffload](./Disable-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Get-NetAdapterEncapsulatedPacketTaskOffload](./Get-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Set-NetAdapterEncapsulatedPacketTaskOffload](./Set-NetAdapterEncapsulatedPacketTaskOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterIPsecOffload.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterIPsecOffload.md deleted file mode 100644 index 0e7bee6492..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterIPsecOffload.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapteripsecoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterIPsecOffload - -## SYNOPSIS -Enables IPsec offload on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterIPsecOffload [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterIPsecOffload** cmdlet enables IPsec offload on the network adapter in the AuthHeaderEspEnabled state. -The network adapter will perform the appropriate per-packet encryption operation. -The result is decreased processor utilization and possibly increased network throughput. -Note: The IPsec encryption algorithm supported by the network adapter must also be configured in the IPsec policy before connections can be offloaded. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterIPsecOffload -Name MyAdapter -``` - -This example enables IPsec offload on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterIPsecOffloadV2SettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterIPsecOffloadV2SettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterIPsecOffload](./Disable-NetAdapterIPsecOffload.md) - -[Get-NetAdapterIPsecOffload](./Get-NetAdapterIPsecOffload.md) - -[Set-NetAdapterIPsecOffload](./Set-NetAdapterIPsecOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterLso.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterLso.md deleted file mode 100644 index 816f58b9eb..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterLso.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterlso?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterLso - -## SYNOPSIS -Enables the large send offload (LSO) properties, such as LSOv4 and LSOv6, of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterLso [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterLso [-AsJob] [-CimSession ] [-IPv4] [-IPv6] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterLso [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterLso** cmdlet enables the state of the large send offload (LSO) settings, such as LSOv4 and LSOv6, on the network adapter. -If neither LSOv4 or LSOv6 is specified, then both LSOv4 and LSOv6 are enabled. -LSO is a technology in which the work of segmenting data into network frames is performed by the network adapter instead of by the TCP/IP stack. -With LSO, TCP/IP sends very large data packets down to the network adapter driver and the network adapter hardware. -The network adapter separates the data into smaller network-sized frames. -This increases the speed of high-end send operations and decreases the processor usage of the computer, because the work is performed on the network adapter. -To enable just LSOv4 or LSOv6, run the Set-NetAdapterLso cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterLso -Name * -``` - -This example enables LSO for both IPv4 and IPv6 on all visible network adapters and restarts the network adapters. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterLso -Name * -IPv4 -IPv6 -``` - -This example enables LSO for both IPv4 and IPv6 on all visible network adapters by explicitly specifying the parameters and then restarts the network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4 -Specifies that this cmdlet affects IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6 -Specifies that this cmdlet affects IPv6 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterLsoSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterLsoSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterLso](./Disable-NetAdapterLso.md) - -[Get-NetAdapterLso](./Get-NetAdapterLso.md) - -[Set-NetAdapterLso](./Set-NetAdapterLso.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterPowerManagement.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterPowerManagement.md deleted file mode 100644 index 3246c8460f..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterPowerManagement.md +++ /dev/null @@ -1,421 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterpowermanagement?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterPowerManagement - -## SYNOPSIS -Enables specific power management features on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterPowerManagement [-Name] [-ArpOffload] [-AsJob] [-CimSession ] - [-D0PacketCoalescing] [-DeviceSleepOnDisconnect] [-IncludeHidden] [-NoRestart] [-NSOffload] [-PassThru] - [-RsnRekeyOffload] [-SelectiveSuspend] [-ThrottleLimit ] [-WakeOnMagicPacket] [-WakeOnPattern] - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterPowerManagement [-ArpOffload] [-AsJob] [-CimSession ] [-D0PacketCoalescing] - [-DeviceSleepOnDisconnect] [-IncludeHidden] [-NoRestart] [-NSOffload] [-PassThru] [-RsnRekeyOffload] - [-SelectiveSuspend] [-ThrottleLimit ] [-WakeOnMagicPacket] [-WakeOnPattern] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterPowerManagement [-ArpOffload] [-AsJob] [-CimSession ] [-D0PacketCoalescing] - [-DeviceSleepOnDisconnect] [-NoRestart] [-NSOffload] [-PassThru] [-RsnRekeyOffload] [-SelectiveSuspend] - [-ThrottleLimit ] [-WakeOnMagicPacket] [-WakeOnPattern] -InputObject [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterPowerManagement** cmdlet enables specific power management features on the network adapter. -If no power options are specified, then all supported power management features are enabled. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterPowerManagement -Name "Ethernet 1" -``` - -This example enables power management on the network adapter named Ethernet 1 and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>$netAdapter3 = Get-NetAdapter -Name "Ethernet 3" - - - -PS C:\>Enable-NetAdapterPowerManagement -InputObject $netAdapter3 - - -This is a version of the cmdlet that uses the pipeline to select the network adapter named Ethernet 3 and pipes that object into this cmdlet. -PS C:\>Get-NetAdapter -Name "Ethernet 3" | Enable-NetAdapterPowerManagement -``` - -This example uses the gets the network adapter named Ethernet 3 and enables power management, then restarts the network adapter. - -## PARAMETERS - -### -ArpOffload -Manages the address resolution protocol (ARP) offload capability of the network adapter. - -The computer, when in low power mode using the ARP offload technology, is able to offload the responsibility of handling responses for incoming ARP protocol requests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -D0PacketCoalescing -Manages the D0 packet coalescing capability of the network adapter. - -This feature enables power saving on the computer by reducing the number of receive interrupts. -This reduces the number of receive interrupts by coalescing random broadcast or multicast packets. -The processing overhead and power consumption is significantly reduced on the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceSleepOnDisconnect -Manages the device sleep on disconnect capability of the network adapter. - -This feature allows the device to stand-by in a low power mode when media is disconnected and wake when media is connected again. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NSOffload -Manages the neighbor solicitation (NS) offload capability of the network adapter. - -The computer, when in low power mode using the NS offload technology, is able to offload the handling of responses for incoming NS protocol requests. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RsnRekeyOffload -Manages the Wi-Fi robust security network (RSN) rekey offload capability of the network adapter. - -The computer, when it goes into sleep state, is able to offload the group temporal key (GTK) rekeying for wake on wireless LAN (WoWLAN). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelectiveSuspend -Manages the selective suspend capability of the network adapter. - -The network drive interface specification (NDIS) selective suspend interface allows NDIS to suspend an idle network adapter by transitioning the adapter to a low-power state. -This enables the computer to reduce the power overhead on the processor and network adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WakeOnMagicPacket -Manages the wake on magic packet capability of the network adapter. - -The magic packet is a broadcast frame containing anywhere within its payload `6` bytes of all `255``FF FF FF FF FF FF` in hexadecimal), followed by sixteen repetitions of the 48-bit MAC address of the target computer, for a total of `102` bytes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WakeOnPattern -Manages the wake on pattern capability of the network adapter. - -A wake pattern refers to network packet filters that determine if incoming network traffic should wake the computer. -These patterns can be enabled on the network adapter. - -The following wake patterns may be supported by a network adapter: - - - Wake Pattern. - - - Wake on new incoming TCP connection for IPv4 and IPv6 including TCP SYN IPv4 and TCP SYN IPv6. - - - 802.1x re-authentication packets. - - - Bitmapped Patterns: Most network adapters can be programmed with bit-mapped pattern filters. -Bitmapped patterns are defined by a bit-map mask and a pattern filter. -As a network packet is received, it is masked using the bitmap mask and then compared to the pattern filter. -If there is a match, then the network adapter wakes the computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterPowerManagementSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterPowerManagementSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterPowerManagement](./Disable-NetAdapterPowerManagement.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterPowerManagement](./Get-NetAdapterPowerManagement.md) - -[Set-NetAdapterPowerManagement](./Set-NetAdapterPowerManagement.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterQos.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterQos.md deleted file mode 100644 index 17f15530f6..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterQos.md +++ /dev/null @@ -1,280 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterqos?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterQos - -## SYNOPSIS -Enables quality of service (QoS) on the network adapter, specifically data center bridging (DCB). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterQos [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterQos [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterQos [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterQos** cmdlet enables quality of service (QoS) on a network adapter. -The QoS features, which include traffic class bandwidth allocation and priority based flow control, are specified in the IEEE data center bridging (DCB) standard. -When QoS is enabled and the computer is configured not to accept configurations from a remote device, the computer will send to the network adapter the user-generated configurations for the QoS features. -For more information about the configuring the computer not to accept configurations from a remote device, see the Set-NetQosDcbxSetting cmdlet. -Otherwise, the network adapter will enable the QoS features based on either the factory default configurations or what it receives from the remote device. - -To configure traffic class bandwidth allocation and priority based flow control on the computer, users can run the New-NetQosTrafficClass and the Enable-NetQosFlowControl cmdlets. - -Some switches expect end stations, such as computers running Windows Server® 2012 or later, to accept configurations from the switches. -If the switches detect a mismatched configuration via the data center bridging exchange (DCBX) protocol, then the switches disable the DCB functionalities. -To overcome this limitation, users can disable DCBX on either the switches or the network adapters and manually configure the features on either end. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterQos -Name "DCBNIC1" -``` - -This example enables QoS on a network adapter named DCBNIC1 and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>$netadapter1 = Get-NetAdapterQos -Name * - - - -PS C:\>Enable-NetAdapterQos -InputObject $netadapter1 - - -This is a version of the cmdlet that gets all network adapters that support QoS and enables QoS on all of them via the pipeline, then restarts the network adapter. -PS C:\>Get-NetAdapterQos -Name * | Enable-NetAdapterQos -``` - -This example gets all network adapters that support QoS, enables QoS on all of them, and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceA;ias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The input object is a list of network adapter objects, such as output from the Get-NetAdapter cmdlet. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The output object contains QoS capabilities and configurations on a network adapter. -The output object is returned only when the **PassThru** parameter is specified. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterQos](./Disable-NetAdapterQos.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterQos](./Get-NetAdapterQos.md) - -[Enable-NetQosFlowControl](../dcbqos/Enable-NetQosFlowControl.md) - -[New-NetQosTrafficClass](../dcbqos/New-NetQosTrafficClass.md) - -[Set-NetQosDcbxSetting](../dcbqos/Set-NetQosDcbxSetting.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterRdma.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterRdma.md deleted file mode 100644 index 6394950394..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterRdma.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterrdma?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterRdma - -## SYNOPSIS -Enables remote direct memory access (RDMA) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterRdma [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterRdma [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterRdma [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterRdma** cmdlet enables remote direct memory access (RDMA) on the network adapter. -RDMA can increase networking throughput, reduce latency, and reduce processor utilization. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterRdma -Name MyAdapter -``` - -This example enables RDMA on the RDMA-capable network adapter named MyAdapter and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterRdma -Name * -``` - -This example enables RDMA on all RDMA-capable network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterRdma](./Disable-NetAdapterRdma.md) - -[Get-NetAdapterRdma](./Get-NetAdapterRdma.md) - -[Set-NetAdapterRdma](./Set-NetAdapterRdma.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterRsc.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterRsc.md deleted file mode 100644 index ef4993ac8b..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterRsc.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterrsc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterRsc - -## SYNOPSIS -Enables receive segment coalescing (RSC). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterRsc [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterRsc [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4] [-IPv6] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterRsc [-AsJob] [-CimSession ] [-IPv4] [-IPv6] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterRsc** cmdlet enables receive segment coalescing (RSC). -If the IPv4 or IPv6 is specified, then both are enabled. -RSC takes multiple packets received within the same interrupt period and combines the packets into a single large package to be processed by the network stack. -This reduces the processing overhead for incoming packets and reduces the number of processor cycles that are used, leading to better scalability. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterRsc -Name MyAdapter -IPv4 -``` - -This example enables RSC for IPv4 on the network adapter named MyAdapter and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterRsc -Name MyAdapter -``` - -This example enables RSC for both IPv4 and IPv6 on the network adapter named MyAdapter and restarts the network adapter. - -### EXAMPLE 3 -``` -PS C:\>Enable-NetAdapterRsc -Name * -``` - -This example enables RSC for IPv4 and IPv6 and all RSC capable network adapters and restarts the network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4 -Specifies that this cmdlet affects IPv4 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6 -Specifies that this cmdlet affects IPv6 traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterRsc](./Disable-NetAdapterRsc.md) - -[Get-NetAdapterRsc](./Get-NetAdapterRsc.md) - -[Set-NetAdapterRsc](./Set-NetAdapterRsc.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterRss.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterRss.md deleted file mode 100644 index f37d15d7a3..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterRss.md +++ /dev/null @@ -1,253 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadapterrss?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterRss - -## SYNOPSIS -Enables receive side scaling (RSS) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterRss [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterRss [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterRss [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterRss** cmdlet enables receive side scaling (RSS) on the network adapter. -RSS is a scalability technology that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet. -Without RSS in firstref_longhorn and later, network traffic is received on the first processor which can quickly reach full utilization limiting receive network throughput. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterRss -Name MyAdapter -``` - -This example enables RSS on the network adapter named MyAdapter and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterRss -Name * -``` - -This example enables RSS on all RSS capable network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterRss](./Disable-NetAdapterRss.md) - -[Get-NetAdapterRss](./Get-NetAdapterRss.md) - -[Set-NetAdapterRss](./Set-NetAdapterRss.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterSriov.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterSriov.md deleted file mode 100644 index 8fb2b42545..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterSriov.md +++ /dev/null @@ -1,273 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadaptersriov?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterSriov - -## SYNOPSIS -Enables Single-Root I/O Virtualization (SR-IOV) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterSriov [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterSriov [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterSriov [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterSriov** cmdlet enables Single-Root I/O Virtualization (SR-IOV) on the network adapter. -SR-IOV enables network traffic to by-pass the software switch layer of the Hyper-V virtualization stack. -As a result, the I/O overhead in the software emulation layer is diminished and can achieve network performance that is nearly the same performance as in non-virtualized environments. -SR-IOV can only be used if enabled on the network adapter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterSriov -Name "Ethernet 1" -``` - -This example enables SR-IOV for the network adapter named Ethernet 1 and restarts the network adapter. - -### EXAMPLE 2 -``` -PS C:\>Enable-NetAdapterSriov -InterfaceDescription "Contoso 12345 Gigabit Network Device" -``` - -This example enables SR-IOV for the network adapter with the description Contoso 12345 Gigabit Network Device and restarts the network adapter. - -### EXAMPLE 3 -``` -PS C:\>$netAdapter = Get-NetAdapter -Name "Ethernet 2" - - - -PS C:\>Enable-NetAdapterSriov -InputObject $netAdapter - - -This is a version of the cmdlet that selects the network adapter and pipes the network adapter object into this cmdlet. -PS C:\>Get-NetAdapter -Name "Ethernet 2" | Enable-NetAdapterSriov -``` - -This example inputs the network adapter object into this cmdlet. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterSriov](./Disable-NetAdapterSriov.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - -[Get-NetAdapterSriovVf](./Get-NetAdapterSriovVf.md) - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - diff --git a/docset/winserver2012-ps/netadapter/Enable-NetAdapterVmq.md b/docset/winserver2012-ps/netadapter/Enable-NetAdapterVmq.md deleted file mode 100644 index acfb0d6d56..0000000000 --- a/docset/winserver2012-ps/netadapter/Enable-NetAdapterVmq.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/enable-netadaptervmq?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Enable-NetAdapterVmq - -## SYNOPSIS -Enables virtual machine queue (VMQ) on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Enable-NetAdapterVmq [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Enable-NetAdapterVmq [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Enable-NetAdapterVmq [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Enable-NetAdapterVmq** cmdlet enables virtual machine queue (VMQ) on the network adapter. -VMQ is a scaling networking technology for the Hyper-V switch. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Enable-NetAdapterVmq -Name GuestTrafficAdapter -``` - -This example enables VMQ on the network adapter named GuestTrafficAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. - The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterVmq](./Disable-NetAdapterVmq.md) - -[Get-NetAdapterVmq](./Get-NetAdapterVmq.md) - -[Get-NetAdapterVmqQueue](./Get-NetAdapterVmqQueue.md) - -[Set-NetAdapterVmq](./Set-NetAdapterVmq.md) diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapter.md b/docset/winserver2012-ps/netadapter/Get-NetAdapter.md deleted file mode 100644 index 3be419e707..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapter.md +++ /dev/null @@ -1,293 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapter - -## SYNOPSIS -Gets the basic network adapter properties. - -## SYNTAX - -### ByName (Default) -```powershell -Get-NetAdapter [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] [-Physical] - [-ThrottleLimit ] -``` - -### ByInstanceID -```powershell -Get-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-Physical] [-ThrottleLimit ] - -InterfaceDescription -``` - -### ByIfIndex -```powershell -Get-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-Physical] [-ThrottleLimit ] - -InterfaceIndex -``` - -## DESCRIPTION -The **Get-NetAdapter** cmdlet gets the basic network adapter properties. -By default only visible adapters are returned. -To see the common network adapter properties, pipe the output into the **Format-List** cmdlet. -To see all the properties, pipe the output to the **Format-List** cmdlet with the *Property* parameter specified as the wildcard character "*". -This cmdlet supports multiple views. -The default view is as a table. -To see more information regarding various network adapter identifiers use the **names** view using the **Format-Table** cmdlet with the *View* parameter specified as **name**. -To see more information regarding the miniport, device driver, such as driver date or version use the **driver** view using the **Format-Table** cmdlet with the *View* parameter specified as **driver**. - -## EXAMPLES - -### Example 1: Get all visible network adapters -```powershell -PS C:\> Get-NetAdapter -Name * -``` - -This command gets all of the visible network adapters. - -### Example 2: Get all visible and hidden network adapters -```powershell -PS C:\> Get-NetAdapter -Name * -IncludeHidden -``` - -This command gets all of the network adapters. - -### Example 3: Get all physical network adapters -```powershell -PS C:\> Get-NetAdapter -Name * -Physical -``` - -This command gets all of the physical network adapters. - -### Example 4: Get a network adapter by the specified name -```powershell -PS C:\> Get-NetAdapter -Name "Ethernet 2" -``` - -This command gets the network adapter named Ethernet 2. - -### Example 5: Get a network adapter by the specified name -```powershell -PS C:\> Get-NetAdapter -Name "E*2" -``` - -This command gets adapters starting with "E" and ending in "2" using wildcard characters. - -### Example 6: Display the common properties for the specified network adapter -```powershell -PS C:\> Get-NetAdapter -Name "Ethernet 3" | Format-List -Property * -``` - -This command displays the common properties for the network adapter named Ethernet 3 and formats the list using the **Format-List** cmdlet. - -### Example 7: Display all properties for the specified network adapter -```powershell -PS C:\> Get-NetAdapter -Name "Ethernet 6" | Format-List -Property * -``` - -This command displays all of the properties for the network adapter named Ethernet 6. - -### Example 8: Get all network adapters using the interface description that matches a prefix pattern -```powershell -PS C:\> Get-NetAdapter -Name * -InterfaceDescription "VendorAdapter*" -``` - -This command gets all of the network adapters using the interface description that matches the prefix pattern VendorAdapter. - -### Example 9: Display parameter values for all network adapters -```powershell -PS C:\> Get-NetAdapter -Name "*" -IncludeHidden | Format-List -Property "Name", "InterfaceDescription", "InterfaceName" -``` - -This command displays the *Name*, *InterfaceDescription*, and *InterfaceName* parameter values for all network adapters. - -### Example 10: Get the visible network adapters on the specified server -```powershell -PS C:\> Get-NetAdapter -Name * -CimSession "Server5" -``` - -This command gets the visible network adapters on the server named Server5. -The server named Server5 can be a remote computer. - -### Example 11: Get the visible network adapters and format the output -```powershell -PS C:\> Get-NetAdapter -Name * | Format-Table -View Driver -``` - -This command gets the visible network adapters and formats the output to present driver information. - -### Example 12: Gets visible network adapters and format the output -```powershell -PS C:\> Get-NetAdapter -Name * | Format-Table -View Name -``` - -This command gets the visible network adapters and formats the output to present various names by which a network adapter can be identified such as the *Name*, *InterfaceDescription*, and *InterfaceName* parameter values. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. -Use this parameter to run commands that take a long time to complete. - The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - For more information about Windows PowerShell® background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: ByInstanceID -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -InterfaceIndex -Specifies the network adapter interface index number. - -```yaml -Type: UInt32[] -Parameter Sets: ByIfIndex -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: ByName (Default) -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Physical -Returns all physical network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -[CIM_NetworkAdapter class](/windows/win32/cimwin32prov/cim-networkadapter) - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Format-Table](https://go.microsoft.com/fwlink/p/?LinkID=113303) - -[Disable-NetAdapter](./Disable-NetAdapter.md) - -[Enable-NetAdapter](./Enable-NetAdapter.md) - -[Rename-NetAdapter](./Rename-NetAdapter.md) - -[Restart-NetAdapter](./Restart-NetAdapter.md) - -[Set-NetAdapter](./Set-NetAdapter.md) diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterAdvancedProperty.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterAdvancedProperty.md deleted file mode 100644 index 9871cda548..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterAdvancedProperty.md +++ /dev/null @@ -1,289 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapteradvancedproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterAdvancedProperty - -## SYNOPSIS -Returns the advanced properties for the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-IncludeHidden] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-IncludeHidden] [-ThrottleLimit ] -DisplayName -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -InterfaceDescription -RegistryKeyword -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Get-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -DisplayName -InterfaceDescription -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Get-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -InterfaceDescription -``` - -### UNNAMED_PARAMETER_SET_6 -``` -Get-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-IncludeHidden] [-ThrottleLimit ] -RegistryKeyword -``` - -## DESCRIPTION -The **Get-NetAdapterAdvancedProperty** cmdlet gets the advanced properties for the network adapter. -By default this cmdlet returns advanced properties that have display name values, meaning that these advanced properties are visible in the Advanced pane of the Adapter Properties in the Windows UI. -Advanced properties that do not have display names require that the **AllProperties** parameter is specified. -Individual advanced properties can also be selected either by **DisplayName** or **RegistryKeyword** parameters. -Both of these parameters support the use of wildcard characters. -The advanced properties are normally found in the following location in the registry `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002BE10318}\xxxxxxxx` where `xxxx` is a four character string representing an integer such as `0007`. -The standardized keywords have a RegistryKeyword name that begins with an asterisk (`*`). -The valid values for these keywords are available by piping the output into the Format-Listhttp://go.microsoft.com/fwlink/p/?LinkID=113302 cmdlet with the ValidDisplayValues or the ValidRegistryValues specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * -``` - -This example gets all of the advanced properties that have a display name from all visible network adapters. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * -AllProperties -``` - -This example gets all of the advanced properties from all visible network adapters. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * -RegistryKeyword * -``` - -This example gets all of the advanced properties from all visible network adapters. - -### EXAMPLE 4 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * -AllProperties -IncludeHidden -``` - -This example gets all of the advanced properties from all network adapters. - -### EXAMPLE 5 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * -RegistryKeyword * -IncludeHidden -``` - -This example gets all of the advanced properties from all network adapters. - -### EXAMPLE 6 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name MyAdapter | Format-List -Property * -``` - -This example gets all of the unformatted, advanced properties from the network adapter named MyAdapter. - -### EXAMPLE 7 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * | Where-Object -FilterScript { $_.DisplayName -Like "TCP*" } -``` - -This example gets the advanced properties for network adapters that have a display name that starts with TCP. - -### EXAMPLE 8 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name * | Where-Object -FilterScript { $_.DisplayName -Like "Inter*" } -``` - -This example gets the advanced properties for network adapters that have a display name that starts with Inter. - -## PARAMETERS - -### -AllProperties -Returns all the advanced properties of the network adapter. -If this parameter is not specified, then only advanced properties that have a **DisplayName** parameter are returned. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the advanced property name shown in the Advanced tab under the network adapter properties in Windows Server® 2012 and later. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_5 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_6 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -RegistryKeyword -Contains the name of the registry value to be read, such as one of the registry values found in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002BE10318}\0007. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_6 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[New-NetAdapterAdvancedProperty](./New-NetAdapterAdvancedProperty.md) - -[Remove-NetAdapterAdvancedProperty](./Remove-NetAdapterAdvancedProperty.md) - -[Reset-NetAdapterAdvancedProperty](./Reset-NetAdapterAdvancedProperty.md) - -[Set-NetAdapterAdvancedProperty](./Set-NetAdapterAdvancedProperty.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterBinding.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterBinding.md deleted file mode 100644 index 8ac78dd92b..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterBinding.md +++ /dev/null @@ -1,234 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterbinding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterBinding - -## SYNOPSIS -Returns a list of bindings for a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterBinding [[-Name] ] [-AllBindings] [-AsJob] [-CimSession ] - [-ComponentID ] [-DisplayName ] [-IncludeHidden] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterBinding [-AllBindings] [-AsJob] [-CimSession ] [-ComponentID ] - [-DisplayName ] [-IncludeHidden] [-ThrottleLimit ] -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterBinding** cmdlet returns a list of bindings for a network adapter. -By default only the visible bindings shown in the Networking tab under the Network Adapter properties in Windows UI is returned. -To get all properties for a network adapter, use the **AllProperties** parameter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterBinding -Name MyAdapter -``` - -This example gets the bindings for the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterBinding -Name MyAdapter -AllBindings -``` - -This example gets all of the bindings for the network adapter named MyAdapter (unformatted). - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -``` - -This example gets the state of the TCP/IPv4 on the network adapter named MyAdapter using display name. - -### EXAMPLE 4 -``` -PS C:\>Get-NetAdapterBinding -Name MyAdapter -ComponentID ms_tcpip -``` - -This example gets the state of the TCP/IPv4 transport on MyAdapter using component ID. - -### EXAMPLE 5 -``` -PS C:\>Get-NetAdapterBinding -Name * -DisplayName "Internet*" -``` - -This example gets the state of TCP/IPv4 and TCP/IPv6 on all visible adapters using wildcard characters. - -## PARAMETERS - -### -AllBindings -Returns all the bindings for the network adapter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComponentID -Specifies the underlying name of the transport or filter in the following form. - - - `ms_xxxx`, such as `ms_tcpip`. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -DisplayName -Specifies the transport or filter name shown in the Networking tab under the network adapter properties in Windows Server® 2012 and later. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter BindingSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterBinding](./Disable-NetAdapterBinding.md) - -[Enable-NetAdapterBinding](./Enable-NetAdapterBinding.md) - -[Set-NetAdapterBinding](./Set-NetAdapterBinding.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterChecksumOffload.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterChecksumOffload.md deleted file mode 100644 index d41b19cb88..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterChecksumOffload.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterchecksumoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterChecksumOffload - -## SYNOPSIS -Gets the various checksum offload settings from network adapters that support these checksum offloads. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterChecksumOffload [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterChecksumOffload** cmdlet gets the various checksum offload settings. -Physical network adapters have various checksum offloads in which the checksum calculations occur in the network adapter and not in the main processor. -This reduces processor utilization and can increase network throughput. -This cmdlet gets the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterChecksumOffload -Name MyAdapter -``` - -This example gets the state of checksum offload properties of the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>$networkAdapterCO1 = Get-NetAdapterChecksumOffload -Name MyAdapter - - - -PS C:\>$networkAdapterCO1.ChecksumOffloadHardwareCapabilities -``` - -This example displays the checksum offload hardware capabilities of the network adapter named MyAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the vendors name of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterChecksumOffload](./Disable-NetAdapterChecksumOffload.md) - -[Enable-NetAdapterChecksumOffload](./Enable-NetAdapterChecksumOffload.md) - -[Set-NetAdapterChecksumOffload](./Set-NetAdapterChecksumOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterEncapsulatedPacketTaskOffload.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterEncapsulatedPacketTaskOffload.md deleted file mode 100644 index 31957d46ba..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterEncapsulatedPacketTaskOffload.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterencapsulatedpackettaskoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterEncapsulatedPacketTaskOffload - -## SYNOPSIS -Gets the network adapters that support encapsulated task offload. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterEncapsulatedPacketTaskOffload [[-Name] ] [-AsJob] [-CimSession ] - [-IncludeHidden] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterEncapsulatedPacketTaskOffload** cmdlet gets the network adapters that support encapsulated task offload. -Encapsulated task offload allows the network adapter to perform offload operations such as large send offload (LSO) and virtual machine queue (VMQ) on the inner header for encapsulated packets. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterEncapsulatedPacketTaskOffload -Name * -``` - -This example gets all of the encapsulated packet task offload capable network adapters. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterEncapsulatedPacketTaskOffload -Name MyAdapter -``` - -This example gets the encapsulated packet task offload properties for the network adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterEncapsulatedPacketTaskOffload -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets the encapsulated packet task offload adapters with encapsulated packet task offload enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendors of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterEncapsulatedPacketTaskOffload](./Disable-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Enable-NetAdapterEncapsulatedPacketTaskOffload](./Enable-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Set-NetAdapterEncapsulatedPacketTaskOffload](./Set-NetAdapterEncapsulatedPacketTaskOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterHardwareInfo.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterHardwareInfo.md deleted file mode 100644 index e1b0502910..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterHardwareInfo.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterhardwareinfo?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterHardwareInfo - -## SYNOPSIS -Gets the hardware information of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterHardwareInfo [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterHardwareInfo [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterHardwareInfo** cmdlet gets the hardware information of the network adapter. -This includes PCI capabilities, MSI capabilities, and PCI device custom properties. -Note These are read-only properties. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterHardwareInfo -Name * -``` - -This example displays the default view of hardware properties for all visible network adapters. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterHardwareInfo -Name * | Format-List -Property * -``` - -This example displays all of the hardware information properties for the network adapter named MyAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterHardwareInfoSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterIPsecOffload.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterIPsecOffload.md deleted file mode 100644 index ee9595496d..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterIPsecOffload.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapteripsecoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterIPsecOffload - -## SYNOPSIS -Gets the IPsec offload properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterIPsecOffload [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterIPsecOffload** cmdlet gets the IPsec offload properties of an IPsec offload capable network adapter. -When IPsec Offload is enabled the network adapter will perform the per packet encryption operations which reduces processor utilization. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterIPsecOffload -Name MyAdapter -``` - -This example gets the IPsec offload properties of the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterIPsecOffload -Name MyAdapter | Format-List -Property * -``` - -This example displays all of the IPsec offload properties of the network adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterIPsecOffload -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets all of the IPsec offload capable network adapters with IPsec offload enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter IPsecOffloadV2SettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterIPsecOffload](./Disable-NetAdapterIPsecOffload.md) - -[Enable-NetAdapterIPsecOffload](./Enable-NetAdapterIPsecOffload.md) - -[Set-NetAdapterIPsecOffload](./Set-NetAdapterIPsecOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterLso.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterLso.md deleted file mode 100644 index 139a29f6f7..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterLso.md +++ /dev/null @@ -1,179 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterlso?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterLso - -## SYNOPSIS -Gets the large send offload (LSO) properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterLso [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterLso [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterLso** cmdlet gets the state of large send offload (LSO) settings on the network adapter. -LSO is a technology where the work of segmenting data into network frames is performed by the network adapter instead of by the TCP/IP stack. -With LSO, TCP/IP sends very large data packets down to the network adapter driver and the network adapter hardware. -The network adapter breaks up the data into smaller network-sized frames. -This increases the speed of high-end send operations and decreases the processor usage of the computer, because the work is performed on the network adapter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterLso -Name MyAdapter -``` - -This example gets the LSO properties of the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterLso -Name MyAdapter | Format-List -Property * -``` - -This example displays all of the LSO properties of the network adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterLso -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets all of the network adapters with LSO enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the vendors name of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter LsoSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterLso](./Disable-NetAdapterLso.md) - -[Enable-NetAdapterLso](./Enable-NetAdapterLso.md) - -[Set-NetAdapterLso](./Set-NetAdapterLso.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterPowerManagement.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterPowerManagement.md deleted file mode 100644 index 2186f3b066..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterPowerManagement.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterpowermanagement?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterPowerManagement - -## SYNOPSIS -Gets the power management features of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterPowerManagement [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterPowerManagement [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterPowerManagement** cmdlet gets the state of the power management features of a Power Management capable network adapter. You need to run this cmdlet in an elevated (Run as Administrator) Windows PowerShell session. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetAdapterPowerManagement -Name * -``` - -This example gets all of the power management capable network adapters. - -### EXAMPLE 2 -``` -PS C:\> Get-NetAdapterPowerManagement -Name Ethernet -``` - -This example gets the power management properties of the network adapter named Ethernet. - -### EXAMPLE 3 -``` -PS C:\> Get-NetAdapterPowerManagement -Name Ethernet | Format-List -Property * -``` - -This example displays all of the power management properties of the network adapter named Ethernet. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter PowerManagementSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/?LinkID=113302) - -[Disable-NetAdapterPowerManagement](./Disable-NetAdapterPowerManagement.md) - -[Enable-NetAdapterPowerManagement](./Enable-NetAdapterPowerManagement.md) - -[Set-NetAdapterPowerManagement](./Set-NetAdapterPowerManagement.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterQos.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterQos.md deleted file mode 100644 index 4ed48cac64..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterQos.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterqos?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterQos - -## SYNOPSIS -Gets the quality of service (QoS) properties of the network adapter, specifically data center bridging (DCB) settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterQos [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterQos [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterQos** cmdlet gets quality of service (QoS) capabilities and runtime configurations of a DCB-capable network adapter. -If QoS is disabled, then this cmdlet only gets the hardware QoS capabilities of the network adapter. -If QoS is enabled, then this cmdlet gets the operational traffic class and flow control configurations in addition. -If the network adapter supports the DCB Exchange protocol and is connected to a switch that also supports the protocol, then this cmdlet can also return the QoS configurations on the switch. - -If a network adapter does not support QoS, specifically DCB, then this cmdlet does not return any information. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetAdapterQos -Name * | Where-Object -FilterScript { $_.Enabled } -Name : DCBADAPTER1 -Enabled : True -Capabilities : Hardware Current --------- ------- -MacSecBypass : NotSupported NotSupported -DcbxSupport : IEEE None -NumTCs(Max/ETS/PFC) : 8/8/8 8/8/8 - -OperationalTrafficClasses : TC TSA Bandwidth Priorities --- --- --------- ---------- -0 ETS 40 0-3,5-7 -1 ETS 60 4 - -OperationalFlowControl : Priority 4 Enabled -OperationalClassifications : Not Available -``` - -This example displays the hardware QoS capabilities and the runtime QoS configurations for a network adapter on which QoS is enabled. - -### EXAMPLE 2 -``` -PS C:\> Get-NetAdapterQos -Name * | Where-Object -FilterScript { $_.Enabled -Eq "False" } -Name : DCBADAPTER1 -Enabled : False -Capabilities : Hardware Current --------- ------- -MacSecBypass : NotSupported NotSupported -DcbxSupport : None None -NumTCs(Max/ETS/PFC) : 8/8/8 0/0/0 -``` - -This example displays only the hardware QoS capabilities for a network adapter on which QoS is disabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The output object contains QoS capabilities and configurations on a network adapter. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterQos](./Disable-NetAdapterQos.md) - -[Enable-NetAdapterQos](./Enable-NetAdapterQos.md) - -[Set-NetAdapterQos](./Set-NetAdapterQos.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterRdma.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterRdma.md deleted file mode 100644 index 6dcf9a5be1..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterRdma.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterrdma?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterRdma - -## SYNOPSIS -Gets the remote direct memory access (RDMA) properties for this network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterRdma [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterRdma [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterRdma** cmdlet gets the remote direct memory access (RDMA) properties of an RDMA-capable network adapter. -RDMA is a feature that enables network adapters to transfer data directly between each other without requiring the main processor of the system to be part of that transfer. -This results in lower latency and lower processor utilization. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterRdma -Name MyAdapter -``` - -This example gets the RDMA properties from the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterRdma -Name MyAdapter | Format-List -Property * -``` - -This example displays all the RDMA properties from the adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterRdma -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets all RDMA capable network adapters with RDMA enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterRdma](./Disable-NetAdapterRdma.md) - -[Enable-NetAdapterRdma](./Enable-NetAdapterRdma.md) - -[Set-NetAdapterRdma](./Set-NetAdapterRdma.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterRsc.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterRsc.md deleted file mode 100644 index 462e86ad9d..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterRsc.md +++ /dev/null @@ -1,265 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterrsc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterRsc - -## SYNOPSIS -Gets network adapters that support receive segment coalescing (RSC). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterRsc [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-IPv4FailureReason ] [-IPv4OperationalState ] - [-IPv6FailureReason ] [-IPv6OperationalState ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterRsc [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4FailureReason ] - [-IPv4OperationalState ] [-IPv6FailureReason ] [-IPv6OperationalState ] - [-ThrottleLimit ] -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterRsc** cmdelt gets network adapters that support receive segment coalescing (RSC). -RSC takes multiple packets received within the same interrupt period and combines the packets into a single large package to be processed by the network stack. -This reduces the processing overhead for incoming packets and reduces the number of processor cycles that are used, leading to better scalability. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterRsc -Name MyAdapter -``` - -This example gets the RSC properties of the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterRsc -Name * -``` - -This example gets all of the RSC capable network adapters. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterRsc -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets all of the RSC capable network adapters. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4FailureReason -Returns the reason that RSC may not be working on IPv4 traffic. -The acceptable values for this parameter are: NoFailure, NicPropertyDisabled, WFPCompatibility, NDISCompatibility, ForwardingEnabled, or NetOffloadGlobalDisabled. -If RSC is desired, then the following actions can be taken: - - - NicPropertyDisabled: Run the Enable-NetAdapterRsc cmdlet to enable RSC on the specified network adapter. - - - WFPCompatibility: Disable the WFP filters. - - - NDISCompatibility: Upgrade to an NDIS 6.30 driver. - - - ForwardingEnabled: Disable forwarding. - - - NetOffloadGlobalDisabled: Run the Set-NetOffloadGlobalSetting cmdlet with the **ReceiveSegmentCoalescing** parameter set to Enabled. - -```yaml -Type: FailureReason[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv4OperationalState -Specifies the state of the TCP/IP protocol driver for RSC. -See the **IPv4FailureReason** parameter value for more information. - -```yaml -Type: Boolean[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv6FailureReason -Returns the reason that of RSC may not be working on IPv6 traffic. -The acceptable values for this parameter are: NoFailure, NicPropertyDisabled, WFPCompatibility, NDISCompatibility, ForwardingEnabled, or NetOffloadGlobalDisabled. -If RSC is desired, then the following actions can be taken: - -For NicPropertyDisabled: Run the Enable-NetAdapterRsc cmdlet to enable RSC on the specified network adapter. - - - WFPCompatibility: Disable the WFP filters. - - - NDISCompatibility: Upgrade to an NDIS 6.30 driver. - - - ForwardingEnabled: Disable forwarding. - - - NetOffloadGlobalDisabled: Run the Set-NetOffloadGlobalSetting cmdlet with the **ReceiveSegmentCoalescing** parameter set to Enabled. - -```yaml -Type: FailureReason[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPv6OperationalState -Specifies the state of the TCP/IP protocol driver for RSC. -See the **IPv6FailureReason** parameter value for more information. - -```yaml -Type: Boolean[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkId=113423) - -[Disable-NetAdapterRsc](./Disable-NetAdapterRsc.md) - -[Enable-NetAdapterRsc](./Enable-NetAdapterRsc.md) - -[Set-NetAdapterRsc](./Set-NetAdapterRsc.md) - -[Set-NetOffloadGlobalSetting](../nettcpip/Set-NetOffloadGlobalSetting.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterRss.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterRss.md deleted file mode 100644 index b2309e484f..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterRss.md +++ /dev/null @@ -1,185 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterrss?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterRss - -## SYNOPSIS -Gets receive side scaling (RSS) properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterRss [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterRss [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterRss** cmdlet gets receive side scaling (RSS) properties of the network adapters that support RSS. -RSS is a scalability technology that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet and using an indirection table. -Without RSS in Windows Server® 2012 and later, network traffic is received on the first processor which can quickly reach full utilization limiting receive network throughput. -Various properties can be configured to optimize the performance of RSS. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterRss -Name * -``` - -This example gets all of the RSS capable network adapters. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterRss -Name MyAdapter -``` - -This example gets the RSS properties of the network adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterRss -Name MyAdapter | Format-List -Property * -``` - -This example displays all of the RSS properties of the network adapter named MyAdapter. - -### EXAMPLE 4 -``` -PS C:\>Get-NetAdapterRss -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets all of the RSS capable network adapters with RSS enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterRss](./Disable-NetAdapterRss.md) - -[Enable-NetAdapterRss](./Enable-NetAdapterRss.md) - -[Set-NetAdapterRss](./Set-NetAdapterRss.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterSriov.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterSriov.md deleted file mode 100644 index e824b7747a..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterSriov.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadaptersriov?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterSriov - -## SYNOPSIS -Gets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterSriov [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterSriov [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterSriov** cmdlet gets the Single-Root I/O Virtualization (SR-IOV) properties of network adapters that support SR-IOV. -SR-IOV enables network traffic to by-pass the software switch layer of the Hyper-V virtualization stack. -As a result, the I/O overhead in the software emulation layer is diminished and can achieve network performance that is nearly the same performance as in non-virtualized environments. -Run this cmdlet to display how the hardware is set to support SR-IOV. -This cmdlet will display the properties of the network adapter that relate to SR-IOV, such as the number of ports, and virtual functions (VFs). -The property SriovSupport indicates potential reasons for SR-IOV not functioning properly. -The possible values for SriovSupport include the following. - - - Unknown: Ensure that the computer has hardware support for SR-IOV and that I/O virtualization is enabled in the BIOS. -Also ensure that the computer is running Windows Server® 2012 and later. - - - Supported: SR-IOV is supported and should be functioning properly. - - - MissingAcs: SR-IOV cannot be used on this network adapter as the PCI Express hardware does not support Access Control Services (ACS). -This device may work in an alternate PCI Express slot. -Contact your hardware vendor for further information. - - - MissingPfDriver: SR-IOV cannot be used on this network adapter as the device or device driver does not support SR-IOV. -If the network adapter supports SR-IOV, contact the hardware vendor for an updated driver. - - - NoBusResources: SR-IOV cannot be used on this network adapter as there are not enough PCI Express bus numbers available. - - - NoIoMmuSupport: SR-IOV cannot be used on this computer because of one or more of the following reasons. - - - - The processor does not support second level address translation (SLAT). -For processors manufactured by Intel Corporation™ (Intel™), this feature might be referred to as Extended Page Tables (EPT). -For processors manufactured by Advanced Micro Devices™ (AMD™), this feature might be referred to as Rapid Virtualization Indexing (RVI) or Nested Page Tables (NPT). - - - - The chipset on the computer does not do Interrupt and/or DMA remapping, without which SR-IOV cannot be supported. - - - - This computer has been configured to disable the use of I/O remapping hardware. - - - NoVfBarSpace: SR-IOV cannot be used on this network adapter as there are not enough PCI Express BAR resources available. -This may be due to incorrect or partial configuration in the computer BIOS for Interrupt and DMA remapping. -These settings may be referred to as SR-IOV or input/output memory management unit (IOMMU) support. -If the computer BIOS is correctly configured, this device may work in an alternate PCI Express slot. -Contact the original equipment manufacturer of the computer for further information. - - - NoOscSupport: To use SR-IOV on this computer, the computer BIOS must be updated to allow Windows Server 2012 and later to control PCI Express using `_OSC HandOff`. -Contact the original equipment manufacturer of the computer for an update. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterSriov -Name * -``` - -This example displays the SR-IOV properties for all SR-IOV-capable network adapters. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterSriov -Name "Ethernet 2" -``` - -This example displays the SR-IOV properties for network adapter named Ethernet 2. - -### EXAMPLE 3 -``` -PS C:\>Get-NetAdapterSriov -InterfaceDescription "Contoso 12345 Gigabit Network Device" -``` - -This example displays the SR-IOV properties for the network adapter with the interface description Contoso 12345 Gigabit Network Device. - -### EXAMPLE 4 -``` -PS C:\>Get-NetAdapterSriov -Name * | Where-Object -FilterScript { $_.Enabled -Eq $true } -``` - -This example gets the SR-IOV properties for the network adapter with SR-IOV enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters. -If a wildcard character is used to identify a network adapter, then the wildcard character is matched against both hidden and visible adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. -The name of the network adapter from which to retrieve the SR-IOV properties. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkId=113423) - -[Disable-NetAdapterSriov](./Disable-NetAdapterSriov.md) - -[Enable-NetAdapterSriov](./Enable-NetAdapterSriov.md) - -[Get-NetAdapterSriovVf](./Get-NetAdapterSriovVf.md) - -[Set-NetAdapterSriov](./Set-NetAdapterSriov.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterSriovVf.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterSriovVf.md deleted file mode 100644 index f84b4f1646..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterSriovVf.md +++ /dev/null @@ -1,201 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadaptersriovvf?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterSriovVf - -## SYNOPSIS -Displays the Single-Root I/O Virtualization (SR-IOV) virtual function (VF) settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterSriovVf [[-Name] ] [-AsJob] [-CimSession ] [-FunctionID ] - [-IncludeHidden] [-SwitchID ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterSriovVf [-AsJob] [-CimSession ] [-FunctionID ] [-IncludeHidden] - [-SwitchID ] [-ThrottleLimit ] -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterSriovVf** cmdlet displays the Single-Root I/O Virtualization (SR-IOV) virtual function (VF) settings. -By default a table of VF settings will be displayed that includes the virtual function identifier (ID), virtual function name, network adapter ID, and the current MAC address. -Specifying a single VF will display that VF in more detail. -Additional displayed fields include the permanent MAC address, requester ID, and virtual port (VPort) information. - -The network adapter to use is specified by either the name of the network adapter, interface description of the network adapter, or the switch ID of the virtual switch bound to the SR-IOV network adapter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetAdapterSriovVf -Name "Ethernet 1" -``` - -This example returns a list of the VFs with the VM names and MAC addresses for the network adapter named Wired Ethernet Connection 1. - -### EXAMPLE 2 -``` -PS C:\> Get-NetAdapterSriovVf -SwitchId 2 -``` - -This example returns a list of the VFs with the VM names and MAC addresses for the network adapter bound to virtual switch 2. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunctionID -Specifies the VF ID number on the indicated network adapter to return more detailed information on the VF. - -```yaml -Type: UInt16[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -SwitchID -Specifies the virtual switch ID that identifies the network adapter for one or more VFs. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovVfSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterSriov](./Disable-NetAdapterSriov.md) - -[Enable-NetAdapterSriov](./Enable-NetAdapterSriov.md) - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - -[Set-NetAdapterSriov](./Set-NetAdapterSriov.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterStatistics.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterStatistics.md deleted file mode 100644 index 53c483e1ef..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterStatistics.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadapterstatistics?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterStatistics - -## SYNOPSIS -Gets statistics from the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterStatistics [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterStatistics [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterStatistics** cmdlet gets networking statistics from the network adapter. -The statistics include broadcast, multicast, discards, and errors. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterStatistics -Name MyAdapter -``` - -This example displays the statistics for the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterStatistics -Name MyAdapter | Format-List -Property * -``` - -This example displays all of the statistics for the network adapter named MyAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterStatisticsSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterVPort.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterVPort.md deleted file mode 100644 index e70bad01bd..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterVPort.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadaptervport?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterVPort - -## SYNOPSIS -Displays the network adapter virtual port (VPort) settings for a Single-Root I/O Virtualization (SR-IOV) or virtual machine queue (VMQ) VPort. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterVPort [[-Name] ] [-AsJob] [-CimSession ] [-FunctionID ] - [-IncludeHidden] [-PhysicalFunction] [-SwitchID ] [-ThrottleLimit ] [-VPortID ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterVPort [-AsJob] [-CimSession ] [-FunctionID ] [-IncludeHidden] - [-PhysicalFunction] [-SwitchID ] [-ThrottleLimit ] [-VPortID ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterVPort** cmdlet displays the network adapter virtual port (VPort) settings for a Single-Root I/O Virtualization (SR-IOV) or virtual machine queue (VMQ) VPort. - -Without a VPort specified, this cmdlet displays all VPorts on the network adapter with the port name, number and state. - -Providing a specific VPort ID will display that specific VPort in long format. - -Optionally, this cmdlet displays the SR-IOV virtual function (VF) settings, if the function ID is provided. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetAdapterVPort -Name "Ethernet 2" -``` - -This example displays all VPorts on network adapter named Ethernet 2. - -### EXAMPLE 2 -``` -PS C:\> Get-NetAdapterVPort -Name "Ethernet 2" -VPortID 3 -``` - -This example displays the VPort summary for VPort 3 on the network adapter named Ethernet Connection 2. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FunctionID -Specifies the ID of the SR-IOV VF settings to display. - -```yaml -Type: UInt16[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PhysicalFunction -Specifies the physical function (PF) as the network adapter for the VPort. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SwitchID -Specifies the virtual switch ID to identify which network adapter for one or more VPorts. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VPortID -Specifies the virtual switch port number that will be displayed in long format. - -Without this parameter, all VPorts or the specified range are displayed. -Specifying a VPort will display long format for a single VPort. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVPortSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - -[Get-NetAdapterVmq](./Get-NetAdapterVmq.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterVmq.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterVmq.md deleted file mode 100644 index a3e2169c14..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterVmq.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadaptervmq?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterVmq - -## SYNOPSIS -Gets the virtual machine queue (VMQ) properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterVmq [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterVmq [-AsJob] [-CimSession ] [-IncludeHidden] [-ThrottleLimit ] - -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterVmq** cmdlet gets the virtual machine queue (VMQ) properties of VMQ-capable network adapters. -VMQ is a scaling networking technology for vmswitch that hashes incoming packets based on the destination MAC address. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterVmq -Name GuestTrafficAdapter -``` - -This example gets the VMQ properties of the network adapter named GuestTrafficAdapter. - -### EXAMPLE2 -``` -PS C:\>Get-NetAdapterVmq -Name GuestTrafficAdapter | Format-List -Property * -``` - -This example displays all of the VMQ properties of the network adapter named GuestTrafficAdapter. - -### EXAMPLE3 -``` -PS C:\>Get-NetAdapterVmq -Name * | Where-Object -FilterScript { $_.Enabled } -``` - -This example gets all of the VMQ-capable network adapters with VMQ is enabled. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Where-Object](https://go.microsoft.com/fwlink/p/?LinkID=113423) - -[Disable-NetAdapterVmq](./Disable-NetAdapterVmq.md) - -[Enable-NetAdapterVmq](./Enable-NetAdapterVmq.md) - -[Get-NetAdapterVmqQueue](./Get-NetAdapterVmqQueue.md) - -[Set-NetAdapterVmq](./Set-NetAdapterVmq.md) - diff --git a/docset/winserver2012-ps/netadapter/Get-NetAdapterVmqQueue.md b/docset/winserver2012-ps/netadapter/Get-NetAdapterVmqQueue.md deleted file mode 100644 index 0076ad7e60..0000000000 --- a/docset/winserver2012-ps/netadapter/Get-NetAdapterVmqQueue.md +++ /dev/null @@ -1,174 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/get-netadaptervmqqueue?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetAdapterVmqQueue - -## SYNOPSIS -Gets the virtual machine queues (VMQs) allocated on a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetAdapterVmqQueue [[-Name] ] [-AsJob] [-CimSession ] [-Id ] - [-IncludeHidden] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetAdapterVmqQueue [-AsJob] [-CimSession ] [-Id ] [-IncludeHidden] - [-ThrottleLimit ] -InterfaceDescription -``` - -## DESCRIPTION -The **Get-NetAdapterVmqQueue** cmdlet gets the actual queues used by virtual machine queues (VMQs) that are allocated on a VMQ-capable network adapter. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Get-NetAdapterVmqQueue -Name "Guest Traffic Adapter" -``` - -This example gets the VMQ queues for a network adapter named Guest Traffic Adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Id -Specifies the identifier (ID) of the VMQ to retrieve. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqQueueSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterVmq](./Disable-NetAdapterVmq.md) - -[Enable-NetAdapterVmq](./Enable-NetAdapterVmq.md) - -[Get-NetAdapterVmq](./Get-NetAdapterVmq.md) - -[Set-NetAdapterVmq](./Set-NetAdapterVmq.md) - diff --git a/docset/winserver2012-ps/netadapter/NetAdapter.md b/docset/winserver2012-ps/netadapter/NetAdapter.md deleted file mode 100644 index 34a41b7e8b..0000000000 --- a/docset/winserver2012-ps/netadapter/NetAdapter.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.1.0.0 -Locale: en-US -Module Guid: 1042b422-63a8-4016-a6d6-293e19e8f8a6 -Module Name: NetAdapter ---- - -# NetAdapter Module -## Description -This reference provides cmdlet descriptions and syntax for all Network Adapter-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## NetAdapter Cmdlets -### [Disable-NetAdapter](./Disable-NetAdapter.md) -Disables a network adapter. - -### [Disable-NetAdapterBinding](./Disable-NetAdapterBinding.md) -Disables a binding to a network adapter. - -### [Disable-NetAdapterChecksumOffload](./Disable-NetAdapterChecksumOffload.md) -Disables the selected checksum offloads on the network adapter. - -### [Disable-NetAdapterEncapsulatedPacketTaskOffload](./Disable-NetAdapterEncapsulatedPacketTaskOffload.md) -Disables encapsulated packet task offload. - -### [Disable-NetAdapterIPsecOffload](./Disable-NetAdapterIPsecOffload.md) -Disables IPsec offload on the network adapter, so that the network adapter will not perform the per packet encryption operations. - -### [Disable-NetAdapterLso](./Disable-NetAdapterLso.md) -Disables all large send offload (LSO) properties, such as LSOv4 and LSOv6, of the network adapter. - -### [Disable-NetAdapterPowerManagement](./Disable-NetAdapterPowerManagement.md) -Disables specific power management features on the network adapter. - -### [Disable-NetAdapterQos](./Disable-NetAdapterQos.md) -Disables quality of service (QoS) on the network adapter, specifically data center bridging (DCB). - -### [Disable-NetAdapterRdma](./Disable-NetAdapterRdma.md) -Disables remote direct memory access (RDMA) on the network adapter. - -### [Disable-NetAdapterRsc](./Disable-NetAdapterRsc.md) -Disables receive segment coalescing (RSC). - -### [Disable-NetAdapterRss](./Disable-NetAdapterRss.md) -Disables receive side scaling (RSS) on the network adapter. - -### [Disable-NetAdapterSriov](./Disable-NetAdapterSriov.md) -Disables Single-Root I/O Virtualization (SR-IOV) on the network adapter. - -### [Disable-NetAdapterVmq](./Disable-NetAdapterVmq.md) -Disables the virtual machine queue (VMQ) feature on the network adapter. - -### [Enable-NetAdapter](./Enable-NetAdapter.md) -Enables a network adapter. - -### [Enable-NetAdapterBinding](./Enable-NetAdapterBinding.md) -Enables a binding to a network adapter. - -### [Enable-NetAdapterChecksumOffload](./Enable-NetAdapterChecksumOffload.md) -Enables checksum offloads on the network adapter. - -### [Enable-NetAdapterEncapsulatedPacketTaskOffload](./Enable-NetAdapterEncapsulatedPacketTaskOffload.md) -Enables encapsulated packet task offload. - -### [Enable-NetAdapterIPsecOffload](./Enable-NetAdapterIPsecOffload.md) -Enables IPsec offload on the network adapter. - -### [Enable-NetAdapterLso](./Enable-NetAdapterLso.md) -Enables the large send offload (LSO) properties, such as LSOv4 and LSOv6, of the network adapter. - -### [Enable-NetAdapterPowerManagement](./Enable-NetAdapterPowerManagement.md) -Enables specific power management features on the network adapter. - -### [Enable-NetAdapterQos](./Enable-NetAdapterQos.md) -Enables quality of service (QoS) on the network adapter, specifically data center bridging (DCB). - -### [Enable-NetAdapterRdma](./Enable-NetAdapterRdma.md) -Enables remote direct memory access (RDMA) on the network adapter. - -### [Enable-NetAdapterRsc](./Enable-NetAdapterRsc.md) -Enables receive segment coalescing (RSC). - -### [Enable-NetAdapterRss](./Enable-NetAdapterRss.md) -Enables receive side scaling (RSS) on the network adapter. - -### [Enable-NetAdapterSriov](./Enable-NetAdapterSriov.md) -Enables Single-Root I/O Virtualization (SR-IOV) on the network adapter. - -### [Enable-NetAdapterVmq](./Enable-NetAdapterVmq.md) -Enables virtual machine queue (VMQ) on the network adapter. - -### [Get-NetAdapter](./Get-NetAdapter.md) -Gets the basic network adapter properties. - -### [Get-NetAdapterAdvancedProperty](./Get-NetAdapterAdvancedProperty.md) -Returns the advanced properties for the network adapter. - -### [Get-NetAdapterBinding](./Get-NetAdapterBinding.md) -Returns a list of bindings for a network adapter. - -### [Get-NetAdapterChecksumOffload](./Get-NetAdapterChecksumOffload.md) -Gets the various checksum offload settings from network adapters that support these checksum offloads. - -### [Get-NetAdapterEncapsulatedPacketTaskOffload](./Get-NetAdapterEncapsulatedPacketTaskOffload.md) -Gets the network adapters that support encapsulated task offload. - -### [Get-NetAdapterHardwareInfo](./Get-NetAdapterHardwareInfo.md) -Gets the hardware information of the network adapter. - -### [Get-NetAdapterIPsecOffload](./Get-NetAdapterIPsecOffload.md) -Gets the IPsec offload properties of the network adapter. - -### [Get-NetAdapterLso](./Get-NetAdapterLso.md) -Gets the large send offload (LSO) properties of the network adapter. - -### [Get-NetAdapterPowerManagement](./Get-NetAdapterPowerManagement.md) -Gets the power management features of the network adapter. - -### [Get-NetAdapterQos](./Get-NetAdapterQos.md) -Gets the quality of service (QoS) properties of the network adapter, specifically data center bridging (DCB) settings. - -### [Get-NetAdapterRdma](./Get-NetAdapterRdma.md) -Gets the remote direct memory access (RDMA) properties for this network adapter. - -### [Get-NetAdapterRsc](./Get-NetAdapterRsc.md) -Gets network adapters that support receive segment coalescing (RSC). - -### [Get-NetAdapterRss](./Get-NetAdapterRss.md) -Gets receive side scaling (RSS) properties of the network adapter. - -### [Get-NetAdapterSriov](./Get-NetAdapterSriov.md) -Gets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter. - -### [Get-NetAdapterSriovVf](./Get-NetAdapterSriovVf.md) -Displays the Single-Root I/O Virtualization (SR-IOV) virtual function (VF) settings. - -### [Get-NetAdapterStatistics](./Get-NetAdapterStatistics.md) -Gets statistics from the network adapter. - -### [Get-NetAdapterVmq](./Get-NetAdapterVmq.md) -Gets the virtual machine queue (VMQ) properties of the network adapter. - -### [Get-NetAdapterVmqQueue](./Get-NetAdapterVmqQueue.md) -Gets the virtual machine queues (VMQs) allocated on a network adapter. - -### [Get-NetAdapterVPort](./Get-NetAdapterVPort.md) -Displays the network adapter virtual port (VPort) settings for a Single-Root I/O Virtualization (SR-IOV) or virtual machine queue (VMQ) VPort. - -### [New-NetAdapterAdvancedProperty](./New-NetAdapterAdvancedProperty.md) -Creates a new advanced property for the network adapter. - -### [Remove-NetAdapterAdvancedProperty](./Remove-NetAdapterAdvancedProperty.md) -Removes an advanced property from the network adapter. - -### [Rename-NetAdapter](./Rename-NetAdapter.md) -Renames a network adapter. - -### [Reset-NetAdapterAdvancedProperty](./Reset-NetAdapterAdvancedProperty.md) -Resets the advanced properties of a network adapter to their factory default values. - -### [Restart-NetAdapter](./Restart-NetAdapter.md) -Restarts a network adapter by disabling and then re-enabling the network adapter. - -### [Set-NetAdapter](./Set-NetAdapter.md) -Sets the basic network adapter properties. - -### [Set-NetAdapterAdvancedProperty](./Set-NetAdapterAdvancedProperty.md) -Sets the advanced properties of a network adapter. - -### [Set-NetAdapterBinding](./Set-NetAdapterBinding.md) -Sets the binding state of a transport or filter on a network adapter. - -### [Set-NetAdapterChecksumOffload](./Set-NetAdapterChecksumOffload.md) -Sets the various checksum offload settings. - -### [Set-NetAdapterEncapsulatedPacketTaskOffload](./Set-NetAdapterEncapsulatedPacketTaskOffload.md) -Sets the encapsulated packet task offload property of the network adapter. - -### [Set-NetAdapterIPsecOffload](./Set-NetAdapterIPsecOffload.md) -Sets the IPsec offload properties of the network adapter. - -### [Set-NetAdapterLso](./Set-NetAdapterLso.md) -Sets the large send offload (LSO) properties of the network adapter. - -### [Set-NetAdapterPowerManagement](./Set-NetAdapterPowerManagement.md) -Sets the power management properties on the network adapter. - -### [Set-NetAdapterQos](./Set-NetAdapterQos.md) -Sets the quality of service (QoS) properties of the network adapter, specifically data center bridging (DCB). - -### [Set-NetAdapterRdma](./Set-NetAdapterRdma.md) -Sets the remote direct memory access (RDMA) properties on the network adapter. - -### [Set-NetAdapterRsc](./Set-NetAdapterRsc.md) -Sets the enabled state of receive segment coalescing (RSC). - -### [Set-NetAdapterRss](./Set-NetAdapterRss.md) -Sets the receive side scaling (RSS) properties on the network adapter. - -### [Set-NetAdapterSriov](./Set-NetAdapterSriov.md) -Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), the number of virtual ports (VPorts), and the number of queue pairs for default and non-default VPorts. - -### [Set-NetAdapterVmq](./Set-NetAdapterVmq.md) -Sets the virtual machine queue (VMQ) properties of the network adapter. - diff --git a/docset/winserver2012-ps/netadapter/New-NetAdapterAdvancedProperty.md b/docset/winserver2012-ps/netadapter/New-NetAdapterAdvancedProperty.md deleted file mode 100644 index 7c9f00af08..0000000000 --- a/docset/winserver2012-ps/netadapter/New-NetAdapterAdvancedProperty.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/new-netadapteradvancedproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-NetAdapterAdvancedProperty - -## SYNOPSIS -Creates a new advanced property for the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-NetAdapterAdvancedProperty [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-RegistryDataType ] [-ThrottleLimit ] -RegistryKeyword - -RegistryValue [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-NetAdapterAdvancedProperty [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-RegistryDataType ] [-ThrottleLimit ] -InterfaceDescription - -RegistryKeyword -RegistryValue [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-NetAdapterAdvancedProperty** cmdlet creates a new advanced property for the network adapter. -The intention is that network adapter manufacturers can use this cmdlet to manage advanced properties that are not directly supported by Windows Server® 2012 and later. -Note: This cmdlet is the cmdlet in the network adapter family that creates a registry key. -All other cmdlets read or modify existing registry entries. -Note: The use of wildcards in the network adapter identifier, either in the **Name** parameter or **InterfaceDescription** parameter, is not supported. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>New-NetAdapterAdvancedProperty -Name MyAdapter -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ -``` - -This example creates a new advanced property on the network adapter named MyAdapter with the registry keyword MyKeyword of type REG_SZ with the value 1. - -### EXAMPLE 2 -``` -PS C:\>New-NetAdapterAdvancedProperty -Name MyAdapter -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ -NoRestart -``` - -This example creates a new advanced property on the network adapter named MyAdapter with the registry keyword MyKeyword of type REG_SZ with the value 1 and the network adapter is specified to not restart. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -### EXAMPLE 3 -``` -PS C:\>$networkAdapter3 = Get-NetAdapter -Name "Ethernet 3" - - - -PS C:\>New-NetAdapterAdvancedProperty -InputObject $networkAdapter3 -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ - - -This is a version of the cmdlet that creates a new advanced property on the network adapter named Ethernet 3 using wildcard characters and the pipeline. Note: Use of wildcard characters is not allowed for the network adapter identifier as part of this cmdlet, but can be used via the pipeline. -PS C:\>Get-NetAdapter -Name "Ethernet 3" | New-NetAdapterAdvancedProperty -RegistryKeyword "MyKeyword" -RegistryValue "1" -RegistryDataType REG_SZ -``` - -This example gets a network adapter and creates a new advanced property on the network adapter named Ethernet 3. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryDataType -Specifies the type of the value data to be set in the registry. -The acceptable values for this parameter are: None, REG_SZ, REG_DWORD, REG_QWORD, and REG_MULTI_SZ. - -```yaml -Type: RegDataType -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegistryKeyword -Specifies the name of the registry keyword to be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -RegistryValue -Specifies the value of the advanced property. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-NetAdapterAdvancedProperty](./Get-NetAdapterAdvancedProperty.md) - -[Remove-NetAdapterAdvancedProperty](./Remove-NetAdapterAdvancedProperty.md) - -[Reset-NetAdapterAdvancedProperty](./Reset-NetAdapterAdvancedProperty.md) - -[Set-NetAdapterAdvancedProperty](./Set-NetAdapterAdvancedProperty.md) - diff --git a/docset/winserver2012-ps/netadapter/Remove-NetAdapterAdvancedProperty.md b/docset/winserver2012-ps/netadapter/Remove-NetAdapterAdvancedProperty.md deleted file mode 100644 index 42175219d3..0000000000 --- a/docset/winserver2012-ps/netadapter/Remove-NetAdapterAdvancedProperty.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/remove-netadapteradvancedproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-NetAdapterAdvancedProperty - -## SYNOPSIS -Removes an advanced property from the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] -DisplayName [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -InterfaceDescription -RegistryKeyword - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Remove-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -DisplayName -InterfaceDescription - [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Remove-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] -RegistryKeyword [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Remove-NetAdapterAdvancedProperty [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-NetAdapterAdvancedProperty** cmdlet removes an advanced property from the network adapter. -Note: Advanced properties with a display name may not be removed. -Removing advanced properties could cause unpredictable network behavior. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Remove-NetAdapterAdvancedProperty -Name "MyAdapter" -RegistryKeyword "myKeyword" -AllProperties -``` - -This example removes an advanced property named myKeyword from the network adapter named MyAdapter and restarts the network adapter. -Note: The advanced property named myKeyword does not have a display name, therefore the **AllProperties** parameter must be used. - -## PARAMETERS - -### -AllProperties -Returns all the advanced properties of the network adapter. -If this parameter is not specified, then only advanced properties that have a DisplayName parameter are returned. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the transport or filter name shown in the Networking tab under the network adapter properties in Windows Server® 2012 and later. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryKeyword -Specifies the name of the registry keyword to be removed. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-NetAdapterAdvancedProperty](./Get-NetAdapterAdvancedProperty.md) - -[New-NetAdapterAdvancedProperty](./New-NetAdapterAdvancedProperty.md) - -[Reset-NetAdapterAdvancedProperty](./Reset-NetAdapterAdvancedProperty.md) - -[Set-NetAdapterAdvancedProperty](./Set-NetAdapterAdvancedProperty.md) - diff --git a/docset/winserver2012-ps/netadapter/Rename-NetAdapter.md b/docset/winserver2012-ps/netadapter/Rename-NetAdapter.md deleted file mode 100644 index 19ae5ce0b9..0000000000 --- a/docset/winserver2012-ps/netadapter/Rename-NetAdapter.md +++ /dev/null @@ -1,252 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/rename-netadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-NetAdapter - -## SYNOPSIS -Renames a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Rename-NetAdapter [-Name] [-NewName] [-AsJob] [-CimSession ] [-IncludeHidden] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Rename-NetAdapter [-NewName] [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Rename-NetAdapter [-NewName] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Rename-NetAdapter** cmdlet renames a network adapter. -Note: Only the name, or interface alias, can be changed and not the interface description. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Rename-NetAdapter -Name Ethernet -NewName ManagementAdapter - - -This cmdlet renames a network adapter from the current name, by matching the pattern e*t, to the new name ManagementAdapter. A typical match of e*t is the default name Ethernet. -PS C:\>Rename-NetAdapter -Name E*t -NewName ManagementAdapter -``` - -This example renames a network adapter from the current name of Ethernet to the new name ManagementAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -NewName -Specifies the new name and interface alias of the network adapter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapter](./Disable-NetAdapter.md) - -[Enable-NetAdapter](./Enable-NetAdapter.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Restart-NetAdapter](./Restart-NetAdapter.md) - -[Set-NetAdapter](./Set-NetAdapter.md) - diff --git a/docset/winserver2012-ps/netadapter/Reset-NetAdapterAdvancedProperty.md b/docset/winserver2012-ps/netadapter/Reset-NetAdapterAdvancedProperty.md deleted file mode 100644 index 071bbb385f..0000000000 --- a/docset/winserver2012-ps/netadapter/Reset-NetAdapterAdvancedProperty.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/reset-netadapteradvancedproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Reset-NetAdapterAdvancedProperty - -## SYNOPSIS -Resets the advanced properties of a network adapter to their factory default values. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Reset-NetAdapterAdvancedProperty [[-Name] ] [-AsJob] [-CimSession ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -DisplayName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Reset-NetAdapterAdvancedProperty [-AsJob] [-CimSession ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Reset-NetAdapterAdvancedProperty [-AsJob] [-CimSession ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -DisplayName -InterfaceDescription [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Reset-NetAdapterAdvancedProperty** cmdlet resets the advanced properties or a specific advanced property of a network adapter to one or more of the factory default values. -The advanced property must have the **DisplayName** parameter value specified. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Reset-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName "Interrupt Moderation" - - -This is a version of the cmdlet that resets the advanced property interrupt moderation to the default value, using wildcard characters in the property name. -PS C:\>Reset-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName "Interru*" - - -This is a version of the cmdlet that resets all advanced properties with display names to the default values. -PS C:\>Reset-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName * -``` - -This example resets the advanced property interrupt moderation to the default value. - -### EXAMPLE 2 -``` -PS C:\>Get-NetAdapterAdvancedProperty -Name MyAdapter | Format-List -Property Name, DisplayName, RegistryKeyword, Valid*; - - - -PS C:\>Reset-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName * -``` - -This example displays all of the default values of the advanced properties and then sets all advanced properties with display names to the default values. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the advanced property which is shown in the Advanced tab for the Network Adapter properties page in Windows Server® 2012 and Windows® 8 and later. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkID=113302) - -[Get-NetAdapterAdvancedProperty](./Get-NetAdapterAdvancedProperty.md) - -[New-NetAdapterAdvancedProperty](./New-NetAdapterAdvancedProperty.md) - -[Remove-NetAdapterAdvancedProperty](./Remove-NetAdapterAdvancedProperty.md) - -[Set-NetAdapterAdvancedProperty](./Set-NetAdapterAdvancedProperty.md) - diff --git a/docset/winserver2012-ps/netadapter/Restart-NetAdapter.md b/docset/winserver2012-ps/netadapter/Restart-NetAdapter.md deleted file mode 100644 index ed88124c96..0000000000 --- a/docset/winserver2012-ps/netadapter/Restart-NetAdapter.md +++ /dev/null @@ -1,245 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/restart-netadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Restart-NetAdapter - -## SYNOPSIS -Restarts a network adapter by disabling and then re-enabling the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Restart-NetAdapter [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Restart-NetAdapter [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Restart-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Restart-NetAdapter** cmdlet restarts a network adapter by disabling and then re-enabling the network adapter. -This may be needed for certain properties to take effect in a physical network adapter or to put the network adapter into a known state. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Restart-NetAdapter -Name "Ethernet 2" - - -A version of the cmdlet that uses wildcard characters. -PS C:\>Restart-NetAdapter -Name "E*2" - - -A version of the cmdlet that uses position. -PS C:\>Restart-NetAdapter "Ethernet 2" - - -A version of the cmdlet that uses position and wildcard characters. -PS C:\>Restart-NetAdapter E*2 -``` - -This example restarts the network adapter named Ethernet 2. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapter](./Disable-NetAdapter.md) - -[Enable-NetAdapter](./Enable-NetAdapter.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Rename-NetAdapter](./Rename-NetAdapter.md) - -[Set-NetAdapter](./Set-NetAdapter.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapter.md b/docset/winserver2012-ps/netadapter/Set-NetAdapter.md deleted file mode 100644 index 681369a154..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapter.md +++ /dev/null @@ -1,304 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapter?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapter - -## SYNOPSIS -Sets the basic network adapter properties. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapter [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] [-MacAddress ] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-VlanID ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapter [-AsJob] [-CimSession ] [-IncludeHidden] [-MacAddress ] [-NoRestart] - [-PassThru] [-ThrottleLimit ] [-VlanID ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapter [-AsJob] [-CimSession ] [-MacAddress ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] [-VlanID ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapter** cmdlet sets the basic properties of a network adapter such as virtual LAN (VLAN) identifier (ID) and MAC address. -Note: These changes could disrupt proper networking functionality. -Other network adapter properties may be settable by using a cmdlet such as the Set-NetAdapterRss, Set-NetAdapterLso, or Set-NetAdapterAdvancedProperty cmdlets. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapter -Name "Ethernet 1" -VlanID 10 -``` - -This example sets the network adapter named Ethernet 1 to have VLAN ID 10. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapter -Name "Ethernet 1" -MacAddress "00-10-18-57-1B-0D" -``` - -This example sets the MAC Address of the network adapter named Ethernet 1. - -### EXAMPLE 3 -``` -PS C:\>Set-NetAdapter -InterfaceDescription B*2 -MacAddress "00-10-18-57-1B-0D" -``` - -This example sets the MAC address of a network adapter with the interface description matching the pattern B*2. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -MacAddress -Specifies the current MAC address of the network adapter. -Dashes are optional as part of the input. -Note: Not all network adapters support setting the MAC address. -The address passed in will be also saved in the network addresses property without dashes. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanID -Specifies the VLAN ID of the network adapter. -Note: Not all network adapters support setting the VLAN ID. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapter](./Disable-NetAdapter.md) - -[Enable-NetAdapter](./Enable-NetAdapter.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Rename-NetAdapter](./Rename-NetAdapter.md) - -[Restart-NetAdapter](./Restart-NetAdapter.md) - -[Set-NetAdapterAdvancedProperty](./Set-NetAdapterAdvancedProperty.md) - -[Set-NetAdapterLso](./Set-NetAdapterLso.md) - -[Set-NetAdapterRss](./Set-NetAdapterRss.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterAdvancedProperty.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterAdvancedProperty.md deleted file mode 100644 index a419a6b553..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterAdvancedProperty.md +++ /dev/null @@ -1,361 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapteradvancedproperty?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterAdvancedProperty - -## SYNOPSIS -Sets the advanced properties of a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-DisplayValue ] [-IncludeHidden] [-NoRestart] [-PassThru] [-RegistryValue ] - [-ThrottleLimit ] -DisplayName [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-DisplayValue ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-RegistryValue ] [-ThrottleLimit ] - -InterfaceDescription -RegistryKeyword [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterAdvancedProperty [[-Name] ] [-AllProperties] [-AsJob] [-CimSession ] - [-DisplayValue ] [-IncludeHidden] [-NoRestart] [-PassThru] [-RegistryValue ] - [-ThrottleLimit ] -RegistryKeyword [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-NetAdapterAdvancedProperty [-AllProperties] [-AsJob] [-CimSession ] [-DisplayValue ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-RegistryValue ] [-ThrottleLimit ] - -DisplayName -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -Set-NetAdapterAdvancedProperty [-AsJob] [-CimSession ] [-DisplayValue ] [-NoRestart] - [-PassThru] [-RegistryValue ] [-ThrottleLimit ] -InputObject [-Confirm] - [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterAdvancedProperty** cmdlet sets the advanced properties of a network adapter. -Changes are made directly into the registry for the computer. -Many of the common advanced properties can be controlled via a cmdlet, such as the Set-NetAdapterRss or Set-NetAdapterLso cmdlets. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName "Flow Control" -DisplayValue "Rx and Tx Enabled" -``` - -This example sets the value of the Flow Control advanced property on the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterAdvancedProperty -Name MyAdapter -DisplayName "Flow Control" -DisplayValue "Disable" -``` - -This example sets the value of the Flow Control advanced property on the network adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Set-NetAdapterAdvancedProperty -Name MyAdapter -RegistryKeyword "*Flo*rol" -RegistryValue 0 -``` - -This example sets the value of the Flow Control advanced property on the network adapter named MyAdapter using wildcard characters in the keyword name. - -## PARAMETERS - -### -AllProperties -Returns all the advanced properties of the network adapter. -If this parameter is not specified, then only advanced properties that have a DisplayName parameter are returned. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName -Specifies the display name of the advanced property. -Note: This parameter is normally used in conjunction with the **DisplayValue** parameter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -DisplayValue -Specifies the new value of the advanced property named with the **DisplayName** parameter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_4 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistryKeyword -Specifies the name of the registry keyword to be set. -Note: This parameter is normally used in conjuction with the **RegistryValue** parameter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -RegistryValue -Specifies the value of the advanced property named in the **RegistryKeyword** parameter. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterAdvancedPropertySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Get-NetAdapterAdvancedProperty](./Get-NetAdapterAdvancedProperty.md) - -[New-NetAdapterAdvancedProperty](./New-NetAdapterAdvancedProperty.md) - -[Remove-NetAdapterAdvancedProperty](./Remove-NetAdapterAdvancedProperty.md) - -[Reset-NetAdapterAdvancedProperty](./Reset-NetAdapterAdvancedProperty.md) - -[Set-NetAdapterLso](./Set-NetAdapterLso.md) - -[Set-NetAdapterRss](./Set-NetAdapterRss.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterBinding.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterBinding.md deleted file mode 100644 index 9102aeed27..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterBinding.md +++ /dev/null @@ -1,313 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterbinding?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterBinding - -## SYNOPSIS -Sets the binding state of a transport or filter on a network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterBinding [-Name] [-AllBindings] [-AsJob] [-CimSession ] - [-ComponentID ] [-DisplayName ] [-Enabled ] [-IncludeHidden] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterBinding [-AllBindings] [-AsJob] [-CimSession ] [-ComponentID ] - [-DisplayName ] [-Enabled ] [-IncludeHidden] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterBinding [-AsJob] [-CimSession ] [-Enabled ] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterBinding** cmdlet sets the binding state of a transport or filter on a network adapter. -By default only visible bindings are set unless the **AllBindings** parameter is specified. -If only enabling or disabling bindings, then the Enable-NetAdapterBinding or Disable-NetAdapterBinding cmdlets can be used. -Note: Disabling and enabling a network adapter binding can automatically enable or disable other network adapter bindings. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -Enabled $true -``` - -This example enables TCP/IPv4 on the network adapter named MyAdapter. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterBinding -Name MyAdapter -DisplayName "Internet Protocol Version 4 (TCP/IPv4)" -Enabled $false - - -This is a version of the cmdlet that disables TCP/IPv4 on the network adapter named MyAdapter using wildcard characters in the display name. -PS C:\>Set-NetAdapterBinding -Name MyAdapter -DisplayName "Inter* (TCP/IPv4)" -Enabled $false -``` - -This example disables TCP/IPv4 on the network adapter named MyAdapter. - -### EXAMPLE 3 -``` -PS C:\>Set-NetAdapterBinding -Name MyAdapter -ComponentID ms_tcpip -Enabled $true -``` - -This example enables TCPv4/IPv4 on the network adapter named MyAdapter using the component ID. - -## PARAMETERS - -### -AllBindings -Sets filters or transports that are not visible by default. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ComponentID -Specifies the underlying name of the transport or filter in the following form. - ● `ms_xxxx`, such as `ms_tcpip`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -DisplayName -Specifies the transport or filter name shown in the Networking tab under the network adapter properties in Windows Server® 2012 and later. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Enabled -Sets the enabled state of the transport or filter. -The acceptable values for this parameter are: `$true` or `$false`. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter BindingSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter BindingSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterBinding](./Disable-NetAdapterBinding.md) - -[Enable-NetAdapterBinding](./Enable-NetAdapterBinding.md) - -[Get-NetAdapterBinding](./Get-NetAdapterBinding.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterChecksumOffload.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterChecksumOffload.md deleted file mode 100644 index cc2effb7d5..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterChecksumOffload.md +++ /dev/null @@ -1,350 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterchecksumoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterChecksumOffload - -## SYNOPSIS -Sets the various checksum offload settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterChecksumOffload [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-IpIPv4Enabled ] [-NoRestart] [-PassThru] [-TcpIPv4Enabled ] - [-TcpIPv6Enabled ] [-ThrottleLimit ] [-UdpIPv4Enabled ] - [-UdpIPv6Enabled ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IncludeHidden] - [-IpIPv4Enabled ] [-NoRestart] [-PassThru] [-TcpIPv4Enabled ] - [-TcpIPv6Enabled ] [-ThrottleLimit ] [-UdpIPv4Enabled ] - [-UdpIPv6Enabled ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterChecksumOffload [-AsJob] [-CimSession ] [-IpIPv4Enabled ] [-NoRestart] - [-PassThru] [-TcpIPv4Enabled ] [-TcpIPv6Enabled ] [-ThrottleLimit ] - [-UdpIPv4Enabled ] [-UdpIPv6Enabled ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterChecksumOffload** cmdlet sets the state of the checksum offload properties. -The network adapter computes the checksums, therefore reducing processor utilization because the processor is not performing this computation. -This cmdlet sets the various checksum offload settings, including IPv4, TCPv4, TCPv6, UDPv4, and UDPv6. -This cmdlet enables a few types of checksums while disabling others. -If only setting the enabled state, run the Enable-NetAdapterChecksumOffload or Disable-NetAdapterChecksumOffload cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterChecksumOffload -Name * -IpIPv4Enabled RxTxEnabled -``` - -This example enables the IPv4 checksum offload in both receive and transmit directions on all visible network adapters. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterChecksumOffload -Name MyAdapter -IpIPv4Enabled RxTxEnabled -TcpIpv4Enabled RxTxEnabled -UdpIpv4Enabled RxTxEnabled -``` - -This example enables the IPv4 checksum, the UDPv4 and IPv4 checksum, and the TCPv4 and IPv4 checksum in both receive and transmit directions on the network adapter named MyAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IpIPv4Enabled -Specifies the direction of the IP traffic for IPv4. -The acceptable values for this parameter are: Disabled, RxTxEnabled, RxEnabled, or TxEnabled. -If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. -Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled. - -```yaml -Type: Direction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpIPv4Enabled -Specifies the direction of the TCP traffic for IPv4. -The acceptable values for this parameter are: Disabled, RxTxEnabled, RxEnabled, or TxEnabled. -If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. -Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled. - -```yaml -Type: Direction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TcpIPv6Enabled -Specifies the direction of the TCP traffic for IPv6. -The acceptable values for this parameter are: Disabled, RxTxEnabled, RxEnabled, or TxEnabled. -If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. -Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled. - -```yaml -Type: Direction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpIPv4Enabled -Specifies the direction of the UDP traffic for IPv4. -The acceptable values for this parameter are: Disabled, RxTxEnabled, RxEnabled, or TxEnabled. -If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. -Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled. - -```yaml -Type: Direction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UdpIPv6Enabled -Specifies the direction of the UDP traffic for IPv6. -The acceptable values for this parameter are: Disabled, RxTxEnabled, RxEnabled, or TxEnabled. -If RxEnabled or TxEnabled is selected, then the opposite direction (transmit or receive, respectively) is disabled. -Such as if the state is RxEnabled, then checksum calculations for receive traffic is enabled and for transmit traffic is Disabled. - -```yaml -Type: Direction -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter ChecksumOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterChecksumOffload](./Disable-NetAdapterChecksumOffload.md) - -[Enable-NetAdapterChecksumOffload](./Enable-NetAdapterChecksumOffload.md) - -[Get-NetAdapterChecksumOffload](./Get-NetAdapterChecksumOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterEncapsulatedPacketTaskOffload.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterEncapsulatedPacketTaskOffload.md deleted file mode 100644 index f4e4401af7..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterEncapsulatedPacketTaskOffload.md +++ /dev/null @@ -1,274 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterencapsulatedpackettaskoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterEncapsulatedPacketTaskOffload - -## SYNOPSIS -Sets the encapsulated packet task offload property of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterEncapsulatedPacketTaskOffload [-Name] [-AsJob] [-CimSession ] - [-EncapsulatedPacketTaskOffloadEnabled ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] - [-EncapsulatedPacketTaskOffloadEnabled ] [-IncludeHidden] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterEncapsulatedPacketTaskOffload [-AsJob] [-CimSession ] - [-EncapsulatedPacketTaskOffloadEnabled ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterEncapsulatedPacketTaskOffload** cmdlet sets the encapsulated packet task offload property of the network adapter. -Encapsulated task offload allows the network adapter to perform offload operations such as large send offload (LSO) and virtual machine queue (VMQ) on the inner header for encapsulated packets. -The Enable-NetAdapterEncapsulatedPacketTaskoffload and Disable-NetAdapterEncapsulatedPacketTaskOffload cmdlets can also be used to manage encapsulated packet task offload. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterEncapsulatedPacketTaskOffload -Name MyAdapter -EncapsulatedPacketTaskOffloadEnabled $true -``` - -This example enables encapsulated packet task offload on the network adapter named MyAdapter and restarts the network adapter. -Note: The Enable-NetAdapterEncapsulatedPacketTaskOffload cmdlet is the preferred cmdlet to perform this operation. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterEncapsulatedPacketTaskOffload -Name MyAdapter -EncapsulatedPacketTaskOffloadEnabled $false -``` - -This example disables encapsulated packet task offload on the network adapter named MyAdapter and restarts the network adapter. -Note: The Disable-NetAdapterEncapsulatedPacketTaskOffload cmdlet is the preferred cmdlet to perform this operation. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EncapsulatedPacketTaskOffloadEnabled -Specifies the enabled state of the encapsulated packet task offload in the network adapter. -The acceptable values for this parameter are: `$true` or `$false`. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter EncapsulatedPacketTaskOffloadSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterEncapsulatedPacketTaskOffload](./Disable-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Enable-NetAdapterEncapsulatedPacketTaskOffload](./Enable-NetAdapterEncapsulatedPacketTaskOffload.md) - -[Get-NetAdapterEncapsulatedPacketTaskOffload](./Get-NetAdapterEncapsulatedPacketTaskOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterIPsecOffload.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterIPsecOffload.md deleted file mode 100644 index de5add21d4..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterIPsecOffload.md +++ /dev/null @@ -1,263 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapteripsecoffload?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterIPsecOffload - -## SYNOPSIS -Sets the IPsec offload properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterIPsecOffload [-Name] [-AsJob] [-CimSession ] [-Enabled ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-Enabled ] [-IncludeHidden] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterIPsecOffload [-AsJob] [-CimSession ] [-Enabled ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterIPsecOffload** cmdlet sets the IPsec offload properties of the network adapter. -When IPsec offload is enabled the network adapter will perform the per packet encryption operations which reduces processor utilization. -The enabled state can be set by running the Enable-NetAdapterIPsecOffload or Disable-NetAdapterIPsecOffload cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterIPsecOffload -Name MyAdapter -Enabled $True -``` - -This example enables IPsec offload on the network adapter named MyAdapter and restarts the network adapter. -Note: The Enable-NetAdapterIPsecOffload cmdlet is the preferred cmdlet to perform this operation. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies the state of IPsec offload. -The acceptable values for this parameter are: `$true` or `$false`. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter IPsecOffloadV2SettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter IPsecOffloadV2SettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterIPsecOffload](./Disable-NetAdapterIPsecOffload.md) - -[Enable-NetAdapterIPsecOffload](./Enable-NetAdapterIPsecOffload.md) - -[Get-NetAdapterIPsecOffload](./Get-NetAdapterIPsecOffload.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterLso.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterLso.md deleted file mode 100644 index 97e6ed79b6..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterLso.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterlso?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterLso - -## SYNOPSIS -Sets the large send offload (LSO) properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterLso [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-IPv4Enabled ] [-IPv6Enabled ] [-NoRestart] [-PassThru] [-ThrottleLimit ] - [-V1IPv4Enabled ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterLso [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4Enabled ] - [-IPv6Enabled ] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-V1IPv4Enabled ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterLso [-AsJob] [-CimSession ] [-IPv4Enabled ] [-IPv6Enabled ] - [-NoRestart] [-PassThru] [-ThrottleLimit ] [-V1IPv4Enabled ] -InputObject - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterLso** cmdlet manages the large send offload property which can improve send side performance by having the network adapter distribute a large send request into smaller sizes that can be sent out by the network adapter. -Without this setting Windows Server® 2012 and later would have to perform this work. -The offload reduces the load on the processor, so that the processor can to do more application level work. -If only setting the enabled state of LSO, then use the Enable-NetAdapterLso or Disable-NetAdapterLso cmdlets. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterLso -Name MyAdapter -IPv4Enabled $True -IPv6Enabled $False -``` - -This example enables LSO for IPv4 and disables LSO for IPv6 on the network adapter named MyAdapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4Enabled -Specifies the enabled state of LSO for IPv4 traffic. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6Enabled -Specifies the enabled state of LSO for IPv6 traffic. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -V1IPv4Enabled -Enables LSOv1 on the network adapter. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter LsoSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter LsoSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterLso](./Disable-NetAdapterLso.md) - -[Enable-NetAdapterLso](./Enable-NetAdapterLso.md) - -[Get-NetAdapterLso](./Get-NetAdapterLso.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterPowerManagement.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterPowerManagement.md deleted file mode 100644 index 720c2e0440..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterPowerManagement.md +++ /dev/null @@ -1,405 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterpowermanagement?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterPowerManagement - -## SYNOPSIS -Sets the power management properties on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterPowerManagement [-Name] [-ArpOffload ] [-AsJob] [-CimSession ] - [-D0PacketCoalescing ] [-DeviceSleepOnDisconnect ] [-IncludeHidden] [-NoRestart] - [-NSOffload ] [-PassThru] [-RsnRekeyOffload ] [-SelectiveSuspend ] - [-ThrottleLimit ] [-WakeOnMagicPacket ] [-WakeOnPattern ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterPowerManagement [-ArpOffload ] [-AsJob] [-CimSession ] - [-D0PacketCoalescing ] [-DeviceSleepOnDisconnect ] [-NoRestart] [-NSOffload ] - [-PassThru] [-RsnRekeyOffload ] [-SelectiveSuspend ] [-ThrottleLimit ] - [-WakeOnMagicPacket ] [-WakeOnPattern ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterPowerManagement [-ArpOffload ] [-AsJob] [-CimSession ] - [-D0PacketCoalescing ] [-DeviceSleepOnDisconnect ] [-IncludeHidden] [-NoRestart] - [-NSOffload ] [-PassThru] [-RsnRekeyOffload ] [-SelectiveSuspend ] - [-ThrottleLimit ] [-WakeOnMagicPacket ] [-WakeOnPattern ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterPowerManagement** cmdlet sets the power management properties on the network adapter. -If only setting the enabled state of the properties, then run the Enable-NetAdapterPowerManagement or Disable-NetAdapterPowerManagement cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterPowerManagement -Name Ethernet -DeviceSleepOnDisconnect Enabled -``` - -This example enables the device sleep on disconnect feature on the network adapter named Ethernet and restarts the network adapter. - -## PARAMETERS - -### -ArpOffload -Manages the address resolution protocol (ARP) offload capability of the network adapter. - -The computer, when in low power mode using the ARP offload technology, is able to offload the responsibility of handling responses for incoming ARP protocol requests. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -D0PacketCoalescing -Manages the D0 packet coalescing capability of the network adapter. - -This feature enables power saving on the computer by reducing the number of receive interrupts. -This reduces the number of receive interrupts by coalescing random broadcast or multi-cast packets. -The processing overhead and power consumption is significantly reduced on the computer. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DeviceSleepOnDisconnect -Manages the device sleep on disconnect capability of the network adapter. - -This feature allows the device to stand-by in a low power mode when media is disconnected and wake when media is connected again. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NSOffload -Manages the neighbor solicitation (NS) offload capability of the network adapter. - -The computer, when in low power mode using the NS offload technology, is able to offload the handling of responses for incoming NS protocol requests. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RsnRekeyOffload -Manages the Wi-Fi robust security network (RSN) rekey offload capability of the network adapter. - -The computer, when it goes into sleep state, is able to offload the group temporal key (GTK) rekeying for wake on wireless LAN (WoWLAN). - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SelectiveSuspend -Manages the selective suspend capability of the network adapter. - -The network drive interface specification (NDIS) selective suspend interface allows NDIS to suspend an idle network adapter by transitioning the adapter to a low-power state. -This enables the computer to reduce the power overhead on the processor and network adapter. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WakeOnMagicPacket -Manages the wake on magic packet capability of the network adapter. - -The magic packet is a broadcast frame containing anywhere within its payload `6` bytes of all `255` (`FF FF FF FF FF FF` in hexadecimal), followed by sixteen repetitions of the 48-bit MAC address of the target computer, for a total of `102` bytes. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WakeOnPattern -Manages the wake on pattern capability of the network adapter. - -A wake pattern refers to network packet filters that determine if incoming network traffic should wake the computer. -These patterns can be enabled on the network adapter. - -The following wake patterns may be supported by a network adapter: - - - Wake Pattern. - - - Wake on new incoming TCP connection for IPv4 and IPv6 such as TCP SYN IPv4 and TCP SYN IPv6. - - - 802.1x re-authentication packets. - - - Bitmapped Patterns: Most network adapters can be programmed with bit-mapped pattern filters. -Bitmapped patterns are defined by a bit-map mask and a pattern filter. -As a network packet is received, it is masked using the bitmap mask and then compared to the pattern filter. -If there is a match, then the network adapter wakes the computer. - -```yaml -Type: Setting -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter PowerManagementSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapter PowerManagementSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterPowerManagement](./Disable-NetAdapterPowerManagement.md) - -[Enable-NetAdapterPowerManagement](./Enable-NetAdapterPowerManagement.md) - -[Get-NetAdapterPowerManagement](./Get-NetAdapterPowerManagement.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterQos.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterQos.md deleted file mode 100644 index 33b04149d9..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterQos.md +++ /dev/null @@ -1,278 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterqos?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterQos - -## SYNOPSIS -Sets the quality of service (QoS) properties of the network adapter, specifically data center bridging (DCB). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterQos [-Name] [-AsJob] [-CimSession ] [-Enabled ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterQos [-AsJob] [-CimSession ] [-Enabled ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterQos [-AsJob] [-CimSession ] [-Enabled ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterQos** cmdlet sets the quality of service (QoS) properties on a network adapter. -Currently this cmdlet only supports enabling or disabling QoS on a network adapter. -The Enable-NetAdapterQos and DisableNetAdapterQos cmdlets can also be used. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterQos -Name DCBAdapter2 -Enabled $true -``` - -This example enables QoS on the network adapter named DCBAdapter2. -Note: The Enable-NetAdapterQos cmdlet is the preferred cmdlet to perform this operation. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterQos -Name DCBAdapter2 -Enabled $false -``` - -This example disables QoS on the network adapter named DCBAdapter2. -Note:The Disable-NetAdapterQos cmdlet is the preferred cmdlet to perform this operation. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Specifies the enabled state of the QoS settings on the network adapter, specifically DCB. -Refer to the Enable-NetAdapterQos and Disable-NetAdapterQos cmdlets for more details, as setting this parameter to True is equivalent to the Enable-NetAdapterQos cmdlet and setting this parameter to False is equivalent to the Disable-NetAdapterQos cmdlet. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The input object is a list of network adapter objects, such as output from the Get-NetAdapter cmdlet. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterQosSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The output object contains QoS capabilities and configurations on a network adapter. -The output object is returned only when the **PassThru** parameter is specified. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterQos](./Disable-NetAdapterQos.md) - -[Enable-NetAdapterQos](./Enable-NetAdapterQos.md) - -[Get-NetAdapter](./Get-NetAdapter.md) - -[Get-NetAdapterQos](./Get-NetAdapterQos.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterRdma.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterRdma.md deleted file mode 100644 index 9461765572..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterRdma.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterrdma?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterRdma - -## SYNOPSIS -Sets the remote direct memory access (RDMA) properties on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterRdma [[-Name] ] [-AsJob] [-CimSession ] [-Enabled ] - [-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterRdma [-AsJob] [-CimSession ] [-Enabled ] [-NoRestart] [-PassThru] - [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterRdma [-AsJob] [-CimSession ] [-Enabled ] [-IncludeHidden] [-NoRestart] - [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterRdma** cmdlet sets the remote direct memory access (RDMA) properties on the network adapter. -RDMA is a feature that enables network adapters to transfer data directly between each other without requiring the main processor of the computer to be part of that transfer. -This results in lower latency and lower processor utilization. -The Enable-NetAdapterRdma and DisableNetAdapterRdma cmdlets can also be used to manage RDMA. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterRdma -Name MyAdapter -Enabled $True -``` - -This example enables RDMA on the network adapter named MyAdapter. -Note: The Enable-NetAdapterRdma cmdlet is the preferred cmdlet to perform this operation. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterRdma -Name MyAdapter -Enabled $False -``` - -This example disables RDMA on the network adapter named MyAdapter. -Note: The Disable-NetAdapterRdma cmdlet is the preferred cmdlet to perform this operation. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Sets the state of RDMA on the network adapter. -The acceptable values for this parameter are: `$true` or `$false`. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterRdma](./Disable-NetAdapterRdma.md) - -[Enable-NetAdapterRdma](./Enable-NetAdapterRdma.md) - -[Get-NetAdapterRdma](./Get-NetAdapterRdma.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterRsc.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterRsc.md deleted file mode 100644 index ac11d5717f..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterRsc.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterrsc?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterRsc - -## SYNOPSIS -Sets the enabled state of receive segment coalescing (RSC). - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterRsc [-Name] [-AsJob] [-CimSession ] [-IncludeHidden] - [-IPv4Enabled ] [-IPv6Enabled ] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterRsc [-AsJob] [-CimSession ] [-IPv4Enabled ] [-IPv6Enabled ] - [-NoRestart] [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterRsc [-AsJob] [-CimSession ] [-IncludeHidden] [-IPv4Enabled ] - [-IPv6Enabled ] [-NoRestart] [-PassThru] [-ThrottleLimit ] -InterfaceDescription - [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterRsc** cmdlet sets the enabled state of receive segment coalescing (RSC). -RSC takes multiple packets received within the same interrupt period and combines the packets into a single large package to be processed by the network stack. -This reduces the processing overhead for incoming packets and reduces the number of processor cycles that are used, leading to better scalability. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterRsc -Name MyAdapter -IPv4Enabled $True -IPv6Enabled $True -``` - -This example enables RSC for IPv4 and IPv6 traffic on the network adapter named MyAdapter and restarts the network adapter. -Note: The Enable-NetAdapterRsc cmdlet is the preferred cmdlet to perform this operation. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterRsc -Name MyAdapter -IPv4Enabled $True -IPv6Enabled $False -``` - -This example enables RSC for IPv4 traffic and disables RSC for IPv6 traffic on the network adapter named MyAdapter and restarts the network adapter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -IPv4Enabled -Enables RSC for IPv4 traffic. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6Enabled -Enables RSC for IPv6 traffic. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRscSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterRsc](./Disable-NetAdapterRsc.md) - -[Enable-NetAdapterRsc](./Enable-NetAdapterRsc.md) - -[Get-NetAdapterRsc](./Get-NetAdapterRsc.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterRss.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterRss.md deleted file mode 100644 index 1cce91e964..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterRss.md +++ /dev/null @@ -1,416 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadapterrss?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterRss - -## SYNOPSIS -Sets the receive side scaling (RSS) properties on the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterRss [-Name] [-AsJob] [-BaseProcessorGroup ] [-BaseProcessorNumber ] - [-CimSession ] [-Enabled ] [-IncludeHidden] [-MaxProcessorGroup ] - [-MaxProcessorNumber ] [-MaxProcessors ] [-NoRestart] [-NumaNode ] - [-NumberOfReceiveQueues ] [-PassThru] [-Profile ] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterRss [-AsJob] [-BaseProcessorGroup ] [-BaseProcessorNumber ] - [-CimSession ] [-Enabled ] [-IncludeHidden] [-MaxProcessorGroup ] - [-MaxProcessorNumber ] [-MaxProcessors ] [-NoRestart] [-NumaNode ] - [-NumberOfReceiveQueues ] [-PassThru] [-Profile ] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterRss [-AsJob] [-BaseProcessorGroup ] [-BaseProcessorNumber ] - [-CimSession ] [-Enabled ] [-MaxProcessorGroup ] [-MaxProcessorNumber ] - [-MaxProcessors ] [-NoRestart] [-NumaNode ] [-NumberOfReceiveQueues ] [-PassThru] - [-Profile ] [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterRss** cmdlet sets the receive side scaling (RSS) properties on the network adapter. -RSS is a scalability technology that distributes the receive network traffic among multiple processors by hashing the header of the incoming packet. -Without RSS in firstref_longhorn, firstref_server_7, and Windows Server® 2012; network traffic is received on the first processor which can quickly reach full utilization limiting receive network throughput. -Many properties can be configured using the parameters to optimize the performance of RSS. -The selection of the processors to use for RSS is an important aspect of load balancing. -Most of the parameters for this cmdlet help to determine the processors used by RSS. -A thorough understanding of RSS is recommended before modifying individual parameters. -Selecting the correct profile should be sufficient in most scenarios. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterRss -Name "Ethernet" -Profile NUMAStatic -``` - -This example sets an RSS profile for a non-uniform memory access (NUMA) server without dynamic load balancing. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BaseProcessorGroup -Sets the base processor group of a non-uniform memory access (NUMA) node. -This will impact the processor array used by RSS. -This parameter is the lowest group number of any processors that appear in the processor array. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BaseProcessorNumber -Sets the base processor number of a NUMA node. -This parameter is the lowest processor number of any processors from the **BaseProcessorGroup** parameter that appear in the processor array. -This allows for partitioning processors across network adapters. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Sets the enabled state of RSS on an interface - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -MaxProcessorGroup -Sets the maximum processor group of a NUMA node. -This parameter is the highest group number of any processors that appear in the processor array for this network adapter. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxProcessorNumber -Sets the maximum processor number of a NUMA node. -This parameter is the highest processor number of any processors from the **MaxProcessorGroup** parameter that appear in the processor array for this network adapter. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxProcessors -Sets the maximum number of processors to be used concurrently by RSS from the processor array for load balancing network transmissions from a single network adapter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumaNode -Sets the NUMA node affinity for a network adapter. -This will ensure that a given network transmission is load balanced by RSS within the NUMA node. -This affects the memory allocation and also impacts the preference and ordering of the processors in the processor array. -It does not affect the set of processors contained in the array, but it may impact the subset of the array that RSS actually uses. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumberOfReceiveQueues -Specifies the number of receive queues per network adapter that is to be used by the interface - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Profile -Specifies the RSS profile. -The acceptable values for this parameter are: Closest, ClosestStatic, NUMA, NUMAStatic, or Conservative. - - - Closest: Behavior is consistent with the behavior of firstref_server_7. - - - ClosestStatic: No dynamic load balancing, such as distributing but not load balancing at runtime. - - - NUMA: Assigns RSS processors in a round robin basis across every NUMA node to enable applications that are running on NUMA servers to scale well. - - - NUMAStatic: Default behavior. -RSS processor selection is the same as for NUMA scalability without dynamic load balancing. - - - Conservative: RSS uses as few processors as possible to sustain the load. -This option helps reduce the number of interrupts. - -```yaml -Type: Profile -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRssSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterRss](./Disable-NetAdapterRss.md) - -[Enable-NetAdapterRss](./Enable-NetAdapterRss.md) - -[Get-NetAdapterRss](./Get-NetAdapterRss.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md deleted file mode 100644 index 59edcb1d53..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterSriov.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadaptersriov?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterSriov - -## SYNOPSIS -Sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter, such as the number of virtual functions (VFs), and the number of queue pairs for default and non-default VPorts. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterSriov [-Name] [-AsJob] [-CimSession ] [-Enabled ] - [-IncludeHidden] [-NoRestart] [-NumVFs ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterSriov [-AsJob] [-CimSession ] [-Enabled ] [-NoRestart] [-NumVFs ] - [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterSriov [-AsJob] [-CimSession ] [-Enabled ] [-IncludeHidden] [-NoRestart] - [-NumVFs ] [-PassThru] [-ThrottleLimit ] -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterSriov** cmdlet sets the Single-Root I/O Virtualization (SR-IOV) properties of the network adapter. -The properties include the number of virtual functions (VFs), the number of virtual ports (VPorts), and the number of queue pairs for default and non-default VPorts. -The enabled state of SR-IOV can also be set with the cmdlet. - -The network adapter for these actions can be specified with the adapter name, interface description, or piped as an input object. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -``` - -This example sets the number of VFs available to 31 on the network adapter named Ethernet 2. - -### EXAMPLE 2 -``` -PS C:\>Set-NetAdapterSriov -Name "Ethernet 2" -NumVFs 31 -NumQueuePairsForDefaultVPort 2 -NumQueuePairsForNonDefaultVPort 2 -``` - -This example sets the number of VFs to 31. -This will result in 31 VF and `32` virtual machine queue (VMQ), plus 1 used by the physical function (PF). -Since the number of queue pair is set to 2 for both default and non-default ports, the total number of queue pairs used will be `128`. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Sets the enabled state of SR-IOV on the network adapter. -If set to True, then SR-IOV is Enabled. -If set to False, then SR-IOV is Disabled. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -The network adapter can be selected using the **Name** parameter, this parameter, or piped in using the **InputObject** parameter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Name -Specifies the name of the network adapter. - -The network adapter can be selected using this parameter, the **InterfaceDescription** parameter, or piped in using the **InputObject** parameter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumVFs -Specifies the number of VFs that the network adapter exposes for SR-IOV. -This is the maximum number of VFs that Windows Server 2012 and later will allocate on this network adapter. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterSriovSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The output object will have the updated SR-IOV settings. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterSriov](./Disable-NetAdapterSriov.md) - -[Enable-NetAdapterSriov](./Enable-NetAdapterSriov.md) - -[Get-NetAdapterSriov](./Get-NetAdapterSriov.md) - -[Get-NetAdapterSriovVf](./Get-NetAdapterSriovVf.md) - diff --git a/docset/winserver2012-ps/netadapter/Set-NetAdapterVmq.md b/docset/winserver2012-ps/netadapter/Set-NetAdapterVmq.md deleted file mode 100644 index 0b5908e4aa..0000000000 --- a/docset/winserver2012-ps/netadapter/Set-NetAdapterVmq.md +++ /dev/null @@ -1,353 +0,0 @@ ---- -external help file: NetAdapter_Cmdlets.xml -Module Name: NetAdapter -online version: https://learn.microsoft.com/powershell/module/netadapter/set-netadaptervmq?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetAdapterVmq - -## SYNOPSIS -Sets the virtual machine queue (VMQ) properties of the network adapter. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetAdapterVmq [-Name] [-AsJob] [-BaseProcessorGroup ] [-BaseProcessorNumber ] - [-CimSession ] [-Enabled ] [-IncludeHidden] [-MaxProcessorNumber ] - [-MaxProcessors ] [-NoRestart] [-NumaNode ] [-PassThru] [-ThrottleLimit ] [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetAdapterVmq [-AsJob] [-BaseProcessorGroup ] [-BaseProcessorNumber ] - [-CimSession ] [-Enabled ] [-MaxProcessorNumber ] [-MaxProcessors ] - [-NoRestart] [-NumaNode ] [-PassThru] [-ThrottleLimit ] -InputObject [-Confirm] - [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetAdapterVmq [-AsJob] [-BaseProcessorGroup ] [-BaseProcessorNumber ] - [-CimSession ] [-Enabled ] [-IncludeHidden] [-MaxProcessorNumber ] - [-MaxProcessors ] [-NoRestart] [-NumaNode ] [-PassThru] [-ThrottleLimit ] - -InterfaceDescription [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Set-NetAdapterVmq** cmdlet sets the virtual machine queue (VMQ) properties of the network adapter. -VMQ is a scaling networking technology for Hyper-V switch that improves network throughput by distributing processing of network traffic for multiple virtual machines (VMs) among multiple processors. -A thorough familiarity with VMQ and dynamic VMQ is highly recommended before changing any default values with this cmdlet. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\>Set-NetAdapterVmq -Name MyAdapter -Enabled $True -``` - -This example enables VMQ on the network adapter named MyAdapter. -Note: The Enable-NetAdapterVmq cmdlet is the preferred cmdlet to perform this operation. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BaseProcessorGroup -Specifies the processor group to be used by VMQ. -Support for systems that have more than `64` logical processors is based on the concept of a processor group, which is a static set of up to `64` logical processors. -Processor groups are numbered starting with `0`. -Computers with fewer than `64` logical processors always have a single group, Group `0`. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BaseProcessorNumber -Specifies the starting processor to be used within the processor group for VMQ. -Support for systems that have more than `64` logical processors is based on the concept of a processor group, which is a static set of up to `64` logical processors. -Processor groups are numbered starting with `0`. -Computers with fewer than `64` logical processors always have a single group, Group `0`. -A logical processor is identified by a group number, using the **BaseProcessorGroup** parameter, and a group-relative processor number, using this parameter. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled -Sets the enabled state of VMQ. -The acceptable values for this parameter are: `$true` or `$false`. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IncludeHidden -Specifies both visible and hidden network adapters should be included. -By default only visible network adapters are included. -If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceDescription -Specifies the network adapter interface description. -For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as `Contoso 12345 Gigabit Network Device`. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: ifDesc - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -MaxProcessorNumber -Specifies the largest processor number in the group. - -```yaml -Type: Byte -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxProcessors -Specifies the maximum number of processors used by VMQ for load balancing network transmissions. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the network adapter. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -NoRestart -Specifies that the network adapter is not restarted as part of running this cmdlet. -Note: Many advanced properties require restarting the network adapter before the new settings take effect. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NumaNode -Specifies the preferred non-uniform memory access (NUMA) node for the affinity of the VMQs allocated on this network adapter. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData[] -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -## NOTES - -## RELATED LINKS - -[Disable-NetAdapterVmq](./Disable-NetAdapterVmq.md) - -[Enable-NetAdapterVmq](./Enable-NetAdapterVmq.md) - -[Get-NetAdapterVmq](./Get-NetAdapterVmq.md) - -[Get-NetAdapterVmqQueue](./Get-NetAdapterVmqQueue.md) - diff --git a/docset/winserver2012-ps/netconnection/Get-NetConnectionProfile.md b/docset/winserver2012-ps/netconnection/Get-NetConnectionProfile.md deleted file mode 100644 index 4004be2837..0000000000 --- a/docset/winserver2012-ps/netconnection/Get-NetConnectionProfile.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -external help file: MSFT_NetConnectionProfile.cdxml-help.xml -Module Name: NetConnection -ms.date: 12/20/2016 -online version: https://learn.microsoft.com/powershell/module/netconnectionprofile/get-netconnectionprofile?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 -title: Get-NetConnectionProfile ---- - -# Get-NetConnectionProfile - -## SYNOPSIS -Gets a connection profile. - -## SYNTAX - -```powershell -Get-NetConnectionProfile [-Name ] [-InterfaceAlias ] [-InterfaceIndex ] - [-NetworkCategory ] [-IPv4Connectivity ] - [-IPv6Connectivity ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [] -``` - -## DESCRIPTION -The **Get-NetConnectionProfile** cmdlet gets a connection profile associated with one or more physical network adapters. -A connection profile represents a network connection. - -## EXAMPLES - -### Example 1: Get a connection profile -```powershell -PS C:\>Get-NetConnectionProfile -InterfaceAlias "Ethernet1" | Set-NetConnectionProfile -NetworkCategory Public -``` - -This first part of this command gets the connection profile for the network adapter named Ethernet1. -The command passes the results to the **Set-NetConnectionProfile** cmdlet by using the pipe operator. -The second part of the command changes the value of the network category for the connection profile. - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4Connectivity -Specifies an array of IPv4 protocol connectivity status values. -The acceptable values for this parameter are: -- Disconnected -- NoTraffic -- Subnet -- LocalNetwork -- Internet - -```yaml -Type: IPv4Connectivity[] -Parameter Sets: (All) -Aliases: -Accepted values: Disconnected, NoTraffic, Subnet, LocalNetwork, Internet - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6Connectivity -Specifies an array of IPv6 protocol connectivity status values. -The acceptable values for this parameter are: -- Disconnected -- NoTraffic -- Subnet -- LocalNetwork -- Internet - -```yaml -Type: IPv6Connectivity[] -Parameter Sets: (All) -Aliases: -Accepted values: Disconnected, NoTraffic, Subnet, LocalNetwork, Internet - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies an array of names of network adapters. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InterfaceIndex -Specifies an array of numerical index values associated with the network adapters. - -```yaml -Type: UInt32[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of networks with which the connection is currently established. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkCategory -Specifies an array of category types of a network. -The acceptable values for this parameter are: - -- *Public* - Networks in a public place such as an airport or coffee shop. Your PC is hidden from other devices on the network and can't be used for printer and file sharing. -- *Private* - Networks at home or work, where you know and trust the people and devices on the network. Your PC is discoverable and can be used for printer and file sharing if you set it up. -- *DomainAuthenticated* - Networks at a workplace that are joined to a domain. - -```yaml -Type: NetworkCategory[] -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private, DomainAuthenticated - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Set-NetConnectionProfile](./Set-NetConnectionProfile.md) diff --git a/docset/winserver2012-ps/netconnection/NetConnection.md b/docset/winserver2012-ps/netconnection/NetConnection.md deleted file mode 100644 index 6529240e71..0000000000 --- a/docset/winserver2012-ps/netconnection/NetConnection.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: ce4ff86e-9416-4f2d-a869-c860ac543b5e -Module Name: NetConnection -ms.date: 12/20/2016 -title: NetConnection ---- - -# NetConnection Module -## Description -This reference provides cmdlet descriptions and syntax for all Net Connection cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -## NetConnection Cmdlets -### [Get-NetConnectionProfile](./Get-NetConnectionProfile.md) -Gets a connection profile. - -### [Set-NetConnectionProfile](./Set-NetConnectionProfile.md) -Changes the network category of a connection profile. - diff --git a/docset/winserver2012-ps/netconnection/Set-NetConnectionProfile.md b/docset/winserver2012-ps/netconnection/Set-NetConnectionProfile.md deleted file mode 100644 index e04c22439d..0000000000 --- a/docset/winserver2012-ps/netconnection/Set-NetConnectionProfile.md +++ /dev/null @@ -1,287 +0,0 @@ ---- -external help file: MSFT_NetConnectionProfile.cdxml-help.xml -Module Name: NetConnection -ms.date: 12/20/2016 -online version: https://learn.microsoft.com/powershell/module/netconnectionprofile/set-netconnectionprofile?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 -title: Set-NetConnectionProfile ---- - -# Set-NetConnectionProfile - -## SYNOPSIS -Changes the network category of a connection profile. - -## SYNTAX - -### Query (cdxml) (Default) -```powershell -Set-NetConnectionProfile [-Name ] [-InterfaceAlias ] [-InterfaceIndex ] - [-IPv4Connectivity ] [-IPv6Connectivity ] - [-NetworkCategory ] [-CimSession ] [-ThrottleLimit ] [-AsJob] - [-PassThru] [-WhatIf] [-Confirm] [] -``` - -### InputObject (cdxml) -```powershell -Set-NetConnectionProfile -InputObject [-NetworkCategory ] - [-CimSession ] [-ThrottleLimit ] [-AsJob] [-PassThru] [-WhatIf] [-Confirm] - [] -``` - -## DESCRIPTION -The **Set-NetConnectionProfile** cmdlet changes the network category setting of a connection profile. -A connection profile represents a network connection. - -## EXAMPLES - -### Example 1: Change the network category of a connection profile -```powershell -PS C:\> Set-NetConnectionProfile -InterfaceAlias Ethernet1 -NetworkCategory "Public" -``` - -## PARAMETERS - -### -AsJob -Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. - -The cmdlet immediately returns an object that represents the job and then displays the command prompt. -You can continue to work in the session while the job completes. -To manage the job, use the `*-Job` cmdlets. -To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. - -For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251). - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: Session - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv4Connectivity -Specifies an array of IPv4 protocol connectivity status values. -The acceptable values for this parameter are: -- Disconnected -- NoTraffic -- Subnet -- LocalNetwork -- Internet - -```yaml -Type: IPv4Connectivity[] -Parameter Sets: Query (cdxml) -Aliases: -Accepted values: Disconnected, NoTraffic, Subnet, LocalNetwork, Internet - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPv6Connectivity -Specifies an array of IPv6 protocol connectivity status values. -The acceptable values for this parameter are: -- Disconnected -- NoTraffic -- Subnet -- LocalNetwork -- Internet - -```yaml -Type: IPv6Connectivity[] -Parameter Sets: Query (cdxml) -Aliases: -Accepted values: Disconnected, NoTraffic, Subnet, LocalNetwork, Internet - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the input to this cmdlet. -You can use this parameter, or you can pipe the input to this cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: InputObject (cdxml) -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -InterfaceAlias -Specifies an array of names of network adapters. - -```yaml -Type: String[] -Parameter Sets: Query (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -InterfaceIndex -Specifies an array of numerical index values associated with the network adapters. - -```yaml -Type: UInt32[] -Parameter Sets: Query (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies an array of names of networks with which the connection is currently established. - -```yaml -Type: String[] -Parameter Sets: Query (cdxml) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkCategory -Specifies an array of category types of a network. -You cannot set the DomainAuthenticated type by using this cmdlet. -The server automatically sets the value of DomainAuthenticated when the network is authenticated to a domain controller. -The acceptable values for this parameter are: - -- *Public* - Networks in a public place such as an airport or coffee shop. Your PC is hidden from other devices on the network and can't be used for printer and file sharing. -- *Private* - Networks at home or work, where you know and trust the people and devices on the network. Your PC is discoverable and can be used for printer and file sharing if you set it up. -- *DomainAuthenticated* - Networks at a workplace that are joined to a domain. - -```yaml -Type: NetworkCategory -Parameter Sets: (All) -Aliases: -Accepted values: Public, Private, DomainAuthenticated - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). - -## INPUTS - -## OUTPUTS - -## NOTES - -## RELATED LINKS - -[Get-NetConnectionProfile](./Get-NetConnectionProfile.md) diff --git a/docset/winserver2012-ps/netlbfo/Add-NetLbfoTeamMember.md b/docset/winserver2012-ps/netlbfo/Add-NetLbfoTeamMember.md deleted file mode 100644 index 4937d1c09c..0000000000 --- a/docset/winserver2012-ps/netlbfo/Add-NetLbfoTeamMember.md +++ /dev/null @@ -1,172 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/add-netlbfoteammember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-NetLbfoTeamMember - -## SYNOPSIS -Adds a new member (network adapter) to a specified NIC team. - -## SYNTAX - -``` -Add-NetLbfoTeamMember [-Name] [-Team] [[-AdministrativeMode] ] [-AsJob] - [-CimSession ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Add-NetLbfoTeamMember** cmdlet adds a new network adapter as a member to the specified team. -You can use the **AdministrativeMode** parameter to specify the initial role of the new team member. - -## EXAMPLES - -### Example 1: Add a new team member -``` -PS C:\>Add-NetLbfoTeamMember -Name NIC1 -Team Team1 -``` - -This command adds a new member named NIC1 to the specified team named Team1. - -### Example 2: Add a new team member with initial status -``` -PS C:\>Add-NetLbfoTeamMember -Name NIC2 -Team Team2 -AdministrativeMode Standby -``` - -This command adds a new member named NIC2 to the specified team named Team2 with the initial status Standby. - -### Example 3: Add new team members using wildcard pattern -``` -PS C:\>Add-NetLbfoTeamMember -Name NIC* -Team Team1 -``` - -This command adds new members whose name starts with NIC to the specified team named Team1. - -## PARAMETERS - -### -AdministrativeMode -Specifies the initial role of the new member (network adapter). - -You can specify one of the following two status options: - -**Active**: Allows the team member to participate in the NIC team. -By default, the initial role of the team member is Active. - -**Standby**: Places the member in a standby state where it does not participate in the team. -The team member will be automatically moved to Active state if any other member of the team fails. - -At most one member in a team can be in Standby mode. - -```yaml -Type: AdminModes -Parameter Sets: (All) -Aliases: am - -Required: False -Position: 3 -Default value: Active -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name (Interface Alias or Connection Name) of the network adapter to add. - -```yaml -Type: WildcardPattern -Parameter Sets: (All) -Aliases: ifAlias, InterfaceAlias - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -Team -Specifies the name of the NIC team to which to add the new network adapter. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeamMember -This cmdlet returns an array of **MSFT_NetLbfoTeamMember** objects consisting of the newly added member network adapter objects to the team. - -## NOTES - -## RELATED LINKS - -[Get-NetLbfoTeamMember](./Get-NetLbfoTeamMember.md) - -[Set-NetLbfoTeamMember](./Set-NetLbfoTeamMember.md) - -[Remove-NetLbfoTeamMember](./Remove-NetLbfoTeamMember.md) - diff --git a/docset/winserver2012-ps/netlbfo/Add-NetLbfoTeamNic.md b/docset/winserver2012-ps/netlbfo/Add-NetLbfoTeamNic.md deleted file mode 100644 index 55ac0592c7..0000000000 --- a/docset/winserver2012-ps/netlbfo/Add-NetLbfoTeamNic.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/add-netlbfoteamnic?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Add-NetLbfoTeamNic - -## SYNOPSIS -Adds a new interface to a NIC team. - -## SYNTAX - -``` -Add-NetLbfoTeamNic [-Team] [-VlanID] [[-Name] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Add-NetLbfoTeamNic** cmdlet adds a new team interface to the specified NIC team. -You can use this cmdlet to add the interfaces to the specified team by specifying the respective VLAN IDs. - -You need administrator privileges to use **Add-NetLbfoTeamNic**. - -## EXAMPLES - -### Example 1: Add a team interface -``` -PS C:\>Add-NetLbfoTeamNIC -Team Team1 -VlanID 42 -``` - -This command adds a team interface with VLAN ID 42 to the specified team named Team1. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new team interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 3 -Default value: -VLAN -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Team -Specifies the name of the NIC team to which to add a new team interface. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanID -Specifies the VLAN ID of the team interface. -VlanID values must meet the criteria 0 ≤ VlanID \< 4095. -Specify the value 0 to match frames identified with a VLAN ID of 0 or untagged frames. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeamNic -This cmdlet produces an **MFT_NetLbfoTeamNic** object containing the newly created team interface. - -## NOTES - -## RELATED LINKS - -[Get-NetLbfoTeamNic](./Get-NetLbfoTeamNic.md) - -[Remove-NetLbfoTeamNic](./Remove-NetLbfoTeamNic.md) - -[Set-NetLbfoTeamNic](./Set-NetLbfoTeamNic.md) - diff --git a/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeam.md b/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeam.md deleted file mode 100644 index f4d3b7e23b..0000000000 --- a/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeam.md +++ /dev/null @@ -1,205 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/get-netlbfoteam?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetLbfoTeam - -## SYNOPSIS -Retrieves a list of NIC teams on the system, as specified by the input parameters. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetLbfoTeam [[-Name] ] [-AsJob] [-CimSession ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetLbfoTeam [-AsJob] [-CimSession ] [-TeamNicForTheTeam ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Get-NetLbfoTeam [-AsJob] [-CimSession ] [-MemberOfTheTeam ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetLbfoTeam** cmdlet retrieves the list of all available NIC teams on the system. - -You can retrieve the list of NIC teams by specifying the name or name pattern of the team. -You can also use **Get-NetLbfoTeam** to retrieve the team associated with a team interface or a team member (network adapter). - -## EXAMPLES - -### Example 1: Get a specific team -``` -PS C:\>Get-NetLbfoTeam -Name Team1 -``` - -This command retrieves a NIC team named Team1. - -### Example 2: Get the list of all teams whose name starts with 'T' and then remove -``` -PS C:\>Get-NetLbfoTeam -Name T*| Remove-NetLbfoTeam -``` - -This command retrieves the list of teams whose name starts with T using **Get-NetLbfoTeam**. -A pipeline operator (|) sends all the teams to Remove-NetLbfoTeam which removes them. - -### Example 3: Get the team associated with a particular member network adapter -``` -PS C:\>Get-NetLbfoTeamMember NIC1 | Get-NetLbfoTeam - - -Or - - -PS C:\>$mObj = Get-NetLbfoTeamMember NIC1 - - - -PS C:\>Get-NetLbfoTeam -MemberOfTheTeam $mObj -``` - -This command retrieves the NIC team associated with a particular member network adapter named NIC1 using **Get-NetLbfoTeam**. - -### Example 4: Get the team associated with a particular team interface -``` -PS C:\>Get-NetLbfoTeamNic 'Team1 - VLAN 42' | Get-NetLbfoTeam - - -Or - - -PS C:\>$tNicObj = Get-NetLbfoTeamNic 'Team1 - VLAN 42' - - - -PS C:\>Get-NetLbfoTeam -TeamNicForTheTeam $tNicObj -``` - -This command retrieves the NIC team associated with a particular team interface named Team1 - VLAN 42 using **Get-NetLbfoTeam**. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberOfTheTeam -Specifies the member network adapter name to retrieve the associated NIC team. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name (or name wildcard pattern) of the NIC team for which to retrieve information. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -TeamNicForTheTeam -Specifies the team interface to retrieve the associated NIC team. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeam -This cmdlet returns an array of **MSFT_NetLbfoTeam** objects containing the teams that match the query. - -## NOTES - -## RELATED LINKS - -[New-NetLbfoTeam](./New-NetLbfoTeam.md) - -[Remove-NetLbfoTeam](./Remove-NetLbfoTeam.md) - -[Rename-NetLbfoTeam](./Rename-NetLbfoTeam.md) - -[Set-NetLbfoTeam](./Set-NetLbfoTeam.md) - diff --git a/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeamMember.md b/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeamMember.md deleted file mode 100644 index 85d486fa44..0000000000 --- a/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeamMember.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/get-netlbfoteammember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetLbfoTeamMember - -## SYNOPSIS -Retrieves a list of network adapters that are members of a NIC team, as specified by the input parameters. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetLbfoTeamMember [[-Name] ] [[-Team] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetLbfoTeamMember [-AsJob] [-CimSession ] [-TeamOfTheMember ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetLbfoTeamMember** cmdlet retrieves the list of all network adapters (team members) of all NIC teams. -You can also use **Get-NetLbfoTeamMember** to retrieve a list of network adapters for the specified NIC team, and then use that information as input to the other cmdlets. - -## EXAMPLES - -### Example 1: Get a list of team members -``` -PS C:\>Get-NetLbfoTeamMember -Team Team1 -``` - -This command retrieves a list of team members for the specified NIC team named Team1. - -### Example 2: Get a list of all team members -``` -PS C:\>Get-NetLbfoTeamMember -``` - -This command retrieves a list of all team members of all NIC teams on the system. - -### Example 3: Get a list of all team members via associations -``` -PS C:\>Get-NetLbfoTeam -Name Team1 | Get-NetLbfoTeamMember - - - -Or -PS C:\>$teamObj = Get-NetLbfoTeam -Name Team1 - - -PS C:\>Get-NetLbfoTeamMember -TeamOfTheMember $teamObj -``` - -This command retrieves a list of all team members belonging to team named Team1. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name (or wildcard pattern of the name) of a team member whose details need to be retrieved. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Team -Specifies the NIC team name (or wildcard pattern) for which the user wants to enumerate the members. -If no team parameter is present, it returns all members specified by **Name** parameter from all teams on the system. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -TeamOfTheMember -Specifies the NIC team object whose associated member objects are to be retrieved. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeamMember -This cmdlet produces an array of **MSFT_NetLbfoTeamMember** objects corresponding to the query. - -## NOTES - -## RELATED LINKS - -[Add-NetLbfoTeamMember](./Add-NetLbfoTeamMember.md) - -[Remove-NetLbfoTeamMember](./Remove-NetLbfoTeamMember.md) - -[Set-NetLbfoTeamMember](./Set-NetLbfoTeamMember.md) - diff --git a/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeamNic.md b/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeamNic.md deleted file mode 100644 index 14950971ce..0000000000 --- a/docset/winserver2012-ps/netlbfo/Get-NetLbfoTeamNic.md +++ /dev/null @@ -1,167 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/get-netlbfoteamnic?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetLbfoTeamNic - -## SYNOPSIS -Retrieves a list of team interfaces. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Get-NetLbfoTeamNic [[-Name] ] [[-Team] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Get-NetLbfoTeamNic [-AsJob] [-CimSession ] [-TeamOfTheTeamNic ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetLbfoTeamNic** cmdlet retrieves a list of team interfaces as specified by the input parameters. - -## EXAMPLES - -### Example 1: Get a list of team interfaces associated with Team1 -``` -PS C:\>Get-NetLbfoTeamNic -Team Team1 - - -Or -PS C:\>$teamObj = Get-NetLbfoTeam -Name 'Team1' - -PS C:\>Get-NetLbfoTeamNic -TeamOfTheTeamNic $teamObj -``` - -This command retrieves a list of team interfaces for the specified team named Team1. - -### Example 2: Get a list of team interfaces by name -``` -PS C:\>Get-NetLbfoTeamNic -Name *VLAN* -Team T* -``` - -This command retrieves a list of team interfaces whose name contains "VLAN" in any NIC team whose name starts with T. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name (or wildcard pattern) of the team interface. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Team -Specifies the name of the NIC team for which the user wants to enumerate the team interfaces. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamOfTheTeamNic -Specifies the NIC team object whose team interfaces are to be enumerated. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeamNic -This cmdlet produces an array of **MSFT_NetLbfoTeamNic** objects corresponding to the query. - -## NOTES - -## RELATED LINKS - -[Add-NetLbfoTeamNic](./Add-NetLbfoTeamNic.md) - -[Remove-NetLbfoTeamNic](./Remove-NetLbfoTeamNic.md) - -[Set-NetLbfoTeamNic](./Set-NetLbfoTeamNic.md) - diff --git a/docset/winserver2012-ps/netlbfo/NetLbfo.md b/docset/winserver2012-ps/netlbfo/NetLbfo.md deleted file mode 100644 index f90e185f77..0000000000 --- a/docset/winserver2012-ps/netlbfo/NetLbfo.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 80cf4c6d-30b7-4b0f-a035-dbb23a65ef1d -Module Name: NetLbfo ---- - -# NetLbfo Module -## Description -This reference provides cmdlet descriptions and syntax for all NIC Teaming (NetLBFO)-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet. - -NOTE: The NIC Teaming feature is available only on Windows Server 2012 and later server operating systems. This feature is not available on Windows 10 or any other client operating systems. The NIC Teaming Windows PowerShell cmdlets are available on Windows 10 and other client operating systems to enable the management of NIC teams on remote computers that are running Windows Server 2016, Windows Server 2012, R2 and Windows Server 2012. - -## NetLbfo Cmdlets -### [Add-NetLbfoTeamMember](./Add-NetLbfoTeamMember.md) -Adds a new member (network adapter) to a specified NIC team. - -### [Add-NetLbfoTeamNic](./Add-NetLbfoTeamNic.md) -Adds a new interface to a NIC team. - -### [Get-NetLbfoTeam](./Get-NetLbfoTeam.md) -Retrieves a list of NIC teams on the system, as specified by the input parameters. - -### [Get-NetLbfoTeamMember](./Get-NetLbfoTeamMember.md) -Retrieves a list of network adapters that are members of a NIC team, as specified by the input parameters. - -### [Get-NetLbfoTeamNic](./Get-NetLbfoTeamNic.md) -Retrieves a list of team interfaces. - -### [New-NetLbfoTeam](./New-NetLbfoTeam.md) -Creates a new NIC team. - -### [Remove-NetLbfoTeam](./Remove-NetLbfoTeam.md) -Removes the specified NIC team from the host. - -### [Remove-NetLbfoTeamMember](./Remove-NetLbfoTeamMember.md) -Removes one or more network adapters from a specified NIC team. - -### [Remove-NetLbfoTeamNic](./Remove-NetLbfoTeamNic.md) -Removes a team interface from a NIC team. - -### [Rename-NetLbfoTeam](./Rename-NetLbfoTeam.md) -Renames a NIC team. - -### [Set-NetLbfoTeam](./Set-NetLbfoTeam.md) -Sets parameters on the specified NIC team. - -### [Set-NetLbfoTeamMember](./Set-NetLbfoTeamMember.md) -Sets the role of a member network adapter in a NIC team. - -### [Set-NetLbfoTeamNic](./Set-NetLbfoTeamNic.md) -Sets a new VLAN id on a team interface, or restores the interface to Default mode. - diff --git a/docset/winserver2012-ps/netlbfo/New-NetLbfoTeam.md b/docset/winserver2012-ps/netlbfo/New-NetLbfoTeam.md deleted file mode 100644 index 7530d7df2b..0000000000 --- a/docset/winserver2012-ps/netlbfo/New-NetLbfoTeam.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/new-netlbfoteam?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-NetLbfoTeam - -## SYNOPSIS -Creates a new NIC team. - -## SYNTAX - -``` -New-NetLbfoTeam [-Name] [-TeamMembers] [[-TeamNicName] ] - [[-TeamingMode] ] [[-LoadBalancingAlgorithm] ] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **New-NetLbfoTeam** cmdlet creates a new NIC team that consists of one or more network adapters. -Teaming network adapters of different speeds is not supported. -You can create a team with network adapters of different speeds, but the network traffic distribution algorithms do not take the speed of each network adapter into consideration when distributing traffic. - -When you create a team, you can specify additional properties such as **TeamingMode** and **LoadBalancingAlgorithm**. - -You need administrator privileges to use **New-NetLbfoTeam**. - -## EXAMPLES - -### Example 1: Create a new team -``` -PS C:\>New-NetLbfoTeam -Name Team1 -TeamMembers NIC1,NIC2 -``` - -This command creates a new team named Team1 with two team members named NIC1 and NIC2. - -### Example 2: Create a new team with specified properties -``` -PS C:\>New-NetLbfoTeam -Name Team1 -TeamMembers NIC1,NIC2 -TeamingMode LACP --LoadBalancingAlgorithm HyperVPort -``` - -This command creates a new team named Team1 that consists of two team members named NIC1 and NIC2. -The teaming mode is set to LACP and the load balancing algorithm is set to HyperVPorts. - -### Example 3: Create a new team in a virtual machine -``` -PS C:\>Set-VMNetworkAdapter -VMName -AllowTeaming - - - - -PS C:\>New-NetLbfoTeam -Name Team2 -TeamMembers NIC1,NIC2 -``` - -This set of commands allows teaming in virtual machines by using the **AllowTeaming** parameter of the Set-VMNetworkAdapter cmdlet and then creates a team named Team2 in the virtual machine specified by **VMName**. -You must run the following command in the host (parent partition) with administrator permissions. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LoadBalancingAlgorithm -Specifies the load-balancing algorithm the new team uses to distribute network traffic between the interfaces. - -You can specify one of the following four load balancing algorithms: - -**TransportPorts**: Uses the source and destination TCP ports and the IP addresses to create a hash and then assigns the packets that have the matching hash value to one of the available interfaces. - -**IPAddresses**: Uses the source and destination IP addresses to create a hash and then assigns the packets that have the matching hash value to one of the available interfaces. - -**MacAddresses**: Uses the source and destination MAC addresses to create a hash and then assigns the packets that have the matching hash value to one of the available interfaces. - -**HyperVPort**: Distributes network traffic based on the source virtual machine Hyper-V switch port identifier. - -```yaml -Type: LBAlgos -Parameter Sets: (All) -Aliases: lba - -Required: False -Position: 6 -Default value: TransportPorts -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the new NIC team. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamMembers -Specifies the names of the network adapters that are members of the new team. -Specify multiple network adapter names (or wildcard patterns) separated by a comma. - -```yaml -Type: WildcardPattern[] -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamNicName -Specifies the name of the new team interface. -This is the name used to reference the teamed network adapters. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 4 -Default value: Same as team name -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamingMode -Specifies the mode of the NIC teaming. -You can specify one of the following three teaming modes: - -**LACP**: Uses the IEEE 802.1ax Link Aggregation Control Protocol (LACP) to dynamically identify links that are connected between the host and a given switch. -(This protocol was formerly known as IEEE 802.3ad draft) - -**Static**: Requires configuration on both the switch and the host to identify which links form the team. - -**SwitchIndependent**: Specifies that a network switch configuration is not needed for the NIC team. -Because the network switch is not configured to know about the interface teaming, the team interfaces can be connected to different switches. - -```yaml -Type: TeamingModes -Parameter Sets: (All) -Aliases: tm - -Required: False -Position: 5 -Default value: SwitchIndependent -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeam -This cmdlet produces an **MSFT_NetLbfoTeam** object, corresponding to the newly created team. - -## NOTES - -## RELATED LINKS - -[Get-NetLbfoTeam](./Get-NetLbfoTeam.md) - -[Set-NetLbfoTeam](./Set-NetLbfoTeam.md) - -[Rename-NetLbfoTeam](./Rename-NetLbfoTeam.md) - -[Remove-NetLbfoTeam](./Remove-NetLbfoTeam.md) diff --git a/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeam.md b/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeam.md deleted file mode 100644 index 3cb000ce3e..0000000000 --- a/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeam.md +++ /dev/null @@ -1,212 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/remove-netlbfoteam?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-NetLbfoTeam - -## SYNOPSIS -Removes the specified NIC team from the host. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-NetLbfoTeam [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-NetLbfoTeam [-Name] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-NetLbfoTeam** cmdlet removes the specified NIC team from the host. -This cmdlet disconnects all associated team members and providers from the team. -You can specify the team to remove by using either a team object retrieved by Get-NetLbfoTeam, or by specifying a team name. - -You can use **Remove-NetLbfoTeam** to remove all NIC teams from the server. - -You need administrator privileges to use **Remove-NetLbfoTeam**. - -## EXAMPLES - -### Example 1: Remove a team -``` -PS C:\>Remove-NetLbfoTeam -Name Team1 -``` - -This command removes the team named Team1. - -### Example 2: Remove a team using a team object -``` -PS C:\>$team = Get-NetLbfoTeam -Name Team1 - - - -PS C:\>Remove-NetLbfoTeam -InputObject $team -``` - -This set of commands retrieves a team object into a variable $team using Get-NetLbfoTeam, and then passes the variable to **Remove-NetLbfoTeam**. - -### Example 3: Remove all teams from the server -``` -PS C:\>Get-NetLbfoTeam | Remove-NetLbfoTeam -``` - -This command retrieves all the teams from the server using Get-NetLbfoTeam cmdlet and then sends all the retrieved teams to **Remove-NetLbfoTeam** which removes the teams. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the team object which contains the NIC team to remove. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the NIC team to remove. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### None -By default, this cmdlet produces no output. - -## NOTES - -## RELATED LINKS - -[New-NetLbfoTeam](./New-NetLbfoTeam.md) - -[Get-NetLbfoTeam](./Get-NetLbfoTeam.md) - -[Set-NetLbfoTeam](./Set-NetLbfoTeam.md) - -[Rename-NetLbfoTeam](./Rename-NetLbfoTeam.md) - diff --git a/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeamMember.md b/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeamMember.md deleted file mode 100644 index 33ca2aa85e..0000000000 --- a/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeamMember.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/remove-netlbfoteammember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-NetLbfoTeamMember - -## SYNOPSIS -Removes one or more network adapters from a specified NIC team. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-NetLbfoTeamMember [-Name] [-Team] [-AsJob] [-CimSession ] - [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-NetLbfoTeamMember [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-NetLbfoTeamMember** cmdlet removes one or more network adapters from the specified NIC team. -You must specify at least one network adapter to remove from the team. -In order to remove the last team member of a team, you must remove the team by using the Remove-NetLbfoTeam cmdlet. - -You need administrator privileges to use **Remove-NetLbfoTeamMember**. - -## EXAMPLES - -### Example 1: Remove a team member -``` -PS C:\>Remove-NetLbfoTeamMember -Name NIC1 -Team Team1 -``` - -This command removes the team member named NIC1 from the specified team named Team1. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the object which contains the team member to remove. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the team member to remove. -Specify multiple team member names separated by a comma. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Team -Specifies the name of the NIC team from which to remove the member. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### None -By default, this cmdlet produces no output. - -## NOTES - -## RELATED LINKS - -[Add-NetLbfoTeamMember](./Add-NetLbfoTeamMember.md) - -[Get-NetLbfoTeamMember](./Get-NetLbfoTeamMember.md) - -[Set-NetLbfoTeamMember](./Set-NetLbfoTeamMember.md) - - - diff --git a/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeamNic.md b/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeamNic.md deleted file mode 100644 index ce6bc5551d..0000000000 --- a/docset/winserver2012-ps/netlbfo/Remove-NetLbfoTeamNic.md +++ /dev/null @@ -1,208 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/remove-netlbfoteamnic?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-NetLbfoTeamNic - -## SYNOPSIS -Removes a team interface from a NIC team. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-NetLbfoTeamNic [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-NetLbfoTeamNic [-Team] [-VlanID] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-NetLbfoTeamNic** cmdlet removes a team interface from the NIC team. -The name of a team interface is the team name followed by the VLAN value of this team interface. -You can identify a team interface either by its name, its associated VLAN ID, or its default property. - -This cmdlet does not remove the team interface created when the team was created. -To remove the team interface created when the team was created, you must remove the team by using the Remove-NetLbfoTeam cmdlet. - -You need administrator privileges to use **Remove-NetLbfoTeamNic**. - -## EXAMPLES - -### Example 1: Remove a team interface -``` -PS C:\>Remove-NetLbfoTeamNIC -Team "Team1 - VLAN 42" -``` - -This command removes a team interface named Team1 - VLAN 42 from the team "Team1". - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the object which contains the team interface to remove. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Team -Specifies the name of the NIC team from which to remove the team interface. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanID -Specifies the VLAN ID of the team interface to remove. - -```yaml -Type: UInt32[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### None -By default, this cmdlet produces no output. - -## NOTES - -## RELATED LINKS - -[Get-NetLbfoTeamNic](./Get-NetLbfoTeamNic.md) - -[Set-NetLbfoTeamNic](./Set-NetLbfoTeamNic.md) - -[Add-NetLbfoTeamNic](./Add-NetLbfoTeamNic.md) - diff --git a/docset/winserver2012-ps/netlbfo/Rename-NetLbfoTeam.md b/docset/winserver2012-ps/netlbfo/Rename-NetLbfoTeam.md deleted file mode 100644 index d38a5a6adc..0000000000 --- a/docset/winserver2012-ps/netlbfo/Rename-NetLbfoTeam.md +++ /dev/null @@ -1,138 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/rename-netlbfoteam?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Rename-NetLbfoTeam - -## SYNOPSIS -Renames a NIC team. - -## SYNTAX - -``` -Rename-NetLbfoTeam [-Name] [-NewName] [-AsJob] [-CimSession ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Rename-NetLbfoTeam** cmdlet renames the specified NIC team to the specified new name. -Also updates the team interface names accordingly, if they use default values. - -You need administrator privileges to use **Rename-NetLbfoTeam**. - -## EXAMPLES - -### Example 1: Rename a team -``` -PS C:\>Rename -NetLbfoTeam -Name Team1 -NewName TeamA -``` - -This command renames the team named Team1 to TeamA. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the NIC team to rename. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NewName -Specifies the new name of the NIC team. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeam -If the **PassThru** parameter is specified, this cmdlet produces newly renamed team object. -If the **PassThru** parameter is not specified, there is no output. - -## NOTES - -## RELATED LINKS - -[New-NetLbfoTeam](./New-NetLbfoTeam.md) - -[Get-NetLbfoTeam](./Get-NetLbfoTeam.md) - -[Set-NetLbfoTeam](./Set-NetLbfoTeam.md) - -[Remove-NetLbfoTeam](./Remove-NetLbfoTeam.md) - diff --git a/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeam.md b/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeam.md deleted file mode 100644 index af49129acb..0000000000 --- a/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeam.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/set-netlbfoteam?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetLbfoTeam - -## SYNOPSIS -Sets parameters on the specified NIC team. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetLbfoTeam [[-Name] ] [-AsJob] [-CimSession ] [-LoadBalancingAlgorithm ] - [-PassThru] [-TeamingMode ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetLbfoTeam [-AsJob] [-CimSession ] [-LoadBalancingAlgorithm ] - [-MemberOfTheTeam ] [-PassThru] [-TeamingMode ] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetLbfoTeam [-AsJob] [-CimSession ] [-LoadBalancingAlgorithm ] [-PassThru] - [-TeamingMode ] [-ThrottleLimit ] -InputObject -``` - -### UNNAMED_PARAMETER_SET_4 -``` -Set-NetLbfoTeam [-AsJob] [-CimSession ] [-LoadBalancingAlgorithm ] [-PassThru] - [-TeamingMode ] [-TeamNicForTheTeam ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Set-NetLbfoTeam** cmdlet sets the **TeamingMode** or **LoadBalancingAlgorithm** parameters on the specified NIC team. - -You need administrator privileges to use **Set-NetLbfoTeam**. - -## EXAMPLES - -### Example 1: Set the teaming mode -``` -PS C:\>Set-NetLbfoTeam -Name Team1 -TeamingMode LACP -``` - -This command sets the teaming mode of the team named Team1 to LACP. - -### Example 2: Set the load balancing algorithm -``` -PS C:\>Set-NetLbfoTeam -Name Team1 -LoadBalancingAlgorithm HyperVPorts -``` - -This command sets the load balancing algorithm of the team named Team1 to HyperVPorts. - -### Example 3: Set the teaming mode and load balancing algorithm -``` -PS C:\>Set-NetLbfoTeam -Name Team1 -TeamingMode LACP -LoadBalancingAlgorithm HyperVPorts -``` - -This command sets the teaming mode and load balancing algorithm of the team named Team1 at the same time. -The teaming mode is set to LACP and the load balancing algorithm is set to HyperVPorts. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the object which contains the NIC team parameters to set. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -LoadBalancingAlgorithm -Specifies the load balancing algorithm the NIC team uses to distribute network traffic between the interfaces. - -You can specify one of the following four load balancing algorithms: - -**TransportPorts**: Uses the source and destination TCP ports and the IP addresses to create a hash, and then assigns the packets that have the matching hash value to one of the available interfaces. - -**IPAddresses**: Uses the source and destination IP addresses to create a hash, and then assigns the packets that have the matching hash value to one of the available interfaces. - -**MacAddresses**: Uses the source and destination MAC addresses to create a hash and then assigns the packets that have the matching hash value to one of the available interfaces. - -**HyperVPort**: Distributes network traffic based on the source virtual machine Hyper-V switch port identifier. - -```yaml -Type: LBAlgos -Parameter Sets: (All) -Aliases: lba - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MemberOfTheTeam -Specifies the network adapter name for which to modify the parameters. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the NIC team to modify. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TeamNicForTheTeam -Specifies the team interface whose associated NIC team is to be modified. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -TeamingMode -Specifies the mode of the NIC teaming. -You can specify one of the following three teaming modes: - -**LACP**: Requires configuration on both the switch and the host to identify which links form the team. -Uses the Link Aggregation Control Protocol (LACP) to identify links that are connected between the host and a given switch. - -**Static**: Requires configuration on both the switch and the host to identify which links form the team. - -**SwitchIndependent**: Specifies that a network switch configuration is not needed for the NIC team. -Because the network switch is not configured to know about the NIC teaming, the team members can be connected to different switches. - -```yaml -Type: TeamingModes -Parameter Sets: (All) -Aliases: tm - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeam -By default, this cmdlet produces no output. - -If the **PassThru** parameter is specified, the cmdlet returns the updated **MSFT_NetLbfoTeam** object. - -## NOTES - -## RELATED LINKS - -[New-NetLbfoTeam](./New-NetLbfoTeam.md) - -[Get-NetLbfoTeam](./Get-NetLbfoTeam.md) - -[Rename-NetLbfoTeam](./Rename-NetLbfoTeam.md) - -[Remove-NetLbfoTeam](./Remove-NetLbfoTeam.md) - diff --git a/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeamMember.md b/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeamMember.md deleted file mode 100644 index 46aad807ff..0000000000 --- a/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeamMember.md +++ /dev/null @@ -1,221 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/set-netlbfoteammember?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetLbfoTeamMember - -## SYNOPSIS -Sets the role of a member network adapter in a NIC team. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetLbfoTeamMember [[-Name] ] [[-Team] ] [-AdministrativeMode ] [-AsJob] - [-CimSession ] [-PassThru] [-ThrottleLimit ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetLbfoTeamMember [-AdministrativeMode ] [-AsJob] [-CimSession ] [-PassThru] - [-ThrottleLimit ] -InputObject -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetLbfoTeamMember [-AdministrativeMode ] [-AsJob] [-CimSession ] [-PassThru] - [-TeamOfTheMember ] [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Set-NetLbfoTeamMember** cmdlet sets the role of a specified network adapter (team member) in the NIC team. -You can specify the team member either by specifying the name or by specifying the network adapter object retrieved using the Get-NetLbfoTeamMember cmdlet. - -You need administrative privileges to use **Set-NetLbfoTeamMember**. - -## EXAMPLES - -### Example 1: Set the team member role -``` -PS C:\>Set-NetLbfoTeamMember -Name "NIC4" -AdministrativeMode Standby -``` - -This command sets the administrative mode of the specified team member named NIC4 to Standby. - -## PARAMETERS - -### -AdministrativeMode -Specifies the administrative mode of the network adapter to modify. - -You can specify one of the following two administrative modes: - -**Active**: Allows the team member to participate in the NIC team. -By default, the role of the team member is Active. - -**Standby**: Places the member in a standby state where it does not participate in the team. -The team member will be automatically moved to Active state if any other member of the team fails. - -At most one member in a team can be in Standby mode. - -```yaml -Type: AdminModes -Parameter Sets: (All) -Aliases: am - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the object which contains the team member to modify. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the team member to modify. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: ifAlias, InterfaceAlias - -Required: False -Position: 1 -Default value: All members adapters across all teams -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Team -Specifies the name of the NIC team which contains the network adapter to modify. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: All teams on the host -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -TeamOfTheMember -Specifies the NIC team object whose associated member objects are to be modified. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### MSFT_NetLbfoTeamMember -By default, this cmdlet produces no output. - -If the **PassThru** parameter is specified, the cmdlet returns the updated **MSFT_NetLbfoTeamMember** object. - -## NOTES - -## RELATED LINKS - -[Get-NetLbfoTeamMember](./Get-NetLbfoTeamMember.md) - -[Add-NetLbfoTeamMember](./Add-NetLbfoTeamMember.md) - -[Remove-NetLbfoTeamMember](./Remove-NetLbfoTeamMember.md) - diff --git a/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeamNic.md b/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeamNic.md deleted file mode 100644 index c792efabc5..0000000000 --- a/docset/winserver2012-ps/netlbfo/Set-NetLbfoTeamNic.md +++ /dev/null @@ -1,237 +0,0 @@ ---- -external help file: NetLbfo_Cmdlets.xml -Module Name: NetLbfo -online version: https://learn.microsoft.com/powershell/module/netlbfo/set-netlbfoteamnic?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetLbfoTeamNic - -## SYNOPSIS -Sets a new VLAN id on a team interface, or restores the interface to Default mode. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetLbfoTeamNic [[-Name] ] [[-Team] ] [-AsJob] [-CimSession ] [-Default] - [-PassThru] [-ThrottleLimit ] [-VlanID ] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Set-NetLbfoTeamNic [-AsJob] [-CimSession ] [-Default] [-PassThru] - [-TeamOfTheTeamNic ] [-ThrottleLimit ] [-VlanID ] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -Set-NetLbfoTeamNic [-AsJob] [-CimSession ] [-Default] [-PassThru] [-ThrottleLimit ] - [-VlanID ] -InputObject -``` - -## DESCRIPTION -The **Set-NetLbfoTeamNic** cmdlet sets the optional values on a team interface. -Only the team interface that was created when the team was created can be set to Default mode. - -You need administrator privileges to use **Set-NetLbfoTeamNic**. - -## EXAMPLES - -### Example 1: Set the VLAN ID -``` -PS C:\>Set-NetLbfoTeamNIC -Name "Team1 - VlanID 42" -VlanID 15 -``` - -This command modifies the current VLAN ID of the team interface named "Team1 - VLAN 42" to the specified VLAN ID 15. - -### Example 2: Set the VLAN ID of the primary interface to 5, and then revert it to default -``` -PS C:\>Set-NetLbfoTeamNic -Name Team1 -VlanID 5 - - -This command changes the primary team interface, "Team1 - VLAN 5" to default mode. -PS C:\>Set-NetLbfoTeamNic -Name "Team1 - VLAN 5" -Default -``` - -This command sets the VLAN ID of the primary team interface named Team1 to 5. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Indicates that the team interface should be restored to Default mode. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specifies the object which contains the team interface to modify. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the name of the team interface to modify. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: True -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Team -Specifies the name of the NIC team for which to modify the team interface. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: True -``` - -### -TeamOfTheTeamNic -Specifies the network adapter team object whose team interfaces are to be modified. - -```yaml -Type: CimInstance -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VlanID -Specifies the VLAN ID of the team interface to modify. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None -This cmdlet takes no input objects. - -## OUTPUTS - -### None -By default, this cmdlet produces no output. - -If the **PassThru** parameter is specified, the cmdlet returns the newly modified **MSFT_NetLbfoTeamNic** object. - -## NOTES - -## RELATED LINKS - -[Add-NetLbfoTeamNic](./Add-NetLbfoTeamNic.md) - -[Get-NetLbfoTeamNic](./Get-NetLbfoTeamNic.md) - -[Remove-NetLbfoTeamNic](./Remove-NetLbfoTeamNic.md) - diff --git a/docset/winserver2012-ps/netqos/Get-NetQosPolicy.md b/docset/winserver2012-ps/netqos/Get-NetQosPolicy.md deleted file mode 100644 index a0e3ac19ed..0000000000 --- a/docset/winserver2012-ps/netqos/Get-NetQosPolicy.md +++ /dev/null @@ -1,271 +0,0 @@ ---- -external help file: NetQos_Cmdlets.xml -Module Name: NetQoS -online version: https://learn.microsoft.com/powershell/module/netqos/get-netqospolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Get-NetQosPolicy - -## SYNOPSIS -Retrieves network Quality of Service (QoS) policies. - -## SYNTAX - -``` -Get-NetQosPolicy [[-Name] ] [-AsJob] [-CimSession ] [-PolicyStore ] - [-ThrottleLimit ] -``` - -## DESCRIPTION -The **Get-NetQosPolicy** cmdlet allows users to retrieve Quality of Service (QoS) policies from a computer. -QoS policies can originate from many sources, such as from the administrator of a local computer, from a domain controller, or from applications that use the QoS Windows Management Instrumentation (WMI) APIs. -Therefore, the QoS policies are stored in different locations. -If the location as provided by the **PolicyStore** parameter is not specified, then this cmdlet retrieves all the policies stored on the local computer (localhost). - -ActiveStore is a special location. -If ActiveStore is specified as the location, then the user will see all the effective QoS policies, regardless of where the QoS policies are stored. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Get-NetQoSPolicy -Name : Backup -Owner : Group Policy (Machine) -NetworkProfile : Domain -Precedence : 127 -IPProtocol : Both -IPDstPrefix : 10.1.1.176/28 -DSCPValue : 40 - -Name : ntttcp 1 -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -AppPathName : ntttcp.exe -MinBandwidthWeight : 30 - -Name : SMB Policy -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -Template : SMB -PriorityValue : 3 -``` - -This example gets a list of QoS policies stored on the local computer (localhost). - -### EXAMPLE 2 -``` -PS C:\> Get-NetQosPolicy -PolicyStore ActiveStore -Name : smb policy -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -Template : SMB -PriorityValue : 3 - -Name : ntttcp 1 -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -AppPathName : ntttcp.exe -MinBandwidthWeight : 30 - -Name : backup -Owner : Group Policy (Machine) -NetworkProfile : Domain -Precedence : 127 -IPProtocol : Both -DSCPValue : 40 - -Name : ftp -Owner : PowerShell / WMI -NetworkProfile : All -Precedence : 127 -AppPathName : ftp.exe -ThrottleRate : 1 MBytes/sec -``` - -This example gets a list of QoS policies currently effective on the computer. - -### EXAMPLE 3 -``` -PS C:\> Get-NetQosPolicy -Name "SMB policy" | Format-List -Property * -User : -AppPathName : -Template : SMB -NetDirectPort : 0 -IPProtocol : None -IPPort : 0 -IPSrcPrefix : -IPSrcPortStart : 0 -IPSrcPortEnd : 0 -IPDstPrefix : -IPDstPortStart : 0 -IPDstPortEnd : 0 -URI : -URIRecursive : False -PriorityValue : 3 -DSCPValue : -1 -MinBandwidthWeight : 0 -ThrottleRate : 0 -NetworkProfile : All -TemplateMatchCondition : SMB -UserMatchCondition : -AppPathNameMatchCondition : -NetDirectPortMatchCondition : 0 -IPProtocolMatchCondition : None -IPPortMatchCondition : 0 -IPSrcPrefixMatchCondition : -IPSrcPortStartMatchCondition : 0 -IPSrcPortEndMatchCondition : 0 -IPDstPrefixMatchCondition : -IPDstPortStartMatchCondition : 0 -IPDstPortEndMatchCondition : 0 -URIMatchCondition : -URIRecursiveMatchCondition : False -PriorityValue8021Action : 3 -DSCPAction : -1 -MinBandwidthWeightAction : 0 -ThrottleRateAction : 0 -Caption : -Description : -ElementName : -InstanceID : {382ACFAD-1E73-46BD-A0A0-64EE0E587B95}\SMB Policy -Name : SMB Policy -Owner : Group Policy (Machine) -Precedence : 127 -Version : 2.0 -PSComputerName : -ComputerName : CHARLEY-MP1 -ClassName : MSFT_NetQosPolicySettingData -Class : ROOT/StandardCimv2:MSFT_NetQosPolicySettingData -CimClass : ROOT/StandardCimv2:MSFT_NetQosPolicySettingData -Namespace : ROOT/StandardCimv2 -Properties : {Caption, Description, ElementName, InstanceID...} -CimInstanceProperties : {Caption, Description, ElementName, InstanceID...} -CimSystemProperties : Microsoft.Management.Infrastructure.CimSystemProperties -``` - -This example gets all of the properties of a specific QoS policy. -Some parameters on the left side of the output are actually aliases for real parameters. -For example, the `AppName` parameter is an alias for the **AppPathNameMatchCondition** parameter. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -Specifies the QoS policy name. - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the location of the policy that is stored. -The acceptable values for this parameter are: - - - ActiveStore - - - COMPUTERNAME - - - GPO:COMPUTERNAME - - - GPO:DOMAIN\GPONAME - - - LDAP://LDAP-URL - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosPolicySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosPolicySettingData object contains a QoS policy. - -## NOTES - -## RELATED LINKS - -[Format-List](https://go.microsoft.com/fwlink/p/?LinkId=113302) - -[New-NetQosPolicy](./New-NetQosPolicy.md) - -[Remove-NetQosPolicy](./Remove-NetQosPolicy.md) - -[Set-NetQosPolicy](./Set-NetQosPolicy.md) - diff --git a/docset/winserver2012-ps/netqos/NetQoS.md b/docset/winserver2012-ps/netqos/NetQoS.md deleted file mode 100644 index 42d8af0595..0000000000 --- a/docset/winserver2012-ps/netqos/NetQoS.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -Download Help Link: https://aka.ms/winsvr-2012-pshelp -Help Version: 3.0.0.0 -Locale: en-US -Module Guid: 743692b7-a227-4389-b082-2b47de1d0d2d -Module Name: NetQoS ---- - -# NetQoS Module -## Description -This reference provides cmdlet descriptions and syntax for all Network Quality of Service (QoS)-specific cmdlets. It lists the cmdlets in alphabetical order. - -## NetQoS Cmdlets -### [Get-NetQosPolicy](./Get-NetQosPolicy.md) -Retrieves network Quality of Service (QoS) policies. - -### [New-NetQosPolicy](./New-NetQosPolicy.md) -Creates a new network Quality of Service (QoS) policy. - -### [Remove-NetQosPolicy](./Remove-NetQosPolicy.md) -Removes a network Quality of Service (QoS) policy. - -### [Set-NetQosPolicy](./Set-NetQosPolicy.md) -Updates the Quality of Service (QoS) policy settings. - diff --git a/docset/winserver2012-ps/netqos/New-NetQosPolicy.md b/docset/winserver2012-ps/netqos/New-NetQosPolicy.md deleted file mode 100644 index 816db3e83b..0000000000 --- a/docset/winserver2012-ps/netqos/New-NetQosPolicy.md +++ /dev/null @@ -1,808 +0,0 @@ ---- -external help file: NetQos_Cmdlets.xml -Module Name: NetQoS -online version: https://learn.microsoft.com/powershell/module/netqos/new-netqospolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# New-NetQosPolicy - -## SYNOPSIS -Creates a new network Quality of Service (QoS) policy. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -New-NetQosPolicy [-Name] [-AppPathNameMatchCondition ] [-AsJob] [-CimSession ] - [-DSCPAction ] [-IPDstPortEndMatchCondition ] [-IPDstPortMatchCondition ] - [-IPDstPortStartMatchCondition ] [-IPDstPrefixMatchCondition ] - [-IPProtocolMatchCondition ] [-IPSrcPortEndMatchCondition ] - [-IPSrcPortMatchCondition ] [-IPSrcPortStartMatchCondition ] - [-IPSrcPrefixMatchCondition ] [-MinBandwidthWeightAction ] [-NetworkProfile ] - [-PolicyStore ] [-Precedence ] [-PriorityValue8021Action ] [-ThrottleLimit ] - [-ThrottleRateActionBytesPerSecond ] [-UserMatchCondition ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -New-NetQosPolicy [-Name] [-AppPathNameMatchCondition ] [-AsJob] [-CimSession ] - [-DSCPAction ] [-IPProtocolMatchCondition ] [-MinBandwidthWeightAction ] - [-NetworkProfile ] [-PolicyStore ] [-Precedence ] - [-PriorityValue8021Action ] [-ThrottleLimit ] [-ThrottleRateActionBytesPerSecond ] - [-UserMatchCondition ] -IPPortMatchCondition [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_3 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-DSCPAction ] - [-MinBandwidthWeightAction ] [-NetworkProfile ] [-PolicyStore ] - [-Precedence ] [-PriorityValue8021Action ] [-ThrottleLimit ] - [-ThrottleRateActionBytesPerSecond ] [-SMB] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_4 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-DSCPAction ] - [-MinBandwidthWeightAction ] [-NetworkProfile ] [-PolicyStore ] - [-Precedence ] [-PriorityValue8021Action ] [-ThrottleLimit ] - [-ThrottleRateActionBytesPerSecond ] [-Default] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_5 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-NetworkProfile ] - [-PolicyStore ] [-Precedence ] [-ThrottleLimit ] -NetDirectPortMatchCondition - -PriorityValue8021Action [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_6 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-DSCPAction ] - [-IPDstPrefixMatchCondition ] [-NetworkProfile ] [-PolicyStore ] - [-Precedence ] [-ThrottleLimit ] [-ThrottleRateActionBytesPerSecond ] - [-URIRecursiveMatchCondition ] -URIMatchCondition [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_7 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-NetworkProfile ] - [-PolicyStore ] [-Precedence ] [-ThrottleLimit ] [-FCOE] - -PriorityValue8021Action [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_8 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-DSCPAction ] - [-MinBandwidthWeightAction ] [-NetworkProfile ] [-PolicyStore ] - [-Precedence ] [-PriorityValue8021Action ] [-ThrottleLimit ] - [-ThrottleRateActionBytesPerSecond ] [-NFS] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_9 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-DSCPAction ] - [-MinBandwidthWeightAction ] [-NetworkProfile ] [-PolicyStore ] - [-Precedence ] [-PriorityValue8021Action ] [-ThrottleLimit ] - [-ThrottleRateActionBytesPerSecond ] [-LiveMigration] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_10 -``` -New-NetQosPolicy [-Name] [-AsJob] [-CimSession ] [-DSCPAction ] - [-MinBandwidthWeightAction ] [-NetworkProfile ] [-PolicyStore ] - [-Precedence ] [-PriorityValue8021Action ] [-ThrottleLimit ] - [-ThrottleRateActionBytesPerSecond ] [-iSCSI] [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **New-NetQosPolicy** cmdlet creates a new network Quality of Service (QoS) policy. -A QoS policy consists of two main parts: match conditions also known as filters, and actions. -Match conditions such as the name by which an application is run in Windows Server® 2012 and later or a TCP port number decide to what traffic the policy is relating. -Parameters such as **DSCPAction** and **ThrottleRateAction** determine how the policy is to handle the matched traffic. -Besides match conditions and actions, there are also some general parameters such as **NetworkProfile** and **Precedence** that the users can customize for a QoS policy. - -A list of well-known match conditions, or filters, in the form of parameters is provided: **FCoE**, **LiveMigration** (`6600`), **iSCSI** (`3260`), **NFS** (`2049`), and **SMB** (`445`). -Each of them matches a well-known TCP port specified in the brackets. -The only exception is **FCoE**, which matches EtherType `0x8906`. -These filters must be used alone for filtering purpose. -In other words, they cannot be mixed with other match condition parameters. - -QoS policies can be stored in multiple locations. -Users can choose a location by specifying the **PolicyStore** parameter. -If the **PolicyStore** parameter is not specified, then the new policy is added to local computer (localhost). -If a policy is stored in ActiveStore, then the policy will not persist after reboot. - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> New-NetQosPolicy -Name "SMB Policy" -SMB -PriorityValue8021Action 3 -Name : SMB Policy -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -Template : SMB -PriorityValue : 3 -``` - -This example creates a QoS policy named SMB Policy, that classifies SMB traffic and tags it with 802.1p priority value of 3. -The **SMB** parameter is a built-in filter that matches TCP port `445`, which is reserved for SMB. - -### EXAMPLE 2 -``` -PS C:\> New-NetQosPolicy -Name "FTP" -AppPathNameMatchCondition ftp.exe -ThrottleRateActionBytesPerSecond 1MB -PolicyStore ActiveStore -Name : FTP -Owner : PowerShell / WMI -NetworkProfile : All -Precedence : 127 -AppPathName : ftp.exe -ThrottleRate : 1.049 MBits/sec -``` - -This example creates a QoS policy named FTP, that matches an application path at ftp.exe and throttles the traffic at 1,000,000 bytes per second. -This policy is ActiveStore, meaning that it is not persistent after reboot of the computer. - -An alias for the **ThrottleRateActionBytesPerSecond** parameter is `MaxBw`. - -### EXAMPLE 3 -``` -PS C:\> New-NetQosPolicy -Name "Backup" -IPDstPrefixMatchCondition 10.1.1.176/28 -NetworkProfile Domain -DSCPAction 40 -Name : Backup -Owner : Group Policy (Machine) -NetworkProfile : Domain -Precedence : 127 -IPProtocol : Both -IPDstPrefix : 10.1.1.176/28 -DSCPValue : 40 -``` - -This example creates a QoS policy named Backup, that matches traffic sent to 10.1.1.176/28 subnet and tags it with DSCP value of 40. -This policy is effective only on traffic sent on a domain-joined network adapter. - -### EXAMPLE 4 -``` -PS C:\> New-NetQosPolicy -Name "HTTP" -IPPort 80 -IPProtocol TCP -ThrottleRateActionBytesPerSecond 10MB -Name : HTTP -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -IPProtocol : TCP -IPPort : 80 -ThrottleRate : 10.486 MBits/sec -``` - -This example creates a QoS policy that matches TCP traffic sent to port 80 and rate-limits it at 10,000,000 bytes per second. - -### EXAMPLE 5 -``` -PS C:\> New-NetQosPolicy -Name "Wildcard" -Default -MinBandwidthWeightAction 30 -Name : wildcard -Owner : Group Policy (Machine) -NetworkProfile : All -Precedence : 127 -Template : Default -MinBandwidthWeight : 30 -``` - -This example creates a QoS policy named Wildcard, that catches all the traffic that does not match a specific QoS policy and assigns a minimum bandwidth weight of 30 to such traffic. - -### EXAMPLE 6 -``` -PS C:\> New-NetQosPolicy -Name "IIS" -URIMatchCondition "http://training" -ThrottleRateActionBytesPerSecond 500KB -Name : IIS -Owner : Group Policy (Machine) -NetworkProfile : Domain -Precedence : 127 -URI : http://training/ -URIRecursive : False -ThrottleRate : 516.096 KBits/sec -``` - -This example creates a QoS policy named IIS, that matches return traffic from an HTTP server application with the specified URI and rate limit the return traffic at 500,000 bytes per second. - -## PARAMETERS - -### -AppPathNameMatchCondition -Specifies the name by which an application is run, such as `application.exe` or `%ProgramFiles%\application.exeapplication`. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: App, ApplicationName. AppPathName - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Default -Specifies a wildcard filter that can be used to capture all traffic that is not matched by any other filter. -One use case is that a user can create a QoS policy for a specific application using the **AppPathNameMatchCondition** parameter and create another QoS policy for all other applications using this parameter. -Another use case is that a user can create several QoS policies, each of which specifies a minimum bandwidth action for the filtered traffic, and create one additional policy using this parameter to assign a minimum bandwidth action for all other traffic. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_4 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DSCPAction -Specifies the differentiated services code point (DSCP) value. -The acceptable values for this parameter are: 0 through 63. - -```yaml -Type: SByte -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_6, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10 -Aliases: DSCP, DSCPValue - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -FCOE -Specifies the Fibre Channel over Ethernet (FCoE), which uses a dedicated EtherType `0x8914`. -If this parameter is specified, then the Windows Server® 2012 and later will instruct the network adapters in the computer that support FCoE to match the FCoE packets and apply the action specified in the policy. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_7 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPDstPortEndMatchCondition -Specifies the last port in a range of destination ports to be used to match the network traffic. -This parameter must be used in conjunction with the **IPDstPortStartMatchCondition** parameter. -The value of this parameter also must be larger than the value of the **IPDstPortStartMatchCondition** parameter. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: IPDstPortEnd - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPDstPortMatchCondition -Specifies the exact destination port to be used to match the network traffic. -The filter of a QoS policy can be based on either a single port or a range of ports. -To specify a single destination port, use this parameter. -To specify a range of destination ports, use both the **IPDstPortStartMatchCondition** and the **IPDstPortEndMatchCondition** parameters. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: DestinationPort, Destport, Dp, Dstport, IPDstPort - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPDstPortStartMatchCondition -Specifies the first port in a range of destination ports to be used to match the network traffic. -This parameter must be used in conjunction with the **IPDstPortEndMatchCondition** parameter. -The value of this parameter also must be smaller than the value of the **IPDstPortEndMatchCondition** parameter. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: IPDstPortStart - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPDstPrefixMatchCondition -Specifies the destination IP address, optionally with a network prefix, such as `1.2.3.4`, `3ffe:ffff::1`, `192.168.1.0/24`, or `fe80::1234/48`. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_6 -Aliases: Da, DestinationAddress, Dst, Dstaddr, Dsti, IPDstPrefix - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPPortMatchCondition -Specifies the port to be used to match the network traffic, it can be either source port or destination port. -If either the source port or the destination port in a packet matches the value of this parameter, then the QoS policy will apply to the packet. -Usually this is a well-known port that a client uses to communicate with a server. -With this parameter specified, the same QoS policy can be configured on both the clients and the servers and apply to the traffic in both directions. -For example, specifying the IPPortMatchCondition parameter value of `80` matches HTTP traffic sent by both HTTP clients and HTTP servers. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: IPPort, Port - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPProtocolMatchCondition -Specifies the IP protocol to be used to match the network traffic. -The acceptable values for this parameter are: TCP, UDP, or Both. -If this parameter is unspecified, then Both is the default condition. -The QoS policy will apply to both TCP and UDP traffic. - -```yaml -Type: Protocol -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: IPProtocol,Protocol - -Required: False -Position: Named -Default value: Both -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPSrcPortEndMatchCondition -Specifies the last port in a range of source ports to be used to match the network traffic. -This parameter must be used in conjunction with the **IPSrcPortStartMatchCondition** parameter. -The value of this parameter also must be larger than the value of the **IPSrcPortStartMatchCondition** parameter. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: IPSrcPortEnd - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPSrcPortMatchCondition -Specifies the exact source port to be used to match the network traffic. -The filter of a QoS policy can be based on either a single port or a range of ports. -To specify a single source port, use this parameter. -To specify a range of source ports, use both the **IPSrcPortStartMatchCondition** and the **IPSrcPortEndMatchCondition** parameters. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: IPSrcPort, SourcePort, Sp, Srcport - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -IPSrcPortStartMatchCondition -Specifies the first port in a range of source ports to be used to match the network traffic. -This parameter must be used in conjunction with the **IPSrcPortEndMatchCondition** parameter. -the value of this parameter also must be smaller than the value of the **IPSrcPortEndMatchCondition** parameter. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: IPSrcPortStart - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -IPSrcPrefixMatchCondition -Specifies the source IP address, optionally with a network prefix, such as `1.2.3.4`, `3ffe:ffff::1`, `192.168.1.0/24`, or `fe80::1234/48`. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: IPSrcPrefix, Sa, SourceAddress, Src, Srcaddr, Srcip - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -iSCSI -Specifies the internet small computer system interface (iSCSI), which uses the dedicated TCP port `3260`. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_10 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LiveMigration -Specifies the Microsoft live migration, which uses the well-known TCP port `6600`. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_9 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinBandwidthWeightAction -Specifies a numerical value for minimum bandwidth that a flow should get relatively. -The actual bandwidth a flow gets will depend on the weights assigned to other flows in the computer. -The acceptable values for this parameter are: 1 through 100. - -```yaml -Type: Byte -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10 -Aliases: MinBandwidthWeight, Minbww, Weight - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Name -Specifies the QoS policy name. -This name must be unique for a QoS policy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetDirectPortMatchCondition -Specifies the network direct port to be used to match the network traffic. -Network Direct uses an independent port space from the TCP or UDP port space. -Windows Server 2012 and later will send a Network Direct policy to a network adapter only if the network adapter supports Network Direct. - -```yaml -Type: UInt16 -Parameter Sets: UNNAMED_PARAMETER_SET_5 -Aliases: Ndport, NetDirectPort, NetworkDirectPort - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NetworkProfile -Specifies the profile, or connection type, of a network, such as Domain. -The acceptable values for this parameter are: Domain, Public, Private, or All. -If this parameter is not specified, then the QoS policy will be effective when a computer is connected on any type of connection. - -```yaml -Type: NetworkProfile -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: All -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -NFS -Specifies the network file system, which uses the dedicated TCP port `2049`. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_8 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the location of the policy that is stored. -The acceptable values for this parameter are: - - - ActiveStore - - - COMPUTERNAME - - - GPO:COMPUTERNAME - - - GPO:DOMAIN\GPONAME - - - LDAP://LDAP-URL - -If a policy is stored in ActiveStore, then the policy will not persist after reboot. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Precedence -Specifies the priority of a QoS policy. -A higher priority policy will trump a lower priority policy in case the policies are conflicting. -The acceptable values for this parameter are: 0 through 255. -255 represents the highest priority and 0 represents the lowest. -If not specified, then the default value is 127. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: 127 -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PriorityValue8021Action -Specifies the IEEE 802.1p value. -The acceptable values for this parameter are: 0 through 7. - -```yaml -Type: SByte -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10 -Aliases: Dot1p, Pri, PriorityValue, PriorityValue8021 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -```yaml -Type: SByte -Parameter Sets: UNNAMED_PARAMETER_SET_5, UNNAMED_PARAMETER_SET_7 -Aliases: Dot1p, Pri, PriorityValue, PriorityValue8021 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -SMB -Specifies the server message block, which uses the dedicated TCP port `445`. - -```yaml -Type: SwitchParameter -Parameter Sets: UNNAMED_PARAMETER_SET_3 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleRateActionBytesPerSecond -Specifies a throttle rate in bytes per second, also known as maximum bandwidth. - -```yaml -Type: UInt64 -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2, UNNAMED_PARAMETER_SET_3, UNNAMED_PARAMETER_SET_4, UNNAMED_PARAMETER_SET_6, UNNAMED_PARAMETER_SET_8, UNNAMED_PARAMETER_SET_9, UNNAMED_PARAMETER_SET_10 -Aliases: MaxBw, Throttle, ThrottleRate, ThrottleRateAction - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -URIMatchCondition -Specifies the URI to match. -Only a HTTP URL is currently supported, such as `http://myhost`, `https://*/training`, `http://myhost:8080/training`, or `https://myhost:*/training`. -The QoS policy will only apply to the traffic sent from HTTP server applications to HTTP clients in response to the requests from the client for the specified URI. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: Uri,Url - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -URIRecursiveMatchCondition -Specifies that all subdirectories and files following the URI specified in the **URIMatchCondition** parameter are to be included. -This parameter can be specified only if the **URIMatchCondition** parameter is specified. - -```yaml -Type: Boolean -Parameter Sets: UNNAMED_PARAMETER_SET_6 -Aliases: Recursive, URIRecursive, Urlrecursive - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -UserMatchCondition -Specifies the user or group name in Active Directory, such as `contoso\User1`. -This parameter is usually specified with another filtering parameter such as the **AppPathNameMatchCondition** cmdlet. - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1, UNNAMED_PARAMETER_SET_2 -Aliases: Sid, User - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### None - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosPolicySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosPolicySettingData object contains a QoS policy. - -## NOTES - -## RELATED LINKS - -[Get-NetQosPolicy](./Get-NetQosPolicy.md) - -[Remove-NetQosPolicy](./Remove-NetQosPolicy.md) - -[Set-NetQosPolicy](./Set-NetQosPolicy.md) - diff --git a/docset/winserver2012-ps/netqos/Remove-NetQosPolicy.md b/docset/winserver2012-ps/netqos/Remove-NetQosPolicy.md deleted file mode 100644 index b53dc51ba4..0000000000 --- a/docset/winserver2012-ps/netqos/Remove-NetQosPolicy.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -external help file: NetQos_Cmdlets.xml -Module Name: NetQoS -online version: https://learn.microsoft.com/powershell/module/netqos/remove-netqospolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Remove-NetQosPolicy - -## SYNOPSIS -Removes a network Quality of Service (QoS) policy. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Remove-NetQosPolicy [[-Name] ] [-AsJob] [-CimSession ] [-PassThru] - [-PolicyStore ] [-ThrottleLimit ] [-Confirm] [-WhatIf] -``` - -### UNNAMED_PARAMETER_SET_2 -``` -Remove-NetQosPolicy [-AsJob] [-CimSession ] [-PassThru] [-ThrottleLimit ] - -InputObject [-Confirm] [-WhatIf] -``` - -## DESCRIPTION -The **Remove-NetQosPolicy** cmdlet removes the network Quality of Service (QoS) policies. -All the policies, in a policy store, are removed unless a specific policy is named. -If the **PolicyStore** parameter is not specified, then this cmdlet will remove policies from local computer (localhost). - -## EXAMPLES - -### EXAMPLE 1 -``` -PS C:\> Remove-NetQosPolicy -Name "Backup" -``` - -This example removes a policy named as Backup. - -## PARAMETERS - -### -AsJob -ps_cimcommon_asjob - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CimSession -Runs the cmdlet in a remote session or on a remote computer. -Enter a computer name or a session object, such as the output of a New-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. -The default is the current session on the local computer. - -```yaml -Type: CimSession[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InputObject -Specified the object which will be modified by this cmdlet. -The object must be piped to the cmdlet. - -```yaml -Type: CimInstance[] -Parameter Sets: UNNAMED_PARAMETER_SET_2 -Aliases: - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Name -Specifies the QoS policy name. - -```yaml -Type: String[] -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: - -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -PassThru -Returns an object representing the item with which you are working. -By default, this cmdlet does not generate any output. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PolicyStore -Specifies the location of the policy that is stored. -The acceptable values for this parameter are: - - - ActiveStore - - - COMPUTERNAME - - - GPO:COMPUTERNAME - - - GPO:DOMAIN\GPONAME - - - LDAP://LDAP-URL - -```yaml -Type: String -Parameter Sets: UNNAMED_PARAMETER_SET_1 -Aliases: store - -Required: False -Position: Named -Default value: Localhost -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ThrottleLimit -Specifies the maximum number of concurrent operations that can be established to run the cmdlet. -If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. -The throttle limit applies only to the current cmdlet, not to the session or to the computer. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - -## INPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosPolicySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosPolicySettingData object contains a QoS policy. - -## OUTPUTS - -### Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetQosPolicySettingData -The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. -The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object. - -The MSFT_NetQosPolicySettingData object contains a QoS policy. -Only when the **PassThru** parameter is specified will this cmdlet return the MSFT_NetQosPolicySettingData object. - -## NOTES - -## RELATED LINKS - -[Get-NetQosPolicy](./Get-NetQosPolicy.md) - -[New-NetQosPolicy](./New-NetQosPolicy.md) - -[Set-NetQosPolicy](./Set-NetQosPolicy.md) - diff --git a/docset/winserver2012-ps/netqos/Set-NetQosPolicy.md b/docset/winserver2012-ps/netqos/Set-NetQosPolicy.md deleted file mode 100644 index 7afbfb06d7..0000000000 --- a/docset/winserver2012-ps/netqos/Set-NetQosPolicy.md +++ /dev/null @@ -1,642 +0,0 @@ ---- -external help file: NetQos_Cmdlets.xml -Module Name: NetQoS -online version: https://learn.microsoft.com/powershell/module/netqos/set-netqospolicy?view=windowsserver2012-ps&wt.mc_id=ps-gethelp -schema: 2.0.0 ---- - -# Set-NetQosPolicy - -## SYNOPSIS -Updates the Quality of Service (QoS) policy settings. - -## SYNTAX - -### UNNAMED_PARAMETER_SET_1 -``` -Set-NetQosPolicy [[-Name] ] [-AppPathNameMatchCondition ] [-AsJob] - [-CimSession ] [-DSCPAction ] [-IPDstPortEndMatchCondition ] - [-IPDstPortMatchCondition ] [-IPDstPortStartMatchCondition ] - [-IPDstPrefixMatchCondition ] [-IPPortMatchCondition ] [-IPProtocolMatchCondition ] - [-IPSrcPortEndMatchCondition ] [-IPSrcPortMatchCondition ] - [-IPSrcPortStartMatchCondition ] [-IPSrcPrefixMatchCondition ] - [-MinBandwidthWeightAction ] [-NetDirectPortMatchCondition ] [-NetworkProfile ] - [-PassThru] [-PolicyStore ] [-Precedence ] [-PriorityValue8021Action ] - [-TemplateMatchCondition